id
stringlengths 14
16
| conversations
listlengths 3
3
| schema
stringlengths 68
3.98M
| task
stringlengths 134
732
| category
stringlengths 2
130
| source
stringclasses 1
value |
|---|---|---|---|---|---|
schema_store_1
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://files.configu.com/schema/.cfgu.json\",\"$comment\":\"https://jsonschema.dev/s/sZY8z\",\"title\":\"JSON Schema for Configu .cfgu files\",\"description\":\"https://docs.configu.com/interfaces/.cfgu\",\"type\":\"object\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"$schema\":{\"type\":\"string\",\"minLength\":1,\"description\":\"Url to JSON Schema\"},\"keys\":{\"type\":\"object\",\"required\":[],\"minProperties\":1,\"additionalProperties\":{\"type\":[\"object\",\"null\"],\"required\":[],\"additionalProperties\":false,\"nullable\":true,\"properties\":{\"description\":{\"type\":\"string\",\"minLength\":1},\"label\":{\"type\":[\"string\",\"array\"],\"oneOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"minLength\":1}}]},\"hidden\":{\"type\":\"boolean\"},\"lazy\":{\"type\":\"boolean\"},\"const\":{\"type\":\"string\",\"minLength\":1},\"default\":{\"type\":[\"string\",\"number\",\"boolean\",\"object\",\"array\"],\"oneOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"type\":\"object\"},{\"type\":\"array\"}]},\"required\":{\"type\":\"boolean\"},\"pattern\":{\"type\":\"string\",\"minLength\":1},\"enum\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":[\"string\",\"number\",\"boolean\",\"object\",\"array\"],\"oneOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"type\":\"object\"},{\"type\":\"array\"}]}},\"schema\":{\"type\":\"object\",\"minProperties\":1},\"test\":{\"type\":[\"string\",\"array\"],\"oneOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"minLength\":1}}]}},\"allOf\":[{\"if\":{\"required\":[\"lazy\"]},\"then\":{\"properties\":{\"const\":false,\"default\":false}}},{\"if\":{\"required\":[\"const\"]},\"then\":{\"properties\":{\"lazy\":false,\"default\":false}}},{\"if\":{\"required\":[\"default\"]},\"then\":{\"properties\":{\"lazy\":false,\"const\":false,\"required\":false}}},{\"if\":{\"required\":[\"required\"]},\"then\":{\"properties\":{\"const\":false,\"default\":false}}}]}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Configu .cfgu files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://files.configu.com/schema/.cfgu.json","$comment":"https://jsonschema.dev/s/sZY8z","title":"JSON Schema for Configu .cfgu files","description":"https://docs.configu.com/interfaces/.cfgu","type":"object","required":[],"additionalProperties":false,"properties":{"$schema":{"type":"string","minLength":1,"description":"Url to JSON Schema"},"keys":{"type":"object","required":[],"minProperties":1,"additionalProperties":{"type":["object","null"],"required":[],"additionalProperties":false,"nullable":true,"properties":{"description":{"type":"string","minLength":1},"label":{"type":["string","array"],"oneOf":[{"type":"string","minLength":1},{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","minLength":1}}]},"hidden":{"type":"boolean"},"lazy":{"type":"boolean"},"const":{"type":"string","minLength":1},"default":{"type":["string","number","boolean","object","array"],"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array"}]},"required":{"type":"boolean"},"pattern":{"type":"string","minLength":1},"enum":{"type":"array","uniqueItems":true,"items":{"type":["string","number","boolean","object","array"],"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array"}]}},"schema":{"type":"object","minProperties":1},"test":{"type":["string","array"],"oneOf":[{"type":"string","minLength":1},{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","minLength":1}}]}},"allOf":[{"if":{"required":["lazy"]},"then":{"properties":{"const":false,"default":false}}},{"if":{"required":["const"]},"then":{"properties":{"lazy":false,"default":false}}},{"if":{"required":["default"]},"then":{"properties":{"lazy":false,"const":false,"required":false}}},{"if":{"required":["required"]},"then":{"properties":{"const":false,"default":false}}}]}}}}
|
Provide a JSON object that satisfies the schema "JSON Schema for Configu .cfgu files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Configu .cfgu files
|
schema-store
|
schema_store_2
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://files.configu.com/schema/.configu.json\",\"$comment\":\"https://jsonschema.dev/s/3pOmT\",\"title\":\"JSON Schema for Configu .configu file\",\"description\":\"https://docs.configu.com/interfaces/.configu\",\"type\":\"object\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"$schema\":{\"type\":\"string\",\"minLength\":1,\"description\":\"Url to JSON Schema\"},\"interface\":{\"description\":\"Global configuration for a Configu interface.\",\"type\":\"object\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"debug\":{\"description\":\"Enables or disables debug mode.\",\"type\":\"boolean\"},\"proxy\":{\"description\":\"Configuration for the Configu proxy server.\",\"type\":\"object\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"host\":{\"description\":\"The host address of the proxy server.\",\"type\":\"string\"},\"domain\":{\"description\":\"The domain of the proxy server.\",\"type\":\"string\"},\"tls\":{\"type\":\"object\",\"required\":[\"enabled\",\"cert\",\"key\"],\"additionalProperties\":false,\"properties\":{\"enabled\":{\"description\":\"Enables or disables transport layer security (TLS).\",\"type\":\"boolean\",\"default\":false},\"cert\":{\"description\":\"The (absolute) file path of the certificate to use for the TLS connection.\",\"type\":\"string\"},\"key\":{\"description\":\"The (absolute) file path of the TLS key that should be used for the TLS connection.\",\"type\":\"string\"}}},\"auth\":{\"type\":\"object\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"bearer\":{\"description\":\"Enables or disables preshared key authentication.\",\"type\":\"object\",\"required\":[\"keys\"],\"additionalProperties\":false,\"properties\":{\"keys\":{\"description\":\"List of preshared keys that are allowed to access the server.\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1}}}}},\"http\":{\"type\":\"object\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"enabled\":{\"description\":\"Enables or disables the HTTP server.\",\"type\":\"boolean\"},\"port\":{\"description\":\"The host port to serve the HTTP server on.\",\"type\":\"number\"}}}}}}},\"stores\":{\"type\":\"object\",\"required\":[],\"additionalProperties\":{\"type\":\"object\",\"required\":[\"type\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\"},\"version\":{\"type\":\"string\"},\"configuration\":{\"type\":\"object\"},\"backup\":{\"type\":\"boolean\"},\"default\":{\"type\":\"boolean\"}}}},\"backup\":{\"type\":\"string\",\"minLength\":1},\"schemas\":{\"type\":\"object\",\"required\":[],\"additionalProperties\":{\"type\":\"string\"}},\"register\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"minLength\":1}},\"scripts\":{\"type\":\"object\",\"required\":[],\"additionalProperties\":{\"type\":\"string\"}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Configu .configu file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://files.configu.com/schema/.configu.json","$comment":"https://jsonschema.dev/s/3pOmT","title":"JSON Schema for Configu .configu file","description":"https://docs.configu.com/interfaces/.configu","type":"object","required":[],"additionalProperties":false,"properties":{"$schema":{"type":"string","minLength":1,"description":"Url to JSON Schema"},"interface":{"description":"Global configuration for a Configu interface.","type":"object","required":[],"additionalProperties":false,"properties":{"debug":{"description":"Enables or disables debug mode.","type":"boolean"},"proxy":{"description":"Configuration for the Configu proxy server.","type":"object","required":[],"additionalProperties":false,"properties":{"host":{"description":"The host address of the proxy server.","type":"string"},"domain":{"description":"The domain of the proxy server.","type":"string"},"tls":{"type":"object","required":["enabled","cert","key"],"additionalProperties":false,"properties":{"enabled":{"description":"Enables or disables transport layer security (TLS).","type":"boolean","default":false},"cert":{"description":"The (absolute) file path of the certificate to use for the TLS connection.","type":"string"},"key":{"description":"The (absolute) file path of the TLS key that should be used for the TLS connection.","type":"string"}}},"auth":{"type":"object","required":[],"additionalProperties":false,"properties":{"bearer":{"description":"Enables or disables preshared key authentication.","type":"object","required":["keys"],"additionalProperties":false,"properties":{"keys":{"description":"List of preshared keys that are allowed to access the server.","type":"array","items":{"type":"string"},"minItems":1}}}}},"http":{"type":"object","required":[],"additionalProperties":false,"properties":{"enabled":{"description":"Enables or disables the HTTP server.","type":"boolean"},"port":{"description":"The host port to serve the HTTP server on.","type":"number"}}}}}}},"stores":{"type":"object","required":[],"additionalProperties":{"type":"object","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string"},"version":{"type":"string"},"configuration":{"type":"object"},"backup":{"type":"boolean"},"default":{"type":"boolean"}}}},"backup":{"type":"string","minLength":1},"schemas":{"type":"object","required":[],"additionalProperties":{"type":"string"}},"register":{"type":"array","uniqueItems":true,"items":{"type":"string","minLength":1}},"scripts":{"type":"object","required":[],"additionalProperties":{"type":"string"}}}}
|
Provide a JSON object that satisfies the schema "JSON Schema for Configu .configu file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Configu .configu file
|
schema-store
|
schema_store_3
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://meta.json-schema.tools/\",\"$id\":\"https://meta.open-rpc.org/\",\"title\":\"openrpcDocument\",\"type\":\"object\",\"required\":[\"info\",\"methods\",\"openrpc\"],\"additionalProperties\":false,\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}},\"properties\":{\"openrpc\":{\"title\":\"openrpc\",\"type\":\"string\",\"enum\":[\"1.3.2\",\"1.3.1\",\"1.3.0\",\"1.2.6\",\"1.2.5\",\"1.2.4\",\"1.2.3\",\"1.2.2\",\"1.2.1\",\"1.2.0\",\"1.1.12\",\"1.1.11\",\"1.1.10\",\"1.1.9\",\"1.1.8\",\"1.1.7\",\"1.1.6\",\"1.1.5\",\"1.1.4\",\"1.1.3\",\"1.1.2\",\"1.1.1\",\"1.1.0\",\"1.0.0\",\"1.0.0-rc1\",\"1.0.0-rc0\"]},\"info\":{\"$ref\":\"#/definitions/infoObject\"},\"externalDocs\":{\"$ref\":\"#/definitions/externalDocumentationObject\"},\"servers\":{\"title\":\"servers\",\"type\":\"array\",\"additionalItems\":false,\"items\":{\"$ref\":\"#/definitions/serverObject\"}},\"methods\":{\"title\":\"methods\",\"type\":\"array\",\"additionalItems\":false,\"items\":{\"title\":\"methodOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/methodObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"components\":{\"title\":\"components\",\"type\":\"object\",\"properties\":{\"schemas\":{\"title\":\"schemaComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/JSONSchema\"}}},\"links\":{\"title\":\"linkComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/linkObject\"}}},\"errors\":{\"title\":\"errorComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/errorObject\"}}},\"examples\":{\"title\":\"exampleComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/exampleObject\"}}},\"examplePairings\":{\"title\":\"examplePairingComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/examplePairingObject\"}}},\"contentDescriptors\":{\"title\":\"contentDescriptorComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/contentDescriptorObject\"}}},\"tags\":{\"title\":\"tagComponents\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"$ref\":\"#/definitions/tagObject\"}}}}},\"$schema\":{\"title\":\"metaSchema\",\"description\":\"JSON Schema URI (used by some editors)\",\"type\":\"string\",\"default\":\"https://meta.open-rpc.org/\"}},\"definitions\":{\"specificationExtension\":{\"title\":\"specificationExtension\"},\"JSONSchema\":{\"$ref\":\"https://meta.json-schema.tools\"},\"referenceObject\":{\"title\":\"referenceObject\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"$ref\"],\"properties\":{\"$ref\":{\"$ref\":\"https://meta.json-schema.tools/#/definitions/JSONSchemaObject/properties/$ref\"}}},\"errorObject\":{\"title\":\"errorObject\",\"type\":\"object\",\"description\":\"Defines an application level error.\",\"additionalProperties\":false,\"required\":[\"code\",\"message\"],\"properties\":{\"code\":{\"title\":\"errorObjectCode\",\"description\":\"A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.\",\"type\":\"integer\"},\"message\":{\"title\":\"errorObjectMessage\",\"description\":\"A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.\",\"type\":\"string\"},\"data\":{\"title\":\"errorObjectData\",\"description\":\"A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).\"}}},\"licenseObject\":{\"title\":\"licenseObject\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"licenseObjectName\",\"type\":\"string\"},\"url\":{\"title\":\"licenseObjectUrl\",\"type\":\"string\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"contactObject\":{\"title\":\"contactObject\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"contactObjectName\",\"type\":\"string\"},\"email\":{\"title\":\"contactObjectEmail\",\"type\":\"string\"},\"url\":{\"title\":\"contactObjectUrl\",\"type\":\"string\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"infoObject\":{\"title\":\"infoObject\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"title\",\"version\"],\"properties\":{\"title\":{\"title\":\"infoObjectProperties\",\"type\":\"string\"},\"description\":{\"title\":\"infoObjectDescription\",\"type\":\"string\"},\"termsOfService\":{\"title\":\"infoObjectTermsOfService\",\"type\":\"string\",\"format\":\"uri\"},\"version\":{\"title\":\"infoObjectVersion\",\"type\":\"string\"},\"contact\":{\"$ref\":\"#/definitions/contactObject\"},\"license\":{\"$ref\":\"#/definitions/licenseObject\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"serverObject\":{\"title\":\"serverObject\",\"type\":\"object\",\"required\":[\"url\"],\"additionalProperties\":false,\"properties\":{\"url\":{\"title\":\"serverObjectUrl\",\"type\":\"string\",\"format\":\"uri\"},\"name\":{\"title\":\"serverObjectName\",\"type\":\"string\"},\"description\":{\"title\":\"serverObjectDescription\",\"type\":\"string\"},\"summary\":{\"title\":\"serverObjectSummary\",\"type\":\"string\"},\"variables\":{\"title\":\"serverObjectVariables\",\"type\":\"object\",\"patternProperties\":{\"[0-z]+\":{\"title\":\"serverObjectVariable\",\"type\":\"object\",\"required\":[\"default\"],\"properties\":{\"default\":{\"title\":\"serverObjectVariableDefault\",\"type\":\"string\"},\"description\":{\"title\":\"serverObjectVariableDescription\",\"type\":\"string\"},\"enum\":{\"title\":\"serverObjectVariableEnum\",\"type\":\"array\",\"items\":{\"title\":\"serverObjectVariableEnumItem\",\"type\":\"string\"}}}}}}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"linkObject\":{\"title\":\"linkObject\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"linkObjectName\",\"type\":\"string\",\"minLength\":1},\"summary\":{\"title\":\"linkObjectSummary\",\"type\":\"string\"},\"method\":{\"title\":\"linkObjectMethod\",\"type\":\"string\"},\"description\":{\"title\":\"linkObjectDescription\",\"type\":\"string\"},\"params\":{\"title\":\"linkObjectParams\"},\"server\":{\"title\":\"linkObjectServer\",\"$ref\":\"#/definitions/serverObject\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"externalDocumentationObject\":{\"title\":\"externalDocumentationObject\",\"type\":\"object\",\"additionalProperties\":false,\"description\":\"information about external documentation\",\"required\":[\"url\"],\"properties\":{\"description\":{\"title\":\"externalDocumentationObjectDescription\",\"type\":\"string\"},\"url\":{\"title\":\"externalDocumentationObjectUrl\",\"type\":\"string\",\"format\":\"uri\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"methodObject\":{\"title\":\"methodObject\",\"type\":\"object\",\"required\":[\"name\",\"params\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"methodObjectName\",\"description\":\"The cannonical name for the method. The name MUST be unique within the methods array.\",\"type\":\"string\",\"minLength\":1},\"description\":{\"title\":\"methodObjectDescription\",\"description\":\"A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.\",\"type\":\"string\"},\"summary\":{\"title\":\"methodObjectSummary\",\"description\":\"A short summary of what the method does.\",\"type\":\"string\"},\"servers\":{\"title\":\"servers\",\"type\":\"array\",\"additionalItems\":false,\"items\":{\"$ref\":\"#/definitions/serverObject\"}},\"tags\":{\"title\":\"methodObjectTags\",\"type\":\"array\",\"items\":{\"title\":\"tagOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/tagObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"paramStructure\":{\"title\":\"methodObjectParamStructure\",\"type\":\"string\",\"description\":\"Format the server expects the params. Defaults to 'either'.\",\"enum\":[\"by-position\",\"by-name\",\"either\"],\"default\":\"either\"},\"params\":{\"title\":\"methodObjectParams\",\"type\":\"array\",\"items\":{\"title\":\"contentDescriptorOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/contentDescriptorObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"result\":{\"title\":\"methodObjectResult\",\"oneOf\":[{\"$ref\":\"#/definitions/contentDescriptorObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]},\"errors\":{\"title\":\"methodObjectErrors\",\"description\":\"Defines an application level error.\",\"type\":\"array\",\"items\":{\"title\":\"errorOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/errorObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"links\":{\"title\":\"methodObjectLinks\",\"type\":\"array\",\"items\":{\"title\":\"linkOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/linkObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"examples\":{\"title\":\"methodObjectExamples\",\"type\":\"array\",\"items\":{\"title\":\"examplePairingOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/examplePairingObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"deprecated\":{\"title\":\"methodObjectDeprecated\",\"type\":\"boolean\",\"default\":false},\"externalDocs\":{\"$ref\":\"#/definitions/externalDocumentationObject\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"tagObject\":{\"title\":\"tagObject\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"name\"],\"properties\":{\"name\":{\"title\":\"tagObjectName\",\"type\":\"string\",\"minLength\":1},\"description\":{\"title\":\"tagObjectDescription\",\"type\":\"string\"},\"externalDocs\":{\"$ref\":\"#/definitions/externalDocumentationObject\"}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"exampleObject\":{\"title\":\"exampleObject\",\"type\":\"object\",\"required\":[\"name\",\"value\"],\"properties\":{\"summary\":{\"title\":\"exampleObjectSummary\",\"type\":\"string\"},\"value\":{\"title\":\"exampleObjectValue\"},\"description\":{\"title\":\"exampleObjectDescription\",\"type\":\"string\"},\"name\":{\"title\":\"exampleObjectName\",\"type\":\"string\",\"minLength\":1}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}},\"examplePairingObject\":{\"title\":\"examplePairingObject\",\"type\":\"object\",\"required\":[\"name\",\"params\"],\"properties\":{\"name\":{\"title\":\"examplePairingObjectName\",\"type\":\"string\",\"minLength\":1},\"description\":{\"title\":\"examplePairingObjectDescription\",\"type\":\"string\"},\"params\":{\"title\":\"examplePairingObjectParams\",\"type\":\"array\",\"items\":{\"title\":\"exampleOrReference\",\"oneOf\":[{\"$ref\":\"#/definitions/exampleObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}},\"result\":{\"title\":\"examplePairingObjectResult\",\"oneOf\":[{\"$ref\":\"#/definitions/exampleObject\"},{\"$ref\":\"#/definitions/referenceObject\"}]}}},\"contentDescriptorObject\":{\"title\":\"contentDescriptorObject\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"name\",\"schema\"],\"properties\":{\"name\":{\"title\":\"contentDescriptorObjectName\",\"type\":\"string\",\"minLength\":1},\"description\":{\"title\":\"contentDescriptorObjectDescription\",\"type\":\"string\"},\"summary\":{\"title\":\"contentDescriptorObjectSummary\",\"type\":\"string\"},\"schema\":{\"$ref\":\"#/definitions/JSONSchema\"},\"required\":{\"title\":\"contentDescriptorObjectRequired\",\"type\":\"boolean\",\"default\":false},\"deprecated\":{\"title\":\"contentDescriptorObjectDeprecated\",\"type\":\"boolean\",\"default\":false}},\"patternProperties\":{\"^x-\":{\"$ref\":\"#/definitions/specificationExtension\"}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"openrpcDocument\". Here are the required top‑level fields: info, methods, openrpc. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://meta.json-schema.tools/","$id":"https://meta.open-rpc.org/","title":"openrpcDocument","type":"object","required":["info","methods","openrpc"],"additionalProperties":false,"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}},"properties":{"openrpc":{"title":"openrpc","type":"string","enum":["1.3.2","1.3.1","1.3.0","1.2.6","1.2.5","1.2.4","1.2.3","1.2.2","1.2.1","1.2.0","1.1.12","1.1.11","1.1.10","1.1.9","1.1.8","1.1.7","1.1.6","1.1.5","1.1.4","1.1.3","1.1.2","1.1.1","1.1.0","1.0.0","1.0.0-rc1","1.0.0-rc0"]},"info":{"$ref":"#/definitions/infoObject"},"externalDocs":{"$ref":"#/definitions/externalDocumentationObject"},"servers":{"title":"servers","type":"array","additionalItems":false,"items":{"$ref":"#/definitions/serverObject"}},"methods":{"title":"methods","type":"array","additionalItems":false,"items":{"title":"methodOrReference","oneOf":[{"$ref":"#/definitions/methodObject"},{"$ref":"#/definitions/referenceObject"}]}},"components":{"title":"components","type":"object","properties":{"schemas":{"title":"schemaComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/JSONSchema"}}},"links":{"title":"linkComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/linkObject"}}},"errors":{"title":"errorComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/errorObject"}}},"examples":{"title":"exampleComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/exampleObject"}}},"examplePairings":{"title":"examplePairingComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/examplePairingObject"}}},"contentDescriptors":{"title":"contentDescriptorComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/contentDescriptorObject"}}},"tags":{"title":"tagComponents","type":"object","patternProperties":{"[0-z]+":{"$ref":"#/definitions/tagObject"}}}}},"$schema":{"title":"metaSchema","description":"JSON Schema URI (used by some editors)","type":"string","default":"https://meta.open-rpc.org/"}},"definitions":{"specificationExtension":{"title":"specificationExtension"},"JSONSchema":{"$ref":"https://meta.json-schema.tools"},"referenceObject":{"title":"referenceObject","type":"object","additionalProperties":false,"required":["$ref"],"properties":{"$ref":{"$ref":"https://meta.json-schema.tools/#/definitions/JSONSchemaObject/properties/$ref"}}},"errorObject":{"title":"errorObject","type":"object","description":"Defines an application level error.","additionalProperties":false,"required":["code","message"],"properties":{"code":{"title":"errorObjectCode","description":"A Number that indicates the error type that occurred. This MUST be an integer. The error codes from and including -32768 to -32000 are reserved for pre-defined errors. These pre-defined errors SHOULD be assumed to be returned from any JSON-RPC api.","type":"integer"},"message":{"title":"errorObjectMessage","description":"A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.","type":"string"},"data":{"title":"errorObjectData","description":"A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.)."}}},"licenseObject":{"title":"licenseObject","type":"object","additionalProperties":false,"properties":{"name":{"title":"licenseObjectName","type":"string"},"url":{"title":"licenseObjectUrl","type":"string"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"contactObject":{"title":"contactObject","type":"object","additionalProperties":false,"properties":{"name":{"title":"contactObjectName","type":"string"},"email":{"title":"contactObjectEmail","type":"string"},"url":{"title":"contactObjectUrl","type":"string"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"infoObject":{"title":"infoObject","type":"object","additionalProperties":false,"required":["title","version"],"properties":{"title":{"title":"infoObjectProperties","type":"string"},"description":{"title":"infoObjectDescription","type":"string"},"termsOfService":{"title":"infoObjectTermsOfService","type":"string","format":"uri"},"version":{"title":"infoObjectVersion","type":"string"},"contact":{"$ref":"#/definitions/contactObject"},"license":{"$ref":"#/definitions/licenseObject"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"serverObject":{"title":"serverObject","type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"title":"serverObjectUrl","type":"string","format":"uri"},"name":{"title":"serverObjectName","type":"string"},"description":{"title":"serverObjectDescription","type":"string"},"summary":{"title":"serverObjectSummary","type":"string"},"variables":{"title":"serverObjectVariables","type":"object","patternProperties":{"[0-z]+":{"title":"serverObjectVariable","type":"object","required":["default"],"properties":{"default":{"title":"serverObjectVariableDefault","type":"string"},"description":{"title":"serverObjectVariableDescription","type":"string"},"enum":{"title":"serverObjectVariableEnum","type":"array","items":{"title":"serverObjectVariableEnumItem","type":"string"}}}}}}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"linkObject":{"title":"linkObject","type":"object","additionalProperties":false,"properties":{"name":{"title":"linkObjectName","type":"string","minLength":1},"summary":{"title":"linkObjectSummary","type":"string"},"method":{"title":"linkObjectMethod","type":"string"},"description":{"title":"linkObjectDescription","type":"string"},"params":{"title":"linkObjectParams"},"server":{"title":"linkObjectServer","$ref":"#/definitions/serverObject"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"externalDocumentationObject":{"title":"externalDocumentationObject","type":"object","additionalProperties":false,"description":"information about external documentation","required":["url"],"properties":{"description":{"title":"externalDocumentationObjectDescription","type":"string"},"url":{"title":"externalDocumentationObjectUrl","type":"string","format":"uri"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"methodObject":{"title":"methodObject","type":"object","required":["name","params"],"additionalProperties":false,"properties":{"name":{"title":"methodObjectName","description":"The cannonical name for the method. The name MUST be unique within the methods array.","type":"string","minLength":1},"description":{"title":"methodObjectDescription","description":"A verbose explanation of the method behavior. GitHub Flavored Markdown syntax MAY be used for rich text representation.","type":"string"},"summary":{"title":"methodObjectSummary","description":"A short summary of what the method does.","type":"string"},"servers":{"title":"servers","type":"array","additionalItems":false,"items":{"$ref":"#/definitions/serverObject"}},"tags":{"title":"methodObjectTags","type":"array","items":{"title":"tagOrReference","oneOf":[{"$ref":"#/definitions/tagObject"},{"$ref":"#/definitions/referenceObject"}]}},"paramStructure":{"title":"methodObjectParamStructure","type":"string","description":"Format the server expects the params. Defaults to 'either'.","enum":["by-position","by-name","either"],"default":"either"},"params":{"title":"methodObjectParams","type":"array","items":{"title":"contentDescriptorOrReference","oneOf":[{"$ref":"#/definitions/contentDescriptorObject"},{"$ref":"#/definitions/referenceObject"}]}},"result":{"title":"methodObjectResult","oneOf":[{"$ref":"#/definitions/contentDescriptorObject"},{"$ref":"#/definitions/referenceObject"}]},"errors":{"title":"methodObjectErrors","description":"Defines an application level error.","type":"array","items":{"title":"errorOrReference","oneOf":[{"$ref":"#/definitions/errorObject"},{"$ref":"#/definitions/referenceObject"}]}},"links":{"title":"methodObjectLinks","type":"array","items":{"title":"linkOrReference","oneOf":[{"$ref":"#/definitions/linkObject"},{"$ref":"#/definitions/referenceObject"}]}},"examples":{"title":"methodObjectExamples","type":"array","items":{"title":"examplePairingOrReference","oneOf":[{"$ref":"#/definitions/examplePairingObject"},{"$ref":"#/definitions/referenceObject"}]}},"deprecated":{"title":"methodObjectDeprecated","type":"boolean","default":false},"externalDocs":{"$ref":"#/definitions/externalDocumentationObject"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"tagObject":{"title":"tagObject","type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"title":"tagObjectName","type":"string","minLength":1},"description":{"title":"tagObjectDescription","type":"string"},"externalDocs":{"$ref":"#/definitions/externalDocumentationObject"}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"exampleObject":{"title":"exampleObject","type":"object","required":["name","value"],"properties":{"summary":{"title":"exampleObjectSummary","type":"string"},"value":{"title":"exampleObjectValue"},"description":{"title":"exampleObjectDescription","type":"string"},"name":{"title":"exampleObjectName","type":"string","minLength":1}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}},"examplePairingObject":{"title":"examplePairingObject","type":"object","required":["name","params"],"properties":{"name":{"title":"examplePairingObjectName","type":"string","minLength":1},"description":{"title":"examplePairingObjectDescription","type":"string"},"params":{"title":"examplePairingObjectParams","type":"array","items":{"title":"exampleOrReference","oneOf":[{"$ref":"#/definitions/exampleObject"},{"$ref":"#/definitions/referenceObject"}]}},"result":{"title":"examplePairingObjectResult","oneOf":[{"$ref":"#/definitions/exampleObject"},{"$ref":"#/definitions/referenceObject"}]}}},"contentDescriptorObject":{"title":"contentDescriptorObject","type":"object","additionalProperties":false,"required":["name","schema"],"properties":{"name":{"title":"contentDescriptorObjectName","type":"string","minLength":1},"description":{"title":"contentDescriptorObjectDescription","type":"string"},"summary":{"title":"contentDescriptorObjectSummary","type":"string"},"schema":{"$ref":"#/definitions/JSONSchema"},"required":{"title":"contentDescriptorObjectRequired","type":"boolean","default":false},"deprecated":{"title":"contentDescriptorObjectDeprecated","type":"boolean","default":false}},"patternProperties":{"^x-":{"$ref":"#/definitions/specificationExtension"}}}}}
|
Provide a JSON object that satisfies the schema "openrpcDocument". Here are the required top‑level fields: info, methods, openrpc. Return only the valid JSON object.
|
openrpcDocument
|
schema-store
|
schema_store_4
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft-04/schema#\",\"title\":\"Sapphire CLI Config\",\"description\":\"Scheme for Sapphire CLI Config (@sapphire/cli)\",\"type\":\"object\",\"properties\":{\"projectLanguage\":{\"description\":\"Project language (ts | js)\",\"type\":\"string\",\"enum\":[\"ts\",\"js\"]},\"locations\":{\"description\":\"Categories and their locations\",\"type\":\"object\",\"properties\":{\"base\":{\"type\":\"string\"},\"arguments\":{\"type\":\"string\"},\"commands\":{\"type\":\"string\"},\"listeners\":{\"type\":\"string\"},\"preconditions\":{\"type\":\"string\"},\"interaction-handlers\":{\"type\":\"string\"},\"routes\":{\"type\":\"string\"}},\"required\":[\"base\",\"arguments\",\"commands\",\"listeners\",\"preconditions\",\"interaction-handlers\"]},\"customFileTemplates\":{\"description\":\"Settings about custom component (piece) templates\",\"type\":\"object\",\"properties\":{\"enabled\":{\"description\":\"Enable custom file templates\",\"type\":\"boolean\"},\"location\":{\"description\":\"Location of your custom file templates\",\"type\":\"string\"}},\"required\":[\"enabled\",\"location\"]}},\"required\":[\"projectLanguage\",\"locations\",\"customFileTemplates\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Sapphire CLI Config\". Here are the required top‑level fields: projectLanguage, locations, customFileTemplates. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft-04/schema#","title":"Sapphire CLI Config","description":"Scheme for Sapphire CLI Config (@sapphire/cli)","type":"object","properties":{"projectLanguage":{"description":"Project language (ts | js)","type":"string","enum":["ts","js"]},"locations":{"description":"Categories and their locations","type":"object","properties":{"base":{"type":"string"},"arguments":{"type":"string"},"commands":{"type":"string"},"listeners":{"type":"string"},"preconditions":{"type":"string"},"interaction-handlers":{"type":"string"},"routes":{"type":"string"}},"required":["base","arguments","commands","listeners","preconditions","interaction-handlers"]},"customFileTemplates":{"description":"Settings about custom component (piece) templates","type":"object","properties":{"enabled":{"description":"Enable custom file templates","type":"boolean"},"location":{"description":"Location of your custom file templates","type":"string"}},"required":["enabled","location"]}},"required":["projectLanguage","locations","customFileTemplates"]}
|
Provide a JSON object that satisfies the schema "Sapphire CLI Config". Here are the required top‑level fields: projectLanguage, locations, customFileTemplates. Return only the valid JSON object.
|
Sapphire CLI Config
|
schema-store
|
schema_store_5
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"description\":\"Freifunk Community API 0.5.2\",\"type\":\"object\",\"definitions\":{\"city\":{\"type\":\"string\",\"title\":\"City\",\"description\":\"Name of the city\"},\"country\":{\"type\":\"string\",\"title\":\"Country\",\"description\":\"Your country, list has been taken from http://countrylist.net/de/\",\"enum\":[\"\",\"AF\",\"AX\",\"AL\",\"DZ\",\"AS\",\"AD\",\"AO\",\"AI\",\"AQ\",\"AG\",\"AR\",\"AM\",\"AW\",\"AC\",\"AU\",\"AT\",\"AZ\",\"BS\",\"BH\",\"BD\",\"BB\",\"BY\",\"BE\",\"BZ\",\"BJ\",\"BM\",\"BT\",\"BO\",\"BA\",\"BW\",\"BV\",\"BR\",\"IO\",\"BN\",\"BG\",\"BF\",\"BI\",\"KH\",\"CM\",\"CA\",\"IC\",\"CV\",\"KY\",\"CF\",\"TD\",\"CL\",\"CN\",\"CX\",\"CC\",\"CO\",\"KM\",\"CG\",\"CD\",\"CK\",\"CR\",\"CI\",\"HR\",\"CU\",\"CY\",\"CZ\",\"DK\",\"DG\",\"DJ\",\"DM\",\"DO\",\"EC\",\"EG\",\"SV\",\"GQ\",\"ER\",\"EE\",\"ET\",\"EU\",\"FK\",\"FO\",\"FJ\",\"FI\",\"FR\",\"GF\",\"PF\",\"TF\",\"GA\",\"GM\",\"GE\",\"DE\",\"GH\",\"GI\",\"GR\",\"GL\",\"GD\",\"GP\",\"GU\",\"GT\",\"GG\",\"GN\",\"GW\",\"GY\",\"HT\",\"HM\",\"VA\",\"HN\",\"HK\",\"HU\",\"IS\",\"IN\",\"ID\",\"IR\",\"IQ\",\"IE\",\"IM\",\"IL\",\"IT\",\"JM\",\"JP\",\"JE\",\"JO\",\"KZ\",\"KE\",\"KI\",\"KP\",\"KR\",\"KW\",\"KG\",\"LA\",\"LV\",\"LB\",\"LS\",\"LR\",\"LY\",\"LI\",\"LT\",\"LU\",\"MO\",\"MK\",\"MG\",\"MW\",\"MY\",\"MV\",\"ML\",\"MT\",\"MH\",\"MQ\",\"MR\",\"MU\",\"YT\",\"MX\",\"FM\",\"MD\",\"MC\",\"MN\",\"ME\",\"MS\",\"MA\",\"MZ\",\"MM\",\"NA\",\"NR\",\"NP\",\"NL\",\"AN\",\"NC\",\"NZ\",\"NI\",\"NE\",\"NG\",\"NU\",\"NF\",\"MP\",\"NO\",\"OM\",\"PK\",\"PW\",\"PS\",\"PA\",\"PG\",\"PY\",\"PE\",\"PH\",\"PN\",\"PL\",\"PT\",\"PR\",\"QA\",\"RE\",\"RO\",\"RU\",\"RW\",\"SH\",\"KN\",\"LC\",\"PM\",\"VC\",\"WS\",\"SM\",\"ST\",\"SA\",\"NT\",\"SN\",\"CS\",\"SC\",\"SL\",\"SG\",\"SK\",\"SI\",\"SB\",\"SO\",\"ZA\",\"GS\",\"SU\",\"ES\",\"LK\",\"SD\",\"SR\",\"SJ\",\"SZ\",\"SE\",\"CH\",\"SY\",\"TW\",\"TJ\",\"TZ\",\"TH\",\"TL\",\"TG\",\"TK\",\"TO\",\"TT\",\"TA\",\"TN\",\"TR\",\"TM\",\"TC\",\"TV\",\"UG\",\"UA\",\"AE\",\"GB\",\"US\",\"UY\",\"UZ\",\"VU\",\"VE\",\"VN\",\"VG\",\"VI\",\"WF\",\"EH\",\"YE\",\"ZM\",\"ZW\"]},\"address\":{\"type\":\"object\",\"description\":\"The address of the place you meet\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name of your place\",\"description\":\"The name of the place you meet\"},\"street\":{\"type\":\"string\",\"title\":\"Street\",\"description\":\"The street address of your meeting place\"},\"zipcode\":{\"type\":\"string\",\"title\":\"ZIP\",\"description\":\"The zip code of your meeting place\"}},\"additionalProperties\":false},\"geoCode\":{\"type\":\"object\",\"properties\":{\"lat\":{\"type\":\"number\",\"title\":\"Latitude\",\"description\":\"Lattitude of your city in decimal degrees\"},\"lon\":{\"type\":\"number\",\"title\":\"Longitude\",\"description\":\"Longitude of your city in decimal degrees\"}},\"required\":[\"lat\",\"lon\"],\"additionalProperties\":false},\"email\":{\"type\":\"string\",\"title\":\"Email\",\"format\":\"email\",\"pattern\":\"^[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6U\\u00df_\\\\-\\\\.]+@[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6U\\u00df_\\\\-\\\\.]+\\\\.[A-Za-z]{2,}$\"},\"url\":{\"type\":\"string\",\"pattern\":\"^(http|https)://[A-Za-z0-9\\u00c4\\u00d6\\u00dc\\u00e4\\u00f6\\u00fc\\u00df\\\\-_\\\\./]+\"},\"phone\":{\"type\":\"string\",\"title\":\"Phone\"}},\"properties\":{\"api\":{\"type\":\"string\",\"title\":\"API\",\"description\":\"The Freifunk Community API version you use\",\"enum\":[\"0.1\",\"0.2.0\",\"0.2.1\",\"0.3.0\",\"0.3.1\",\"0.3.2\",\"0.4.0\",\"0.4.1\",\"0.4.2\",\"0.4.3\",\"0.4.4\",\"0.4.5\",\"0.4.6\",\"0.4.7\",\"0.4.8\",\"0.4.9\",\"0.4.10\",\"0.4.11\",\"0.4.12\",\"0.4.13\",\"0.4.14\",\"0.4.15\",\"0.4.16\",\"0.5.0\",\"0.5.1\",\"0.5.2\"],\"default\":\"0.5.2\"},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of your community\"},\"metacommunity\":{\"type\":\"string\",\"title\":\"Metacommunity\",\"description\":\"The name of your metacommunity, if your local community belongs to a bigger one\"},\"location\":{\"title\":\"Primary Location\",\"type\":\"object\",\"description\":\"Position data such as a postal address or geographic coordinates\",\"properties\":{\"city\":{\"$ref\":\"#/definitions/city\"},\"country\":{\"$ref\":\"#/definitions/country\"},\"address\":{\"$ref\":\"#/definitions/address\"},\"geoCode\":{\"$ref\":\"#/definitions/geoCode\"},\"additionalLocations\":{\"type\":\"array\",\"title\":\"Additional Locations\",\"description\":\"Add some more locations where your community is active.\",\"items\":{\"title\":\"Location\",\"type\":\"object\",\"properties\":{\"city\":{\"$ref\":\"#/definitions/city\"},\"country\":{\"$ref\":\"#/definitions/country\"},\"address\":{\"$ref\":\"#/definitions/address\"},\"geoCode\":{\"$ref\":\"#/definitions/geoCode\"}},\"required\":[\"city\",\"geoCode\"],\"additionalProperties\":false}}},\"required\":[\"city\",\"geoCode\"],\"additionalProperties\":false},\"contact\":{\"type\":\"object\",\"minProperties\":1,\"properties\":{\"email\":{\"$ref\":\"#/definitions/email\",\"title\":\"Email\",\"description\":\"Email address to which other people can contact your community ([email protected])\"},\"facebook\":{\"type\":\"string\",\"title\":\"facebook\",\"description\":\"URL to your community's facebook account (https://facebook.com/...)\",\"pattern\":\"^(http|https)://([a-z\\\\-]*\\\\.|)facebook\\\\.com/[A-Za-z0-9\\u00c4\\u00d6\\u00dc\\u00e4\\u00f6\\u00fc\\u00df\\\\-_\\\\.]+\"},\"identica\":{\"type\":\"string\",\"title\":\"identica\",\"description\":\"URL to your community's identica account (https://identi.ca/...)\",\"pattern\":\"^(http|https)://([a-z\\\\-]*\\\\.|)identi\\\\.ca/[A-Za-z0-9\\u00c4\\u00d6\\u00dc\\u00e4\\u00f6\\u00fc\\u00df\\\\-_\\\\.]+\"},\"irc\":{\"type\":\"string\",\"title\":\"IRC\",\"description\":\"Your community's ICR channel; starts with irc://\",\"pattern\":\"^(irc|ircs)://.*\"},\"jabber\":{\"type\":\"string\",\"title\":\"Jabber\",\"description\":\"A jabber account someone reads ([email protected])\",\"pattern\":\"^[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6U\\u00df_\\\\-\\\\.]+@[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6U\\u00df_\\\\-\\\\.]+\\\\.[A-Za-z]{2,}(\\\\?join){0,1}$\"},\"ml\":{\"type\":\"string\",\"title\":\"Mailinglist\",\"description\":\"The email address ([email protected]) of your mailing list or a link to the mailinglist info page (http{s}://...)\",\"pattern\":\"^([A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6U\\u00df_\\\\-\\\\.]+@[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6U\\u00df_\\\\-\\\\.]+\\\\.[A-Za-z]{2,}|(http|https)://[A-Za-z0-9\\u00c4\\u00d6\\u00dc\\u00e4\\u00f6\\u00fc\\u00df\\\\-_\\\\./]+)$\"},\"googleplus\":{\"type\":\"string\",\"title\":\"Google+\",\"description\":\"URL to your community's g+ account (https://plus.google.com/...)\",\"pattern\":\"^(http|https)://plus\\\\.google\\\\.com/[A-Za-z0-9\\u00c4\\u00d6\\u00dc\\u00e4\\u00f6\\u00fc\\u00df\\\\+\\\\-\\\\./_]+\"},\"matrix\":{\"type\":\"string\",\"title\":\"Matrix\",\"description\":\"URL to your community's matrix channel (https://matrix.to/#/!...)\",\"pattern\":\"^https://matrix\\\\.to/#/\"},\"mastodon\":{\"title\":\"Mastodon\",\"$ref\":\"#/definitions/url\",\"description\":\"URL to your community's mastodon profile (https://...)\"},\"twitter\":{\"type\":\"string\",\"title\":\"Twitter\",\"description\":\"Your community's Twitter name (starts with @)\",\"pattern\":\"^@[A-Za-z0-9_\\\\-]{1,15}\"},\"webform\":{\"$ref\":\"#/definitions/url\",\"title\":\"Webform\",\"description\":\"URL to your community's contact form (http{s}://...)\"},\"phone\":{\"$ref\":\"#/definitions/phone\",\"title\":\"Phone\",\"description\":\"If your community has a phone number (e.g. +49 1234 567890 based on the E.123 notation)\"}},\"additionalProperties\":false},\"url\":{\"title\":\"HomePage\",\"$ref\":\"#/definitions/url\",\"description\":\"The main website (http{s}://...)\"},\"timeline\":{\"type\":\"array\",\"description\":\"These are lifetime events something like date of birth (and rebirth :-) of your community or other important milestones\",\"items\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"Description of your lifetime event\"},\"timestamp\":{\"type\":\"string\",\"title\":\"Timestamp\",\"format\":\"date\",\"description\":\"ISO 8601 timestamp of the event's date (format yyyy-mm-dd)\",\"pattern\":\"^([0-9]{4})(?:-?W([0-9]+)(?:-?([0-9]+)D?)?|(?:-([0-9]+))?-([0-9]+))(?:[T ]([0-9]+):([0-9]+)(?::([0-9]+)(?:\\\\.([0-9]+))?)?)?(?:Z(-?[0-9]*))?\"},\"url\":{\"$ref\":\"#/definitions/url\",\"title\":\"URL\",\"description\":\"URL to details of this timeline-element\"}},\"additionalProperties\":false}},\"feeds\":{\"type\":\"array\",\"title\":\"Feeds\",\"description\":\"Feeds you provide your community\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Feed name\",\"description\":\"Name of the feed\"},\"category\":{\"type\":\"string\",\"title\":\"Feed category\",\"description\":\"Category of the feed like blog entries, calendars, forum messages, wiki articles, ...\",\"enum\":[\"blog\",\"forum\",\"ics\",\"podcast\",\"wiki\",\"others\",\"\"],\"default\":\"\"},\"type\":{\"type\":\"string\",\"title\":\"Feed Type\",\"description\":\"Type of the feed like RSS, Atom, XML\"},\"url\":{\"$ref\":\"#/definitions/url\",\"title\":\"URL\",\"description\":\"URL of the feed\"}},\"additionalProperties\":false}},\"state\":{\"type\":\"object\",\"title\":\"States\",\"description\":\"A collection of status-related data. Actual open/closed status, icons, last change timestamp etc.\",\"properties\":{\"nodes\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Active Nodes\",\"description\":\"Number of active nodes. This field is predestined to be updated regularly, please see sample solutions for <a href=\\\"https://github.com/Freifunk-Mainz/changeffapi\\\" target=\\\"_blank\\\">Gluon</a> or <a href=\\\"https://github.com/freifunk/common.api.freifunk.net/blob/master/contrib/ffapi-update-nodes.py\\\" target=\\\"_blank\\\">OLSR</a>\"},\"lastchange\":{\"type\":\"string\",\"title\":\"Last Change\",\"format\":\"date-time\",\"description\":\"At what ISO 8601 timestamp has your community status lastly changed?\",\"default\":0},\"message\":{\"type\":\"string\",\"title\":\"Message\",\"description\":\"A free-form string something like 'open for public', 'members only' or whatever you want it to be)\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"Describe your community in a few lines\"},\"focus\":{\"type\":\"array\",\"title\":\"Focus\",\"description\":\"What's the focus of your local community?\",\"items\":{\"type\":\"string\",\"title\":\"option\",\"enum\":[\"infrastructure/backbone\",\"Public Free Wifi\",\"Social Community Building\",\"Local services and content\",\"Free internet access\"]}}},\"required\":[\"lastchange\"],\"additionalProperties\":false},\"nodeMaps\":{\"type\":\"array\",\"title\":\"Nodes\",\"description\":\"Maps of nodes or topology your community provides\",\"items\":{\"type\":\"object\",\"title\":\"node\",\"properties\":{\"url\":{\"$ref\":\"#/definitions/url\",\"title\":\"URL of the map\",\"description\":\"The URL where the map is located\"},\"interval\":{\"type\":\"string\",\"title\":\"interval\",\"description\":\"How often the map will be refreshed\"},\"technicalType\":{\"type\":\"string\",\"title\":\"map techincal type\",\"description\":\"The kind of map is used\",\"enum\":[\"\",\"ffmap\",\"ffsomething\",\"olsr-dot\",\"openwifimap\",\"netmon\",\"libremap\",\"nodewatcher\",\"kml\",\"nodelist\",\"meshviewer\",\"hopglass\"],\"default\":\"\"},\"mapType\":{\"type\":\"string\",\"title\":\"Maptype\",\"description\":\"\",\"enum\":[\"\",\"geographical\",\"structural\",\"list/status\"],\"default\":\"\"}},\"additionalProperties\":false}},\"services\":{\"type\":\"array\",\"title\":\"Services\",\"description\":\"Services Provided by your community\",\"items\":{\"type\":\"object\",\"properties\":{\"serviceName\":{\"type\":\"string\",\"title\":\"Service Name\",\"description\":\"Name of your service (e.g. jabber...)\"},\"serviceDescription\":{\"type\":\"string\",\"title\":\"Service Description\",\"description\":\"Describe your service\"},\"externalUri\":{\"type\":\"string\",\"title\":\"External URI\",\"description\":\"URI to use your service from the internet\"},\"internalUri\":{\"type\":\"string\",\"title\":\"Internal URI\",\"description\":\"URI to use your service from Freifunk or icvpn-networks\"}},\"additionalProperties\":false}},\"support\":{\"type\":\"object\",\"title\":\"Support for your community\",\"properties\":{\"club\":{\"type\":\"object\",\"title\":\"Supporting Club\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Club Name\",\"description\":\"Name of the Club\"},\"street\":{\"type\":\"string\",\"title\":\"Street\",\"description\":\"Address - Street\"},\"zip\":{\"type\":\"string\",\"title\":\"ZIP\",\"description\":\"Address - ZIP\"},\"city\":{\"$ref\":\"#/definitions/city\"},\"url\":{\"$ref\":\"#/definitions/url\",\"title\":\"HomePage\",\"description\":\"The club's website (http{s}://...)\"},\"email\":{\"$ref\":\"#/definitions/email\",\"description\":\"Email address to contact the club ([email protected])\"},\"board\":{\"type\":\"array\",\"title\":\"Board Members\",\"description\":\"Who are the board members of the club?\",\"items\":{\"type\":\"string\",\"title\":\"Name\"}}},\"additionalProperties\":false},\"donations\":{\"type\":\"object\",\"title\":\"Donations\",\"properties\":{\"bankaccount\":{\"type\":\"object\",\"title\":\"Bank Account\",\"properties\":{\"IBAN\":{\"type\":\"string\",\"title\":\"IBAN\"},\"BIC\":{\"type\":\"string\",\"title\":\"BIC\"},\"usage\":{\"type\":\"string\",\"title\":\"Usage of the donations\",\"description\":\"Please use this string as transfer-purpose to define a special usage of your donation.\"}},\"additionalProperties\":false},\"campaigns\":{\"type\":\"array\",\"title\":\"Campaigns\",\"items\":{\"type\":\"object\",\"title\":\"campaign\",\"properties\":{\"provider\":{\"type\":\"string\",\"title\":\"Campaign Providers\",\"description\":\"Where do you host your donations?\",\"enum\":[\"\",\"betterplace\",\"boost\"],\"default\":\"\"},\"projectid\":{\"type\":\"string\",\"title\":\"Project ID\",\"description\":\"ID of your project, Betterplace-IDs are multiple digits and can be found within the URL\"}},\"additionalProperties\":false}}},\"additionalProperties\":false}},\"additionalProperties\":false},\"socialprojects\":{\"type\":\"object\",\"title\":\"\",\"properties\":{\"number\":{\"type\":\"integer\",\"mininum\":0,\"title\":\"Number of Projects\",\"description\":\"Number of projects supported by your Community\"},\"website\":{\"$ref\":\"#/definitions/url\",\"title\":\"URL of your page\",\"description\":\"A link to a web site where people can find an overview over your projects\"},\"contact\":{\"$ref\":\"#/definitions/email\",\"title\":\"Contact Email\",\"description\":\"Please provide an email address to contact you on refugees and social projects\"}},\"additionalProperties\":false},\"privacy\":{\"type\":\"object\",\"title\":\"Privacy Policy\",\"properties\":{\"policyurl\":{\"$ref\":\"#/definitions/url\",\"title\":\"Privacy Policy URL\",\"description\":\"URL to your privacy policy description\"}},\"additionalProperties\":false},\"techDetails\":{\"type\":\"object\",\"description\":\"Technical details of your community's Freifunk implementation\",\"properties\":{\"firmware\":{\"type\":\"object\",\"properties\":{\"url\":{\"$ref\":\"#/definitions/url\",\"title\":\"Firmware download\",\"description\":\"Link to your firmware images\"},\"docs\":{\"$ref\":\"#/definitions/url\",\"title\":\"Firmware Document\",\"description\":\"Link to your firmware docs\"},\"vpnaccess\":{\"type\":\"string\",\"title\":\"VPN Access\",\"description\":\"How to access your VPN services\",\"enum\":[\"\",\"automatic\",\"fwimage\",\"mail\",\"webform\",\"else\"],\"default\":\"\"},\"registrationurl\":{\"$ref\":\"#/definitions/url\",\"title\":\"VPN Registration URL\",\"description\":\"link to your website to request a new VPN key\"},\"orgrestrictions\":{\"type\":\"string\",\"title\":\"Organizational Restrictions\",\"description\":\"Are there any organizational restrictions when using/installing your firmware?\"},\"techrestrictions\":{\"type\":\"string\",\"title\":\"Technical Restriction\",\"description\":\"Are there any technical restrictions like hardware?\"},\"name\":{\"type\":\"string\",\"title\":\"Firmware Name\",\"description\":\"Name of your firmware\"}},\"additionalProperties\":false},\"dns\":{\"type\":\"array\",\"title\":\"DNS Servers\",\"description\":\"DNS servers for domains used by your community\",\"items\":{\"type\":\"object\",\"title\":\"dns\",\"properties\":{\"domainname\":{\"type\":\"string\",\"title\":\"Domain Name\",\"description\":\"The domain name (e.g. ffhh, ffol)\",\"pattern\":\"^[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6\\u00dc\\u00df\\\\.\\\\-\\\\_]{2,}$\"},\"nameserver\":{\"type\":\"array\",\"title\":\"Nameserver\",\"description\":\"Nameservers servings zones of your domain\",\"items\":{\"type\":\"string\",\"pattern\":\"^[A-Za-z0-9\\u00e4\\u00f6\\u00fc\\u00c4\\u00d6\\u00dc\\u00df_\\\\-\\\\.:]*$\"}}},\"additionalProperties\":false}},\"networks\":{\"type\":\"object\",\"description\":\"Networks used by your community\",\"properties\":{\"ipv6\":{\"type\":\"array\",\"title\":\"IPv6 networks\",\"description\":\"IPv6 networks used by your community\",\"items\":{\"type\":\"object\",\"title\":\"ipv6 network object\",\"properties\":{\"network\":{\"type\":\"string\",\"description\":\"IPv6 network network (e.g.2620:0:2d0:200::7/32) in CIDR notation\",\"pattern\":\"^\\\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)(\\\\.(25[0-5]|2[0-4]\\\\d|1\\\\d\\\\d|[1-9]?\\\\d)){3}))|:)))(%.+)?\\\\s*(\\\\/(\\\\d|\\\\d\\\\d|1[0-1]\\\\d|12[0-8]))$\"}},\"additionalProperties\":false}},\"ipv4\":{\"type\":\"array\",\"description\":\"IPv4 networks used by your community\",\"items\":{\"type\":\"object\",\"title\":\"ipv4 network object\",\"properties\":{\"network\":{\"type\":\"string\",\"description\":\"IPv4 network name (e.g. 10.w.x.y/z) in CIDR notation\",\"pattern\":\"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\\\/(\\\\d|[1-2]\\\\d|3[0-2]))$\"}},\"additionalProperties\":false}}},\"additionalProperties\":false},\"routing\":{\"type\":\"array\",\"title\":\"Routing protocols\",\"description\":\"Routing protocols used within your community\",\"items\":{\"type\":\"string\",\"title\":\"option\",\"enum\":[\"802.11s\",\"Babel\",\"batman-adv\",\"bmx6\",\"bmxd\",\"cjdns\",\"OLSR\",\"OLSRv2\"]}},\"legals\":{\"type\":\"array\",\"title\":\"Legal Issues\",\"description\":\"What do you use to handle legal issues, e.g. the German St\\u00f6rerhaftung or restrictions in your country?\",\"items\":{\"type\":\"string\",\"title\":\"option\",\"enum\":[\"nothing\",\"vpnnational\",\"vpninternational\",\"zappscript\",\"p2pblock\",\"splashpage\",\"termsconditions\",\"anonymizer\",\"institutions\"]}},\"updatemode\":{\"type\":\"array\",\"title\":\"Updatemode\",\"description\":\"How do you deploy firmware updates?\",\"items\":{\"type\":\"string\",\"title\":\"option\",\"enum\":[\"none\",\"manual\",\"autoupdate\"]}}},\"additionalProperties\":false}},\"required\":[\"name\",\"location\",\"contact\",\"url\",\"state\",\"techDetails\"],\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"0.5.2\". Here are the required top‑level fields: name, location, contact, url, state, techDetails. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema","description":"Freifunk Community API 0.5.2","type":"object","definitions":{"city":{"type":"string","title":"City","description":"Name of the city"},"country":{"type":"string","title":"Country","description":"Your country, list has been taken from http://countrylist.net/de/","enum":["","AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AC","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","IC","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DG","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","EU","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","SH","KN","LC","PM","VC","WS","SM","ST","SA","NT","SN","CS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","SU","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TA","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"]},"address":{"type":"object","description":"The address of the place you meet","properties":{"name":{"type":"string","title":"Name of your place","description":"The name of the place you meet"},"street":{"type":"string","title":"Street","description":"The street address of your meeting place"},"zipcode":{"type":"string","title":"ZIP","description":"The zip code of your meeting place"}},"additionalProperties":false},"geoCode":{"type":"object","properties":{"lat":{"type":"number","title":"Latitude","description":"Lattitude of your city in decimal degrees"},"lon":{"type":"number","title":"Longitude","description":"Longitude of your city in decimal degrees"}},"required":["lat","lon"],"additionalProperties":false},"email":{"type":"string","title":"Email","format":"email","pattern":"^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}$"},"url":{"type":"string","pattern":"^(http|https)://[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\./]+"},"phone":{"type":"string","title":"Phone"}},"properties":{"api":{"type":"string","title":"API","description":"The Freifunk Community API version you use","enum":["0.1","0.2.0","0.2.1","0.3.0","0.3.1","0.3.2","0.4.0","0.4.1","0.4.2","0.4.3","0.4.4","0.4.5","0.4.6","0.4.7","0.4.8","0.4.9","0.4.10","0.4.11","0.4.12","0.4.13","0.4.14","0.4.15","0.4.16","0.5.0","0.5.1","0.5.2"],"default":"0.5.2"},"name":{"type":"string","title":"Name","description":"The name of your community"},"metacommunity":{"type":"string","title":"Metacommunity","description":"The name of your metacommunity, if your local community belongs to a bigger one"},"location":{"title":"Primary Location","type":"object","description":"Position data such as a postal address or geographic coordinates","properties":{"city":{"$ref":"#/definitions/city"},"country":{"$ref":"#/definitions/country"},"address":{"$ref":"#/definitions/address"},"geoCode":{"$ref":"#/definitions/geoCode"},"additionalLocations":{"type":"array","title":"Additional Locations","description":"Add some more locations where your community is active.","items":{"title":"Location","type":"object","properties":{"city":{"$ref":"#/definitions/city"},"country":{"$ref":"#/definitions/country"},"address":{"$ref":"#/definitions/address"},"geoCode":{"$ref":"#/definitions/geoCode"}},"required":["city","geoCode"],"additionalProperties":false}}},"required":["city","geoCode"],"additionalProperties":false},"contact":{"type":"object","minProperties":1,"properties":{"email":{"$ref":"#/definitions/email","title":"Email","description":"Email address to which other people can contact your community ([email protected])"},"facebook":{"type":"string","title":"facebook","description":"URL to your community's facebook account (https://facebook.com/...)","pattern":"^(http|https)://([a-z\\-]*\\.|)facebook\\.com/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\.]+"},"identica":{"type":"string","title":"identica","description":"URL to your community's identica account (https://identi.ca/...)","pattern":"^(http|https)://([a-z\\-]*\\.|)identi\\.ca/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\.]+"},"irc":{"type":"string","title":"IRC","description":"Your community's ICR channel; starts with irc://","pattern":"^(irc|ircs)://.*"},"jabber":{"type":"string","title":"Jabber","description":"A jabber account someone reads ([email protected])","pattern":"^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}(\\?join){0,1}$"},"ml":{"type":"string","title":"Mailinglist","description":"The email address ([email protected]) of your mailing list or a link to the mailinglist info page (http{s}://...)","pattern":"^([A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+@[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6U\u00df_\\-\\.]+\\.[A-Za-z]{2,}|(http|https)://[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\-_\\./]+)$"},"googleplus":{"type":"string","title":"Google+","description":"URL to your community's g+ account (https://plus.google.com/...)","pattern":"^(http|https)://plus\\.google\\.com/[A-Za-z0-9\u00c4\u00d6\u00dc\u00e4\u00f6\u00fc\u00df\\+\\-\\./_]+"},"matrix":{"type":"string","title":"Matrix","description":"URL to your community's matrix channel (https://matrix.to/#/!...)","pattern":"^https://matrix\\.to/#/"},"mastodon":{"title":"Mastodon","$ref":"#/definitions/url","description":"URL to your community's mastodon profile (https://...)"},"twitter":{"type":"string","title":"Twitter","description":"Your community's Twitter name (starts with @)","pattern":"^@[A-Za-z0-9_\\-]{1,15}"},"webform":{"$ref":"#/definitions/url","title":"Webform","description":"URL to your community's contact form (http{s}://...)"},"phone":{"$ref":"#/definitions/phone","title":"Phone","description":"If your community has a phone number (e.g. +49 1234 567890 based on the E.123 notation)"}},"additionalProperties":false},"url":{"title":"HomePage","$ref":"#/definitions/url","description":"The main website (http{s}://...)"},"timeline":{"type":"array","description":"These are lifetime events something like date of birth (and rebirth :-) of your community or other important milestones","items":{"type":"object","properties":{"description":{"type":"string","title":"Description","description":"Description of your lifetime event"},"timestamp":{"type":"string","title":"Timestamp","format":"date","description":"ISO 8601 timestamp of the event's date (format yyyy-mm-dd)","pattern":"^([0-9]{4})(?:-?W([0-9]+)(?:-?([0-9]+)D?)?|(?:-([0-9]+))?-([0-9]+))(?:[T ]([0-9]+):([0-9]+)(?::([0-9]+)(?:\\.([0-9]+))?)?)?(?:Z(-?[0-9]*))?"},"url":{"$ref":"#/definitions/url","title":"URL","description":"URL to details of this timeline-element"}},"additionalProperties":false}},"feeds":{"type":"array","title":"Feeds","description":"Feeds you provide your community","items":{"type":"object","properties":{"name":{"type":"string","title":"Feed name","description":"Name of the feed"},"category":{"type":"string","title":"Feed category","description":"Category of the feed like blog entries, calendars, forum messages, wiki articles, ...","enum":["blog","forum","ics","podcast","wiki","others",""],"default":""},"type":{"type":"string","title":"Feed Type","description":"Type of the feed like RSS, Atom, XML"},"url":{"$ref":"#/definitions/url","title":"URL","description":"URL of the feed"}},"additionalProperties":false}},"state":{"type":"object","title":"States","description":"A collection of status-related data. Actual open/closed status, icons, last change timestamp etc.","properties":{"nodes":{"type":"integer","minimum":0,"title":"Active Nodes","description":"Number of active nodes. This field is predestined to be updated regularly, please see sample solutions for <a href=\"https://github.com/Freifunk-Mainz/changeffapi\" target=\"_blank\">Gluon</a> or <a href=\"https://github.com/freifunk/common.api.freifunk.net/blob/master/contrib/ffapi-update-nodes.py\" target=\"_blank\">OLSR</a>"},"lastchange":{"type":"string","title":"Last Change","format":"date-time","description":"At what ISO 8601 timestamp has your community status lastly changed?","default":0},"message":{"type":"string","title":"Message","description":"A free-form string something like 'open for public', 'members only' or whatever you want it to be)"},"description":{"type":"string","title":"Description","description":"Describe your community in a few lines"},"focus":{"type":"array","title":"Focus","description":"What's the focus of your local community?","items":{"type":"string","title":"option","enum":["infrastructure/backbone","Public Free Wifi","Social Community Building","Local services and content","Free internet access"]}}},"required":["lastchange"],"additionalProperties":false},"nodeMaps":{"type":"array","title":"Nodes","description":"Maps of nodes or topology your community provides","items":{"type":"object","title":"node","properties":{"url":{"$ref":"#/definitions/url","title":"URL of the map","description":"The URL where the map is located"},"interval":{"type":"string","title":"interval","description":"How often the map will be refreshed"},"technicalType":{"type":"string","title":"map techincal type","description":"The kind of map is used","enum":["","ffmap","ffsomething","olsr-dot","openwifimap","netmon","libremap","nodewatcher","kml","nodelist","meshviewer","hopglass"],"default":""},"mapType":{"type":"string","title":"Maptype","description":"","enum":["","geographical","structural","list/status"],"default":""}},"additionalProperties":false}},"services":{"type":"array","title":"Services","description":"Services Provided by your community","items":{"type":"object","properties":{"serviceName":{"type":"string","title":"Service Name","description":"Name of your service (e.g. jabber...)"},"serviceDescription":{"type":"string","title":"Service Description","description":"Describe your service"},"externalUri":{"type":"string","title":"External URI","description":"URI to use your service from the internet"},"internalUri":{"type":"string","title":"Internal URI","description":"URI to use your service from Freifunk or icvpn-networks"}},"additionalProperties":false}},"support":{"type":"object","title":"Support for your community","properties":{"club":{"type":"object","title":"Supporting Club","properties":{"name":{"type":"string","title":"Club Name","description":"Name of the Club"},"street":{"type":"string","title":"Street","description":"Address - Street"},"zip":{"type":"string","title":"ZIP","description":"Address - ZIP"},"city":{"$ref":"#/definitions/city"},"url":{"$ref":"#/definitions/url","title":"HomePage","description":"The club's website (http{s}://...)"},"email":{"$ref":"#/definitions/email","description":"Email address to contact the club ([email protected])"},"board":{"type":"array","title":"Board Members","description":"Who are the board members of the club?","items":{"type":"string","title":"Name"}}},"additionalProperties":false},"donations":{"type":"object","title":"Donations","properties":{"bankaccount":{"type":"object","title":"Bank Account","properties":{"IBAN":{"type":"string","title":"IBAN"},"BIC":{"type":"string","title":"BIC"},"usage":{"type":"string","title":"Usage of the donations","description":"Please use this string as transfer-purpose to define a special usage of your donation."}},"additionalProperties":false},"campaigns":{"type":"array","title":"Campaigns","items":{"type":"object","title":"campaign","properties":{"provider":{"type":"string","title":"Campaign Providers","description":"Where do you host your donations?","enum":["","betterplace","boost"],"default":""},"projectid":{"type":"string","title":"Project ID","description":"ID of your project, Betterplace-IDs are multiple digits and can be found within the URL"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false},"socialprojects":{"type":"object","title":"","properties":{"number":{"type":"integer","mininum":0,"title":"Number of Projects","description":"Number of projects supported by your Community"},"website":{"$ref":"#/definitions/url","title":"URL of your page","description":"A link to a web site where people can find an overview over your projects"},"contact":{"$ref":"#/definitions/email","title":"Contact Email","description":"Please provide an email address to contact you on refugees and social projects"}},"additionalProperties":false},"privacy":{"type":"object","title":"Privacy Policy","properties":{"policyurl":{"$ref":"#/definitions/url","title":"Privacy Policy URL","description":"URL to your privacy policy description"}},"additionalProperties":false},"techDetails":{"type":"object","description":"Technical details of your community's Freifunk implementation","properties":{"firmware":{"type":"object","properties":{"url":{"$ref":"#/definitions/url","title":"Firmware download","description":"Link to your firmware images"},"docs":{"$ref":"#/definitions/url","title":"Firmware Document","description":"Link to your firmware docs"},"vpnaccess":{"type":"string","title":"VPN Access","description":"How to access your VPN services","enum":["","automatic","fwimage","mail","webform","else"],"default":""},"registrationurl":{"$ref":"#/definitions/url","title":"VPN Registration URL","description":"link to your website to request a new VPN key"},"orgrestrictions":{"type":"string","title":"Organizational Restrictions","description":"Are there any organizational restrictions when using/installing your firmware?"},"techrestrictions":{"type":"string","title":"Technical Restriction","description":"Are there any technical restrictions like hardware?"},"name":{"type":"string","title":"Firmware Name","description":"Name of your firmware"}},"additionalProperties":false},"dns":{"type":"array","title":"DNS Servers","description":"DNS servers for domains used by your community","items":{"type":"object","title":"dns","properties":{"domainname":{"type":"string","title":"Domain Name","description":"The domain name (e.g. ffhh, ffol)","pattern":"^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df\\.\\-\\_]{2,}$"},"nameserver":{"type":"array","title":"Nameserver","description":"Nameservers servings zones of your domain","items":{"type":"string","pattern":"^[A-Za-z0-9\u00e4\u00f6\u00fc\u00c4\u00d6\u00dc\u00df_\\-\\.:]*$"}}},"additionalProperties":false}},"networks":{"type":"object","description":"Networks used by your community","properties":{"ipv6":{"type":"array","title":"IPv6 networks","description":"IPv6 networks used by your community","items":{"type":"object","title":"ipv6 network object","properties":{"network":{"type":"string","description":"IPv6 network network (e.g.2620:0:2d0:200::7/32) in CIDR notation","pattern":"^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*(\\/(\\d|\\d\\d|1[0-1]\\d|12[0-8]))$"}},"additionalProperties":false}},"ipv4":{"type":"array","description":"IPv4 networks used by your community","items":{"type":"object","title":"ipv4 network object","properties":{"network":{"type":"string","description":"IPv4 network name (e.g. 10.w.x.y/z) in CIDR notation","pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(\\d|[1-2]\\d|3[0-2]))$"}},"additionalProperties":false}}},"additionalProperties":false},"routing":{"type":"array","title":"Routing protocols","description":"Routing protocols used within your community","items":{"type":"string","title":"option","enum":["802.11s","Babel","batman-adv","bmx6","bmxd","cjdns","OLSR","OLSRv2"]}},"legals":{"type":"array","title":"Legal Issues","description":"What do you use to handle legal issues, e.g. the German St\u00f6rerhaftung or restrictions in your country?","items":{"type":"string","title":"option","enum":["nothing","vpnnational","vpninternational","zappscript","p2pblock","splashpage","termsconditions","anonymizer","institutions"]}},"updatemode":{"type":"array","title":"Updatemode","description":"How do you deploy firmware updates?","items":{"type":"string","title":"option","enum":["none","manual","autoupdate"]}}},"additionalProperties":false}},"required":["name","location","contact","url","state","techDetails"],"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "0.5.2". Here are the required top‑level fields: name, location, contact, url, state, techDetails. Return only the valid JSON object.
|
0.5.2
|
schema-store
|
schema_store_6
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema\",\"id\":\"https://json.schemastore.org/gatewaycore-options-2021-07\",\"title\":\"Cloudtoid GatewayCore Options\",\"description\":\"Root Schema of options for Cloudtoid GatewayCore\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"system\":{\"type\":\"object\",\"description\":\"This section that contains all system wide configurations.\",\"additionalProperties\":false,\"properties\":{\"routeCacheMaxCount\":{\"type\":\"integer\",\"default\":100000,\"description\":\"The maximum number of mappings between \\\"inbound downstream request path\\\" and \\\"outbound upstream request URL\\\" that can be cached in memory.\"}}},\"routes\":{\"type\":\"object\",\"description\":\"This is the section in which proxy routes are defined.\",\"additionalProperties\":{\"type\":\"object\",\"description\":\"This is the url path pattern that if matched, the request is proxied to the address defined by its `to` property.\",\"additionalProperties\":false,\"properties\":{\"proxy\":{\"type\":\"object\",\"description\":\"The proxy configuration.\",\"additionalProperties\":false,\"properties\":{\"to\":{\"type\":\"string\",\"description\":\"This is an expression that defines the URL of the upstream server to which the downstream request is forwarded to.\",\"examples\":[\"http://example.com:85/api/\"]},\"proxyName\":{\"type\":\"string\",\"description\":\"This is an expression that defines the name of this proxy. This value is used in the Via HTTP header send on the outbound upstream request, and the outbound downstream response. If a value is specified, an `x-gwcore-proxy-name` header with this value is also added to the outbound upstream request.\",\"default\":\"gwcore\"},\"upstreamRequest\":{\"type\":\"object\",\"description\":\"The options that control the upstream requests.\",\"additionalProperties\":false,\"properties\":{\"httpVersion\":{\"type\":\"string\",\"description\":\"An expression that defines the HTTP protocol version of outbound upstream requests.\",\"default\":\"HTTP/2.0\"},\"headers\":{\"type\":\"object\",\"description\":\"The options that control the upstream request headers.\",\"additionalProperties\":false,\"properties\":{\"discardInboundHeaders\":{\"type\":\"boolean\",\"description\":\"Specifies if downstream inbound request and content headers should be discarded and not forwarded to the upstream.\",\"default\":false},\"discardEmpty\":{\"type\":\"boolean\",\"description\":\"Specifies if inbound headers with empty value should be discarded.\",\"default\":false},\"discardUnderscore\":{\"type\":\"boolean\",\"description\":\"Specifies if inbound headers with an underscore in their name should be discarded.\",\"default\":false},\"addExternalAddress\":{\"type\":\"boolean\",\"description\":\"Specifies if a `x-gwcore-external-address` header with the IP address of the immediate caller should be added to the outbound upstream request.\",\"default\":false},\"skipVia\":{\"type\":\"boolean\",\"description\":\"Specifies if the `via` header should be skipped from the outbound request.\",\"default\":false},\"skipForwarded\":{\"type\":\"boolean\",\"description\":\"Specifies if `forwarded` header and `x-forwarded-*` headers should be skipped from the outbound requests.\",\"default\":false},\"appends\":{\"type\":\"object\",\"description\":\"The headers to be appended to the outbound upstream requests. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"The value can be either text or an expression.\"}}},\"overrides\":{\"type\":\"object\",\"description\":\"The headers to be added to the outbound upstream requests. If the header already exists, its value is replaced. The value can be either text or an expression.\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"The value can be either text or an expression.\"}}},\"discards\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Specifies the inbound downstream headers that should be discarded.\"}}}},\"sender\":{\"type\":\"object\",\"description\":\"The options that control connection to the upstream server.\",\"additionalProperties\":false,\"properties\":{\"httpClientName\":{\"type\":\"string\",\"description\":\"The name of the .NET HttpClient that will be used to send the request. The default value is a system generated unique name.\"},\"timeoutInMilliseconds\":{\"type\":[\"string\",\"integer\"],\"description\":\"The total timeout in milliseconds to wait for the outbound upstream request to complete. This can be a number or an expression.\",\"default\":240000},\"connectTimeoutInMilliseconds\":{\"type\":\"integer\",\"description\":\"The connect timeout in milliseconds. No timeout is set by default.\"},\"expect100ContinueTimeoutInMilliseconds\":{\"type\":\"integer\",\"description\":\"The expect 100 continue timeout in milliseconds.\",\"default\":1000},\"pooledConnectionIdleTimeoutInMilliseconds\":{\"type\":\"integer\",\"description\":\"Specifies how long a connection can be idle in the pool to be considered reusable.\",\"default\":2000},\"pooledConnectionLifetimeInMilliseconds\":{\"type\":\"integer\",\"description\":\"Specifies how long a connection can live in the connection pool. By default, no timeout is set and the connection can stay in the pool.\"},\"responseDrainTimeoutInMilliseconds\":{\"type\":\"integer\",\"description\":\"Specifies the response drain timeout.\",\"default\":2000},\"maxAutomaticRedirections\":{\"type\":\"integer\",\"description\":\"The maximum number of allowed HTTP redirects.\",\"default\":50},\"maxConnectionsPerServer\":{\"type\":\"integer\",\"description\":\"The maximum number of simultaneous TCP connections allowed to a single server. No caps are set by default.\"},\"maxResponseDrainSizeInBytes\":{\"type\":\"integer\",\"description\":\"The maximum size of data that can be drained from responses in bytes.\",\"default\":1048576},\"maxResponseHeadersLengthInKilobytes\":{\"type\":\"integer\",\"description\":\"The maximum length, in kilobytes (1024 bytes), of the response headers.\",\"default\":64},\"allowAutoRedirect\":{\"type\":\"boolean\",\"description\":\"Indicates whether the HTTP handler used by the outbound upstream request sender should follow redirection responses.\",\"default\":false},\"useCookies\":{\"type\":\"boolean\",\"description\":\"Indicates whether the HTTP handler used by the outbound upstream request sender should store server cookies and use these cookies when sending requests.\",\"default\":false}}}}},\"downstreamResponse\":{\"type\":\"object\",\"description\":\"The options that control the downstream responses sent to the clients.\",\"additionalProperties\":false,\"properties\":{\"headers\":{\"type\":\"object\",\"description\":\"The options that control the downstream response headers sent to the clients.\",\"additionalProperties\":false,\"properties\":{\"discardInboundHeaders\":{\"type\":\"boolean\",\"description\":\"Specifies if upstream inbound response, content, and trailing headers should be discarded and not forwarded to the downstream client.\",\"default\":false},\"discardEmpty\":{\"type\":\"boolean\",\"description\":\"Specifies if inbound headers with empty value should be discarded.\",\"default\":false},\"discardUnderscore\":{\"type\":\"boolean\",\"description\":\"Specifies if inbound headers with an underscore in their name should be discarded.\",\"default\":false},\"addServer\":{\"type\":\"boolean\",\"description\":\"Specifies if a `server` header should be added. The value of this header is set to `gwcore`.\",\"default\":false},\"addVia\":{\"type\":\"boolean\",\"description\":\"Specifies if the `via` header should be added to the outbound response.\",\"default\":false},\"cookies\":{\"type\":\"object\",\"description\":\"The options that are applied to the `set-cookie` headers in the inbound upstream response. If the cookie name is symbol '*', then the settings are applied to all `set-cookie` headers.\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"secure\":{\"type\":\"boolean\",\"description\":\"It limits the scope of the cookie to 'secure' channels. A secure cookie is only sent to the server when a request is made using HTTPS.\",\"default\":false},\"httpOnly\":{\"type\":\"boolean\",\"description\":\"It limits the scope of the cookie to HTTP requests, forbidding JavaScript from accessing the cookie.\",\"default\":false},\"sameSite\":{\"type\":\"string\",\"description\":\"It asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks. The valid values are `strict`, `lax`, and `none`.\",\"enum\":[\"none\",\"lax\",\"strict\"],\"default\":\"lax\"},\"domain\":{\"type\":\"string\",\"description\":\"It specifies the hosts to which the cookie will be sent and can be an expression. For example, if the value of the Domain attribute is 'example.com', the user agent will include the cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com. Use this property to specify or override the domain attribute. Set this value to an empty string (\\\"\\\") to remove the domain attribute from the cookie.\",\"examples\":[\"example.com\"]}}}},\"appends\":{\"type\":\"object\",\"description\":\"The headers to be appended to the outbound downstream response. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"The value can be either text or an expression.\"}}},\"overrides\":{\"type\":\"object\",\"description\":\"The headers to be added to the outbound downstream response. If the header already exists, its value is replaced. The value can be either text or an expression.\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"The value can be either text or an expression.\"}}},\"discards\":{\"type\":\"array\",\"description\":\"The inbound upstream headers that should be discarded.\",\"items\":{\"type\":\"string\",\"description\":\"The name of the header to be discarded.\"}}}}}}},\"required\":[\"to\"]}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Cloudtoid GatewayCore Options\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema","id":"https://json.schemastore.org/gatewaycore-options-2021-07","title":"Cloudtoid GatewayCore Options","description":"Root Schema of options for Cloudtoid GatewayCore","type":"object","additionalProperties":false,"properties":{"system":{"type":"object","description":"This section that contains all system wide configurations.","additionalProperties":false,"properties":{"routeCacheMaxCount":{"type":"integer","default":100000,"description":"The maximum number of mappings between \"inbound downstream request path\" and \"outbound upstream request URL\" that can be cached in memory."}}},"routes":{"type":"object","description":"This is the section in which proxy routes are defined.","additionalProperties":{"type":"object","description":"This is the url path pattern that if matched, the request is proxied to the address defined by its `to` property.","additionalProperties":false,"properties":{"proxy":{"type":"object","description":"The proxy configuration.","additionalProperties":false,"properties":{"to":{"type":"string","description":"This is an expression that defines the URL of the upstream server to which the downstream request is forwarded to.","examples":["http://example.com:85/api/"]},"proxyName":{"type":"string","description":"This is an expression that defines the name of this proxy. This value is used in the Via HTTP header send on the outbound upstream request, and the outbound downstream response. If a value is specified, an `x-gwcore-proxy-name` header with this value is also added to the outbound upstream request.","default":"gwcore"},"upstreamRequest":{"type":"object","description":"The options that control the upstream requests.","additionalProperties":false,"properties":{"httpVersion":{"type":"string","description":"An expression that defines the HTTP protocol version of outbound upstream requests.","default":"HTTP/2.0"},"headers":{"type":"object","description":"The options that control the upstream request headers.","additionalProperties":false,"properties":{"discardInboundHeaders":{"type":"boolean","description":"Specifies if downstream inbound request and content headers should be discarded and not forwarded to the upstream.","default":false},"discardEmpty":{"type":"boolean","description":"Specifies if inbound headers with empty value should be discarded.","default":false},"discardUnderscore":{"type":"boolean","description":"Specifies if inbound headers with an underscore in their name should be discarded.","default":false},"addExternalAddress":{"type":"boolean","description":"Specifies if a `x-gwcore-external-address` header with the IP address of the immediate caller should be added to the outbound upstream request.","default":false},"skipVia":{"type":"boolean","description":"Specifies if the `via` header should be skipped from the outbound request.","default":false},"skipForwarded":{"type":"boolean","description":"Specifies if `forwarded` header and `x-forwarded-*` headers should be skipped from the outbound requests.","default":false},"appends":{"type":"object","description":"The headers to be appended to the outbound upstream requests. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.","additionalProperties":{"type":"array","items":{"type":"string","description":"The value can be either text or an expression."}}},"overrides":{"type":"object","description":"The headers to be added to the outbound upstream requests. If the header already exists, its value is replaced. The value can be either text or an expression.","additionalProperties":{"type":"array","items":{"type":"string","description":"The value can be either text or an expression."}}},"discards":{"type":"array","items":{"type":"string","description":"Specifies the inbound downstream headers that should be discarded."}}}},"sender":{"type":"object","description":"The options that control connection to the upstream server.","additionalProperties":false,"properties":{"httpClientName":{"type":"string","description":"The name of the .NET HttpClient that will be used to send the request. The default value is a system generated unique name."},"timeoutInMilliseconds":{"type":["string","integer"],"description":"The total timeout in milliseconds to wait for the outbound upstream request to complete. This can be a number or an expression.","default":240000},"connectTimeoutInMilliseconds":{"type":"integer","description":"The connect timeout in milliseconds. No timeout is set by default."},"expect100ContinueTimeoutInMilliseconds":{"type":"integer","description":"The expect 100 continue timeout in milliseconds.","default":1000},"pooledConnectionIdleTimeoutInMilliseconds":{"type":"integer","description":"Specifies how long a connection can be idle in the pool to be considered reusable.","default":2000},"pooledConnectionLifetimeInMilliseconds":{"type":"integer","description":"Specifies how long a connection can live in the connection pool. By default, no timeout is set and the connection can stay in the pool."},"responseDrainTimeoutInMilliseconds":{"type":"integer","description":"Specifies the response drain timeout.","default":2000},"maxAutomaticRedirections":{"type":"integer","description":"The maximum number of allowed HTTP redirects.","default":50},"maxConnectionsPerServer":{"type":"integer","description":"The maximum number of simultaneous TCP connections allowed to a single server. No caps are set by default."},"maxResponseDrainSizeInBytes":{"type":"integer","description":"The maximum size of data that can be drained from responses in bytes.","default":1048576},"maxResponseHeadersLengthInKilobytes":{"type":"integer","description":"The maximum length, in kilobytes (1024 bytes), of the response headers.","default":64},"allowAutoRedirect":{"type":"boolean","description":"Indicates whether the HTTP handler used by the outbound upstream request sender should follow redirection responses.","default":false},"useCookies":{"type":"boolean","description":"Indicates whether the HTTP handler used by the outbound upstream request sender should store server cookies and use these cookies when sending requests.","default":false}}}}},"downstreamResponse":{"type":"object","description":"The options that control the downstream responses sent to the clients.","additionalProperties":false,"properties":{"headers":{"type":"object","description":"The options that control the downstream response headers sent to the clients.","additionalProperties":false,"properties":{"discardInboundHeaders":{"type":"boolean","description":"Specifies if upstream inbound response, content, and trailing headers should be discarded and not forwarded to the downstream client.","default":false},"discardEmpty":{"type":"boolean","description":"Specifies if inbound headers with empty value should be discarded.","default":false},"discardUnderscore":{"type":"boolean","description":"Specifies if inbound headers with an underscore in their name should be discarded.","default":false},"addServer":{"type":"boolean","description":"Specifies if a `server` header should be added. The value of this header is set to `gwcore`.","default":false},"addVia":{"type":"boolean","description":"Specifies if the `via` header should be added to the outbound response.","default":false},"cookies":{"type":"object","description":"The options that are applied to the `set-cookie` headers in the inbound upstream response. If the cookie name is symbol '*', then the settings are applied to all `set-cookie` headers.","additionalProperties":{"type":"object","properties":{"secure":{"type":"boolean","description":"It limits the scope of the cookie to 'secure' channels. A secure cookie is only sent to the server when a request is made using HTTPS.","default":false},"httpOnly":{"type":"boolean","description":"It limits the scope of the cookie to HTTP requests, forbidding JavaScript from accessing the cookie.","default":false},"sameSite":{"type":"string","description":"It asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks. The valid values are `strict`, `lax`, and `none`.","enum":["none","lax","strict"],"default":"lax"},"domain":{"type":"string","description":"It specifies the hosts to which the cookie will be sent and can be an expression. For example, if the value of the Domain attribute is 'example.com', the user agent will include the cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com. Use this property to specify or override the domain attribute. Set this value to an empty string (\"\") to remove the domain attribute from the cookie.","examples":["example.com"]}}}},"appends":{"type":"object","description":"The headers to be appended to the outbound downstream response. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.","additionalProperties":{"type":"array","items":{"type":"string","description":"The value can be either text or an expression."}}},"overrides":{"type":"object","description":"The headers to be added to the outbound downstream response. If the header already exists, its value is replaced. The value can be either text or an expression.","additionalProperties":{"type":"array","items":{"type":"string","description":"The value can be either text or an expression."}}},"discards":{"type":"array","description":"The inbound upstream headers that should be discarded.","items":{"type":"string","description":"The name of the header to be discarded."}}}}}}},"required":["to"]}}}}}}
|
Provide a JSON object that satisfies the schema "Cloudtoid GatewayCore Options". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Cloudtoid GatewayCore Options
|
schema-store
|
schema_store_7
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"https://spec.openapis.org/oas/3.1/schema/2022-10-07\",\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"description\":\"The description of OpenAPI v3.1.x documents without schema validation, as defined by https://spec.openapis.org/oas/v3.1.0\",\"type\":\"object\",\"properties\":{\"openapi\":{\"type\":\"string\",\"pattern\":\"^3\\\\.1\\\\.\\\\d+(-.+)?$\"},\"info\":{\"$ref\":\"#/$defs/info\"},\"jsonSchemaDialect\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://spec.openapis.org/oas/3.1/dialect/base\"},\"servers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/server\"},\"default\":[{\"url\":\"/\"}]},\"paths\":{\"$ref\":\"#/$defs/paths\"},\"webhooks\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/path-item-or-reference\"}},\"components\":{\"$ref\":\"#/$defs/components\"},\"security\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/security-requirement\"}},\"tags\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/tag\"}},\"externalDocs\":{\"$ref\":\"#/$defs/external-documentation\"}},\"required\":[\"openapi\",\"info\"],\"anyOf\":[{\"required\":[\"paths\"]},{\"required\":[\"components\"]},{\"required\":[\"webhooks\"]}],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false,\"$defs\":{\"info\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#info-object\",\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"termsOfService\":{\"type\":\"string\",\"format\":\"uri\"},\"contact\":{\"$ref\":\"#/$defs/contact\"},\"license\":{\"$ref\":\"#/$defs/license\"},\"version\":{\"type\":\"string\"}},\"required\":[\"title\",\"version\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"contact\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#contact-object\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"url\":{\"type\":\"string\",\"format\":\"uri\"},\"email\":{\"type\":\"string\",\"format\":\"email\"}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"license\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#license-object\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"identifier\":{\"type\":\"string\"},\"url\":{\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"name\"],\"dependentSchemas\":{\"identifier\":{\"not\":{\"required\":[\"url\"]}}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"server\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#server-object\",\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\",\"format\":\"uri-reference\"},\"description\":{\"type\":\"string\"},\"variables\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/server-variable\"}}},\"required\":[\"url\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"server-variable\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#server-variable-object\",\"type\":\"object\",\"properties\":{\"enum\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1},\"default\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"}},\"required\":[\"default\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"components\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#components-object\",\"type\":\"object\",\"properties\":{\"schemas\":{\"type\":\"object\",\"additionalProperties\":{\"$dynamicRef\":\"#meta\"}},\"responses\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/response-or-reference\"}},\"parameters\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/parameter-or-reference\"}},\"examples\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/example-or-reference\"}},\"requestBodies\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/request-body-or-reference\"}},\"headers\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/header-or-reference\"}},\"securitySchemes\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/security-scheme-or-reference\"}},\"links\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/link-or-reference\"}},\"callbacks\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/callbacks-or-reference\"}},\"pathItems\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/path-item-or-reference\"}}},\"patternProperties\":{\"^(schemas|responses|parameters|examples|requestBodies|headers|securitySchemes|links|callbacks|pathItems)$\":{\"$comment\":\"Enumerating all of the property names in the regex above is necessary for unevaluatedProperties to work as expected\",\"propertyNames\":{\"pattern\":\"^[a-zA-Z0-9._-]+$\"}}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"paths\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#paths-object\",\"type\":\"object\",\"patternProperties\":{\"^/\":{\"$ref\":\"#/$defs/path-item\"}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"path-item\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#path-item-object\",\"type\":\"object\",\"properties\":{\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"servers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/server\"}},\"parameters\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/parameter-or-reference\"}},\"get\":{\"$ref\":\"#/$defs/operation\"},\"put\":{\"$ref\":\"#/$defs/operation\"},\"post\":{\"$ref\":\"#/$defs/operation\"},\"delete\":{\"$ref\":\"#/$defs/operation\"},\"options\":{\"$ref\":\"#/$defs/operation\"},\"head\":{\"$ref\":\"#/$defs/operation\"},\"patch\":{\"$ref\":\"#/$defs/operation\"},\"trace\":{\"$ref\":\"#/$defs/operation\"}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"path-item-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/path-item\"}},\"operation\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#operation-object\",\"type\":\"object\",\"properties\":{\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"externalDocs\":{\"$ref\":\"#/$defs/external-documentation\"},\"operationId\":{\"type\":\"string\"},\"parameters\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/parameter-or-reference\"}},\"requestBody\":{\"$ref\":\"#/$defs/request-body-or-reference\"},\"responses\":{\"$ref\":\"#/$defs/responses\"},\"callbacks\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/callbacks-or-reference\"}},\"deprecated\":{\"default\":false,\"type\":\"boolean\"},\"security\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/security-requirement\"}},\"servers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/server\"}}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"external-documentation\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#external-documentation-object\",\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\"},\"url\":{\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"url\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"parameter\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#parameter-object\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"in\":{\"enum\":[\"query\",\"header\",\"path\",\"cookie\"]},\"description\":{\"type\":\"string\"},\"required\":{\"default\":false,\"type\":\"boolean\"},\"deprecated\":{\"default\":false,\"type\":\"boolean\"},\"schema\":{\"$dynamicRef\":\"#meta\"},\"content\":{\"$ref\":\"#/$defs/content\",\"minProperties\":1,\"maxProperties\":1}},\"required\":[\"name\",\"in\"],\"oneOf\":[{\"required\":[\"schema\"]},{\"required\":[\"content\"]}],\"if\":{\"properties\":{\"in\":{\"const\":\"query\"}},\"required\":[\"in\"]},\"then\":{\"properties\":{\"allowEmptyValue\":{\"default\":false,\"type\":\"boolean\"}}},\"dependentSchemas\":{\"schema\":{\"properties\":{\"style\":{\"type\":\"string\"},\"explode\":{\"type\":\"boolean\"}},\"allOf\":[{\"$ref\":\"#/$defs/examples\"},{\"$ref\":\"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-path\"},{\"$ref\":\"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-header\"},{\"$ref\":\"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-query\"},{\"$ref\":\"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-cookie\"},{\"$ref\":\"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-form\"}],\"$defs\":{\"styles-for-path\":{\"if\":{\"properties\":{\"in\":{\"const\":\"path\"}},\"required\":[\"in\"]},\"then\":{\"properties\":{\"name\":{\"pattern\":\"[^/#?]+$\"},\"style\":{\"default\":\"simple\",\"enum\":[\"matrix\",\"label\",\"simple\"]},\"required\":{\"const\":true}},\"required\":[\"required\"]}},\"styles-for-header\":{\"if\":{\"properties\":{\"in\":{\"const\":\"header\"}},\"required\":[\"in\"]},\"then\":{\"properties\":{\"style\":{\"default\":\"simple\",\"const\":\"simple\"}}}},\"styles-for-query\":{\"if\":{\"properties\":{\"in\":{\"const\":\"query\"}},\"required\":[\"in\"]},\"then\":{\"properties\":{\"style\":{\"default\":\"form\",\"enum\":[\"form\",\"spaceDelimited\",\"pipeDelimited\",\"deepObject\"]},\"allowReserved\":{\"default\":false,\"type\":\"boolean\"}}}},\"styles-for-cookie\":{\"if\":{\"properties\":{\"in\":{\"const\":\"cookie\"}},\"required\":[\"in\"]},\"then\":{\"properties\":{\"style\":{\"default\":\"form\",\"const\":\"form\"}}}},\"styles-for-form\":{\"if\":{\"properties\":{\"style\":{\"const\":\"form\"}},\"required\":[\"style\"]},\"then\":{\"properties\":{\"explode\":{\"default\":true}}},\"else\":{\"properties\":{\"explode\":{\"default\":false}}}}}}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"parameter-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/parameter\"}},\"request-body\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#request-body-object\",\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\"},\"content\":{\"$ref\":\"#/$defs/content\"},\"required\":{\"default\":false,\"type\":\"boolean\"}},\"required\":[\"content\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"request-body-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/request-body\"}},\"content\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#fixed-fields-10\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/media-type\"},\"propertyNames\":{\"format\":\"media-range\"}},\"media-type\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#media-type-object\",\"type\":\"object\",\"properties\":{\"schema\":{\"$dynamicRef\":\"#meta\"},\"encoding\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/encoding\"}}},\"allOf\":[{\"$ref\":\"#/$defs/specification-extensions\"},{\"$ref\":\"#/$defs/examples\"}],\"unevaluatedProperties\":false},\"encoding\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#encoding-object\",\"type\":\"object\",\"properties\":{\"contentType\":{\"type\":\"string\",\"format\":\"media-range\"},\"headers\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/header-or-reference\"}},\"style\":{\"default\":\"form\",\"enum\":[\"form\",\"spaceDelimited\",\"pipeDelimited\",\"deepObject\"]},\"explode\":{\"type\":\"boolean\"},\"allowReserved\":{\"default\":false,\"type\":\"boolean\"}},\"allOf\":[{\"$ref\":\"#/$defs/specification-extensions\"},{\"$ref\":\"#/$defs/encoding/$defs/explode-default\"}],\"unevaluatedProperties\":false,\"$defs\":{\"explode-default\":{\"if\":{\"properties\":{\"style\":{\"const\":\"form\"}},\"required\":[\"style\"]},\"then\":{\"properties\":{\"explode\":{\"default\":true}}},\"else\":{\"properties\":{\"explode\":{\"default\":false}}}}}},\"responses\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#responses-object\",\"type\":\"object\",\"properties\":{\"default\":{\"$ref\":\"#/$defs/response-or-reference\"}},\"patternProperties\":{\"^[1-5](?:[0-9]{2}|XX)$\":{\"$ref\":\"#/$defs/response-or-reference\"}},\"minProperties\":1,\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"response\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#response-object\",\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\"},\"headers\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/header-or-reference\"}},\"content\":{\"$ref\":\"#/$defs/content\"},\"links\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/link-or-reference\"}}},\"required\":[\"description\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"response-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/response\"}},\"callbacks\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#callback-object\",\"type\":\"object\",\"$ref\":\"#/$defs/specification-extensions\",\"additionalProperties\":{\"$ref\":\"#/$defs/path-item-or-reference\"}},\"callbacks-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/callbacks\"}},\"example\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#example-object\",\"type\":\"object\",\"properties\":{\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"value\":true,\"externalValue\":{\"type\":\"string\",\"format\":\"uri\"}},\"not\":{\"required\":[\"value\",\"externalValue\"]},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"example-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/example\"}},\"link\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#link-object\",\"type\":\"object\",\"properties\":{\"operationRef\":{\"type\":\"string\",\"format\":\"uri-reference\"},\"operationId\":{\"type\":\"string\"},\"parameters\":{\"$ref\":\"#/$defs/map-of-strings\"},\"requestBody\":true,\"description\":{\"type\":\"string\"},\"body\":{\"$ref\":\"#/$defs/server\"}},\"oneOf\":[{\"required\":[\"operationRef\"]},{\"required\":[\"operationId\"]}],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"link-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/link\"}},\"header\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#header-object\",\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\"},\"required\":{\"default\":false,\"type\":\"boolean\"},\"deprecated\":{\"default\":false,\"type\":\"boolean\"},\"schema\":{\"$dynamicRef\":\"#meta\"},\"content\":{\"$ref\":\"#/$defs/content\",\"minProperties\":1,\"maxProperties\":1}},\"oneOf\":[{\"required\":[\"schema\"]},{\"required\":[\"content\"]}],\"dependentSchemas\":{\"schema\":{\"properties\":{\"style\":{\"default\":\"simple\",\"const\":\"simple\"},\"explode\":{\"default\":false,\"type\":\"boolean\"}},\"$ref\":\"#/$defs/examples\"}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"header-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/header\"}},\"tag\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#tag-object\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"externalDocs\":{\"$ref\":\"#/$defs/external-documentation\"}},\"required\":[\"name\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"reference\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#reference-object\",\"type\":\"object\",\"properties\":{\"$ref\":{\"type\":\"string\",\"format\":\"uri-reference\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"}},\"unevaluatedProperties\":false},\"schema\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#schema-object\",\"$dynamicAnchor\":\"meta\",\"type\":[\"object\",\"boolean\"]},\"security-scheme\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#security-scheme-object\",\"type\":\"object\",\"properties\":{\"type\":{\"enum\":[\"apiKey\",\"http\",\"mutualTLS\",\"oauth2\",\"openIdConnect\"]},\"description\":{\"type\":\"string\"}},\"required\":[\"type\"],\"allOf\":[{\"$ref\":\"#/$defs/specification-extensions\"},{\"$ref\":\"#/$defs/security-scheme/$defs/type-apikey\"},{\"$ref\":\"#/$defs/security-scheme/$defs/type-http\"},{\"$ref\":\"#/$defs/security-scheme/$defs/type-http-bearer\"},{\"$ref\":\"#/$defs/security-scheme/$defs/type-oauth2\"},{\"$ref\":\"#/$defs/security-scheme/$defs/type-oidc\"}],\"unevaluatedProperties\":false,\"$defs\":{\"type-apikey\":{\"if\":{\"properties\":{\"type\":{\"const\":\"apiKey\"}},\"required\":[\"type\"]},\"then\":{\"properties\":{\"name\":{\"type\":\"string\"},\"in\":{\"enum\":[\"query\",\"header\",\"cookie\"]}},\"required\":[\"name\",\"in\"]}},\"type-http\":{\"if\":{\"properties\":{\"type\":{\"const\":\"http\"}},\"required\":[\"type\"]},\"then\":{\"properties\":{\"scheme\":{\"type\":\"string\"}},\"required\":[\"scheme\"]}},\"type-http-bearer\":{\"if\":{\"properties\":{\"type\":{\"const\":\"http\"},\"scheme\":{\"type\":\"string\",\"pattern\":\"^[Bb][Ee][Aa][Rr][Ee][Rr]$\"}},\"required\":[\"type\",\"scheme\"]},\"then\":{\"properties\":{\"bearerFormat\":{\"type\":\"string\"}}}},\"type-oauth2\":{\"if\":{\"properties\":{\"type\":{\"const\":\"oauth2\"}},\"required\":[\"type\"]},\"then\":{\"properties\":{\"flows\":{\"$ref\":\"#/$defs/oauth-flows\"}},\"required\":[\"flows\"]}},\"type-oidc\":{\"if\":{\"properties\":{\"type\":{\"const\":\"openIdConnect\"}},\"required\":[\"type\"]},\"then\":{\"properties\":{\"openIdConnectUrl\":{\"type\":\"string\",\"format\":\"uri\"}},\"required\":[\"openIdConnectUrl\"]}}}},\"security-scheme-or-reference\":{\"if\":{\"type\":\"object\",\"required\":[\"$ref\"]},\"then\":{\"$ref\":\"#/$defs/reference\"},\"else\":{\"$ref\":\"#/$defs/security-scheme\"}},\"oauth-flows\":{\"type\":\"object\",\"properties\":{\"implicit\":{\"$ref\":\"#/$defs/oauth-flows/$defs/implicit\"},\"password\":{\"$ref\":\"#/$defs/oauth-flows/$defs/password\"},\"clientCredentials\":{\"$ref\":\"#/$defs/oauth-flows/$defs/client-credentials\"},\"authorizationCode\":{\"$ref\":\"#/$defs/oauth-flows/$defs/authorization-code\"}},\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false,\"$defs\":{\"implicit\":{\"type\":\"object\",\"properties\":{\"authorizationUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"refreshUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"scopes\":{\"$ref\":\"#/$defs/map-of-strings\"}},\"required\":[\"authorizationUrl\",\"scopes\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"password\":{\"type\":\"object\",\"properties\":{\"tokenUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"refreshUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"scopes\":{\"$ref\":\"#/$defs/map-of-strings\"}},\"required\":[\"tokenUrl\",\"scopes\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"client-credentials\":{\"type\":\"object\",\"properties\":{\"tokenUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"refreshUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"scopes\":{\"$ref\":\"#/$defs/map-of-strings\"}},\"required\":[\"tokenUrl\",\"scopes\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false},\"authorization-code\":{\"type\":\"object\",\"properties\":{\"authorizationUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"tokenUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"refreshUrl\":{\"type\":\"string\",\"format\":\"uri\"},\"scopes\":{\"$ref\":\"#/$defs/map-of-strings\"}},\"required\":[\"authorizationUrl\",\"tokenUrl\",\"scopes\"],\"$ref\":\"#/$defs/specification-extensions\",\"unevaluatedProperties\":false}}},\"security-requirement\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#security-requirement-object\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"specification-extensions\":{\"$comment\":\"https://spec.openapis.org/oas/v3.1.0#specification-extensions\",\"patternProperties\":{\"^x-\":true}},\"examples\":{\"properties\":{\"example\":true,\"examples\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/example-or-reference\"}}}},\"map-of-strings\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"2022-10-07\". Here are the required top‑level fields: openapi, info. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"https://spec.openapis.org/oas/3.1/schema/2022-10-07","$schema":"https://json-schema.org/draft/2020-12/schema","description":"The description of OpenAPI v3.1.x documents without schema validation, as defined by https://spec.openapis.org/oas/v3.1.0","type":"object","properties":{"openapi":{"type":"string","pattern":"^3\\.1\\.\\d+(-.+)?$"},"info":{"$ref":"#/$defs/info"},"jsonSchemaDialect":{"type":"string","format":"uri","default":"https://spec.openapis.org/oas/3.1/dialect/base"},"servers":{"type":"array","items":{"$ref":"#/$defs/server"},"default":[{"url":"/"}]},"paths":{"$ref":"#/$defs/paths"},"webhooks":{"type":"object","additionalProperties":{"$ref":"#/$defs/path-item-or-reference"}},"components":{"$ref":"#/$defs/components"},"security":{"type":"array","items":{"$ref":"#/$defs/security-requirement"}},"tags":{"type":"array","items":{"$ref":"#/$defs/tag"}},"externalDocs":{"$ref":"#/$defs/external-documentation"}},"required":["openapi","info"],"anyOf":[{"required":["paths"]},{"required":["components"]},{"required":["webhooks"]}],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false,"$defs":{"info":{"$comment":"https://spec.openapis.org/oas/v3.1.0#info-object","type":"object","properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"termsOfService":{"type":"string","format":"uri"},"contact":{"$ref":"#/$defs/contact"},"license":{"$ref":"#/$defs/license"},"version":{"type":"string"}},"required":["title","version"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"contact":{"$comment":"https://spec.openapis.org/oas/v3.1.0#contact-object","type":"object","properties":{"name":{"type":"string"},"url":{"type":"string","format":"uri"},"email":{"type":"string","format":"email"}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"license":{"$comment":"https://spec.openapis.org/oas/v3.1.0#license-object","type":"object","properties":{"name":{"type":"string"},"identifier":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["name"],"dependentSchemas":{"identifier":{"not":{"required":["url"]}}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"server":{"$comment":"https://spec.openapis.org/oas/v3.1.0#server-object","type":"object","properties":{"url":{"type":"string","format":"uri-reference"},"description":{"type":"string"},"variables":{"type":"object","additionalProperties":{"$ref":"#/$defs/server-variable"}}},"required":["url"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"server-variable":{"$comment":"https://spec.openapis.org/oas/v3.1.0#server-variable-object","type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"components":{"$comment":"https://spec.openapis.org/oas/v3.1.0#components-object","type":"object","properties":{"schemas":{"type":"object","additionalProperties":{"$dynamicRef":"#meta"}},"responses":{"type":"object","additionalProperties":{"$ref":"#/$defs/response-or-reference"}},"parameters":{"type":"object","additionalProperties":{"$ref":"#/$defs/parameter-or-reference"}},"examples":{"type":"object","additionalProperties":{"$ref":"#/$defs/example-or-reference"}},"requestBodies":{"type":"object","additionalProperties":{"$ref":"#/$defs/request-body-or-reference"}},"headers":{"type":"object","additionalProperties":{"$ref":"#/$defs/header-or-reference"}},"securitySchemes":{"type":"object","additionalProperties":{"$ref":"#/$defs/security-scheme-or-reference"}},"links":{"type":"object","additionalProperties":{"$ref":"#/$defs/link-or-reference"}},"callbacks":{"type":"object","additionalProperties":{"$ref":"#/$defs/callbacks-or-reference"}},"pathItems":{"type":"object","additionalProperties":{"$ref":"#/$defs/path-item-or-reference"}}},"patternProperties":{"^(schemas|responses|parameters|examples|requestBodies|headers|securitySchemes|links|callbacks|pathItems)$":{"$comment":"Enumerating all of the property names in the regex above is necessary for unevaluatedProperties to work as expected","propertyNames":{"pattern":"^[a-zA-Z0-9._-]+$"}}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"paths":{"$comment":"https://spec.openapis.org/oas/v3.1.0#paths-object","type":"object","patternProperties":{"^/":{"$ref":"#/$defs/path-item"}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"path-item":{"$comment":"https://spec.openapis.org/oas/v3.1.0#path-item-object","type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"servers":{"type":"array","items":{"$ref":"#/$defs/server"}},"parameters":{"type":"array","items":{"$ref":"#/$defs/parameter-or-reference"}},"get":{"$ref":"#/$defs/operation"},"put":{"$ref":"#/$defs/operation"},"post":{"$ref":"#/$defs/operation"},"delete":{"$ref":"#/$defs/operation"},"options":{"$ref":"#/$defs/operation"},"head":{"$ref":"#/$defs/operation"},"patch":{"$ref":"#/$defs/operation"},"trace":{"$ref":"#/$defs/operation"}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"path-item-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/path-item"}},"operation":{"$comment":"https://spec.openapis.org/oas/v3.1.0#operation-object","type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"summary":{"type":"string"},"description":{"type":"string"},"externalDocs":{"$ref":"#/$defs/external-documentation"},"operationId":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/$defs/parameter-or-reference"}},"requestBody":{"$ref":"#/$defs/request-body-or-reference"},"responses":{"$ref":"#/$defs/responses"},"callbacks":{"type":"object","additionalProperties":{"$ref":"#/$defs/callbacks-or-reference"}},"deprecated":{"default":false,"type":"boolean"},"security":{"type":"array","items":{"$ref":"#/$defs/security-requirement"}},"servers":{"type":"array","items":{"$ref":"#/$defs/server"}}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"external-documentation":{"$comment":"https://spec.openapis.org/oas/v3.1.0#external-documentation-object","type":"object","properties":{"description":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["url"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"parameter":{"$comment":"https://spec.openapis.org/oas/v3.1.0#parameter-object","type":"object","properties":{"name":{"type":"string"},"in":{"enum":["query","header","path","cookie"]},"description":{"type":"string"},"required":{"default":false,"type":"boolean"},"deprecated":{"default":false,"type":"boolean"},"schema":{"$dynamicRef":"#meta"},"content":{"$ref":"#/$defs/content","minProperties":1,"maxProperties":1}},"required":["name","in"],"oneOf":[{"required":["schema"]},{"required":["content"]}],"if":{"properties":{"in":{"const":"query"}},"required":["in"]},"then":{"properties":{"allowEmptyValue":{"default":false,"type":"boolean"}}},"dependentSchemas":{"schema":{"properties":{"style":{"type":"string"},"explode":{"type":"boolean"}},"allOf":[{"$ref":"#/$defs/examples"},{"$ref":"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-path"},{"$ref":"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-header"},{"$ref":"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-query"},{"$ref":"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-cookie"},{"$ref":"#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-form"}],"$defs":{"styles-for-path":{"if":{"properties":{"in":{"const":"path"}},"required":["in"]},"then":{"properties":{"name":{"pattern":"[^/#?]+$"},"style":{"default":"simple","enum":["matrix","label","simple"]},"required":{"const":true}},"required":["required"]}},"styles-for-header":{"if":{"properties":{"in":{"const":"header"}},"required":["in"]},"then":{"properties":{"style":{"default":"simple","const":"simple"}}}},"styles-for-query":{"if":{"properties":{"in":{"const":"query"}},"required":["in"]},"then":{"properties":{"style":{"default":"form","enum":["form","spaceDelimited","pipeDelimited","deepObject"]},"allowReserved":{"default":false,"type":"boolean"}}}},"styles-for-cookie":{"if":{"properties":{"in":{"const":"cookie"}},"required":["in"]},"then":{"properties":{"style":{"default":"form","const":"form"}}}},"styles-for-form":{"if":{"properties":{"style":{"const":"form"}},"required":["style"]},"then":{"properties":{"explode":{"default":true}}},"else":{"properties":{"explode":{"default":false}}}}}}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"parameter-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/parameter"}},"request-body":{"$comment":"https://spec.openapis.org/oas/v3.1.0#request-body-object","type":"object","properties":{"description":{"type":"string"},"content":{"$ref":"#/$defs/content"},"required":{"default":false,"type":"boolean"}},"required":["content"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"request-body-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/request-body"}},"content":{"$comment":"https://spec.openapis.org/oas/v3.1.0#fixed-fields-10","type":"object","additionalProperties":{"$ref":"#/$defs/media-type"},"propertyNames":{"format":"media-range"}},"media-type":{"$comment":"https://spec.openapis.org/oas/v3.1.0#media-type-object","type":"object","properties":{"schema":{"$dynamicRef":"#meta"},"encoding":{"type":"object","additionalProperties":{"$ref":"#/$defs/encoding"}}},"allOf":[{"$ref":"#/$defs/specification-extensions"},{"$ref":"#/$defs/examples"}],"unevaluatedProperties":false},"encoding":{"$comment":"https://spec.openapis.org/oas/v3.1.0#encoding-object","type":"object","properties":{"contentType":{"type":"string","format":"media-range"},"headers":{"type":"object","additionalProperties":{"$ref":"#/$defs/header-or-reference"}},"style":{"default":"form","enum":["form","spaceDelimited","pipeDelimited","deepObject"]},"explode":{"type":"boolean"},"allowReserved":{"default":false,"type":"boolean"}},"allOf":[{"$ref":"#/$defs/specification-extensions"},{"$ref":"#/$defs/encoding/$defs/explode-default"}],"unevaluatedProperties":false,"$defs":{"explode-default":{"if":{"properties":{"style":{"const":"form"}},"required":["style"]},"then":{"properties":{"explode":{"default":true}}},"else":{"properties":{"explode":{"default":false}}}}}},"responses":{"$comment":"https://spec.openapis.org/oas/v3.1.0#responses-object","type":"object","properties":{"default":{"$ref":"#/$defs/response-or-reference"}},"patternProperties":{"^[1-5](?:[0-9]{2}|XX)$":{"$ref":"#/$defs/response-or-reference"}},"minProperties":1,"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"response":{"$comment":"https://spec.openapis.org/oas/v3.1.0#response-object","type":"object","properties":{"description":{"type":"string"},"headers":{"type":"object","additionalProperties":{"$ref":"#/$defs/header-or-reference"}},"content":{"$ref":"#/$defs/content"},"links":{"type":"object","additionalProperties":{"$ref":"#/$defs/link-or-reference"}}},"required":["description"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"response-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/response"}},"callbacks":{"$comment":"https://spec.openapis.org/oas/v3.1.0#callback-object","type":"object","$ref":"#/$defs/specification-extensions","additionalProperties":{"$ref":"#/$defs/path-item-or-reference"}},"callbacks-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/callbacks"}},"example":{"$comment":"https://spec.openapis.org/oas/v3.1.0#example-object","type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"value":true,"externalValue":{"type":"string","format":"uri"}},"not":{"required":["value","externalValue"]},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"example-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/example"}},"link":{"$comment":"https://spec.openapis.org/oas/v3.1.0#link-object","type":"object","properties":{"operationRef":{"type":"string","format":"uri-reference"},"operationId":{"type":"string"},"parameters":{"$ref":"#/$defs/map-of-strings"},"requestBody":true,"description":{"type":"string"},"body":{"$ref":"#/$defs/server"}},"oneOf":[{"required":["operationRef"]},{"required":["operationId"]}],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"link-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/link"}},"header":{"$comment":"https://spec.openapis.org/oas/v3.1.0#header-object","type":"object","properties":{"description":{"type":"string"},"required":{"default":false,"type":"boolean"},"deprecated":{"default":false,"type":"boolean"},"schema":{"$dynamicRef":"#meta"},"content":{"$ref":"#/$defs/content","minProperties":1,"maxProperties":1}},"oneOf":[{"required":["schema"]},{"required":["content"]}],"dependentSchemas":{"schema":{"properties":{"style":{"default":"simple","const":"simple"},"explode":{"default":false,"type":"boolean"}},"$ref":"#/$defs/examples"}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"header-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/header"}},"tag":{"$comment":"https://spec.openapis.org/oas/v3.1.0#tag-object","type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"externalDocs":{"$ref":"#/$defs/external-documentation"}},"required":["name"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"reference":{"$comment":"https://spec.openapis.org/oas/v3.1.0#reference-object","type":"object","properties":{"$ref":{"type":"string","format":"uri-reference"},"summary":{"type":"string"},"description":{"type":"string"}},"unevaluatedProperties":false},"schema":{"$comment":"https://spec.openapis.org/oas/v3.1.0#schema-object","$dynamicAnchor":"meta","type":["object","boolean"]},"security-scheme":{"$comment":"https://spec.openapis.org/oas/v3.1.0#security-scheme-object","type":"object","properties":{"type":{"enum":["apiKey","http","mutualTLS","oauth2","openIdConnect"]},"description":{"type":"string"}},"required":["type"],"allOf":[{"$ref":"#/$defs/specification-extensions"},{"$ref":"#/$defs/security-scheme/$defs/type-apikey"},{"$ref":"#/$defs/security-scheme/$defs/type-http"},{"$ref":"#/$defs/security-scheme/$defs/type-http-bearer"},{"$ref":"#/$defs/security-scheme/$defs/type-oauth2"},{"$ref":"#/$defs/security-scheme/$defs/type-oidc"}],"unevaluatedProperties":false,"$defs":{"type-apikey":{"if":{"properties":{"type":{"const":"apiKey"}},"required":["type"]},"then":{"properties":{"name":{"type":"string"},"in":{"enum":["query","header","cookie"]}},"required":["name","in"]}},"type-http":{"if":{"properties":{"type":{"const":"http"}},"required":["type"]},"then":{"properties":{"scheme":{"type":"string"}},"required":["scheme"]}},"type-http-bearer":{"if":{"properties":{"type":{"const":"http"},"scheme":{"type":"string","pattern":"^[Bb][Ee][Aa][Rr][Ee][Rr]$"}},"required":["type","scheme"]},"then":{"properties":{"bearerFormat":{"type":"string"}}}},"type-oauth2":{"if":{"properties":{"type":{"const":"oauth2"}},"required":["type"]},"then":{"properties":{"flows":{"$ref":"#/$defs/oauth-flows"}},"required":["flows"]}},"type-oidc":{"if":{"properties":{"type":{"const":"openIdConnect"}},"required":["type"]},"then":{"properties":{"openIdConnectUrl":{"type":"string","format":"uri"}},"required":["openIdConnectUrl"]}}}},"security-scheme-or-reference":{"if":{"type":"object","required":["$ref"]},"then":{"$ref":"#/$defs/reference"},"else":{"$ref":"#/$defs/security-scheme"}},"oauth-flows":{"type":"object","properties":{"implicit":{"$ref":"#/$defs/oauth-flows/$defs/implicit"},"password":{"$ref":"#/$defs/oauth-flows/$defs/password"},"clientCredentials":{"$ref":"#/$defs/oauth-flows/$defs/client-credentials"},"authorizationCode":{"$ref":"#/$defs/oauth-flows/$defs/authorization-code"}},"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false,"$defs":{"implicit":{"type":"object","properties":{"authorizationUrl":{"type":"string","format":"uri"},"refreshUrl":{"type":"string","format":"uri"},"scopes":{"$ref":"#/$defs/map-of-strings"}},"required":["authorizationUrl","scopes"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"password":{"type":"object","properties":{"tokenUrl":{"type":"string","format":"uri"},"refreshUrl":{"type":"string","format":"uri"},"scopes":{"$ref":"#/$defs/map-of-strings"}},"required":["tokenUrl","scopes"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"client-credentials":{"type":"object","properties":{"tokenUrl":{"type":"string","format":"uri"},"refreshUrl":{"type":"string","format":"uri"},"scopes":{"$ref":"#/$defs/map-of-strings"}},"required":["tokenUrl","scopes"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false},"authorization-code":{"type":"object","properties":{"authorizationUrl":{"type":"string","format":"uri"},"tokenUrl":{"type":"string","format":"uri"},"refreshUrl":{"type":"string","format":"uri"},"scopes":{"$ref":"#/$defs/map-of-strings"}},"required":["authorizationUrl","tokenUrl","scopes"],"$ref":"#/$defs/specification-extensions","unevaluatedProperties":false}}},"security-requirement":{"$comment":"https://spec.openapis.org/oas/v3.1.0#security-requirement-object","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"specification-extensions":{"$comment":"https://spec.openapis.org/oas/v3.1.0#specification-extensions","patternProperties":{"^x-":true}},"examples":{"properties":{"example":true,"examples":{"type":"object","additionalProperties":{"$ref":"#/$defs/example-or-reference"}}}},"map-of-strings":{"type":"object","additionalProperties":{"type":"string"}}}}
|
Provide a JSON object that satisfies the schema "2022-10-07". Here are the required top‑level fields: openapi, info. Return only the valid JSON object.
|
2022-10-07
|
schema-store
|
schema_store_8
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"https://raw.githubusercontent.com/roadrunner-server/roadrunner/refs/heads/master/schemas/config/3.0.schema.json\",\"$schema\":\"https://json-schema.org/draft/2019-09/schema\",\"title\":\"RoadRunner Main Configuration File\",\"description\":\"This is your main RoadRunner configuration file. It should contain all the plugins you want to load and their configuration.\",\"type\":\"object\",\"required\":[\"version\"],\"properties\":{\"version\":{\"description\":\"RoadRunner configuration file version.\",\"type\":\"string\",\"default\":\"3\",\"enum\":[\"3\"]},\"amqp\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/amqp/refs/heads/master/schema.json#/definitions/driver\"},\"beanstalk\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/beanstalk/refs/heads/master/schema.json#/definitions/driver\"},\"centrifuge\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/centrifuge/refs/heads/master/schema.json\"},\"fileserver\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/fileserver/refs/heads/master/schema.json\"},\"grpc\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/grpc/refs/heads/master/schema.json\"},\"http\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json\"},\"jobs\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/jobs/refs/heads/master/schema.json\"},\"kafka\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/kafka/refs/heads/master/schema.json#/definitions/driver\"},\"kv\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/kv/refs/heads/master/schema.json\"},\"logs\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/logger/refs/heads/master/schema.json\"},\"metrics\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/metrics/refs/heads/master/schema.json\"},\"nats\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/nats/refs/heads/master/schema.json#/definitions/driver\"},\"otel\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/otel/refs/heads/master/schema.json\"},\"redis\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/redis/refs/heads/master/schema.json\"},\"rpc\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/rpc/refs/heads/master/schema.json\"},\"server\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/server/refs/heads/master/schema.json\"},\"service\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/service/refs/heads/master/schema.json\"},\"status\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/status/refs/heads/master/schema.json\"},\"sqs\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/sqs/refs/heads/master/schema.json#/definitions/driver\"},\"temporal\":{\"$ref\":\"https://raw.githubusercontent.com/temporalio/roadrunner-temporal/refs/heads/master/schema.json\"},\"tcp\":{\"$ref\":\"https://raw.githubusercontent.com/roadrunner-server/tcp/refs/heads/master/schema.json\"}},\"definitions\":{\"Duration\":{\"description\":\"Time duration\",\"type\":\"string\",\"pattern\":\"^([0-9]*(\\\\.[0-9]*)?(ms|h|m|s))+$\",\"examples\":[\"1h\",\"2.5h\",\"2m\",\".2m\",\"30s\",\"30.03s\",\"300ms\",\"1h3m40s500ms\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"RoadRunner Main Configuration File\". Here are the required top‑level fields: version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"https://raw.githubusercontent.com/roadrunner-server/roadrunner/refs/heads/master/schemas/config/3.0.schema.json","$schema":"https://json-schema.org/draft/2019-09/schema","title":"RoadRunner Main Configuration File","description":"This is your main RoadRunner configuration file. It should contain all the plugins you want to load and their configuration.","type":"object","required":["version"],"properties":{"version":{"description":"RoadRunner configuration file version.","type":"string","default":"3","enum":["3"]},"amqp":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/amqp/refs/heads/master/schema.json#/definitions/driver"},"beanstalk":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/beanstalk/refs/heads/master/schema.json#/definitions/driver"},"centrifuge":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/centrifuge/refs/heads/master/schema.json"},"fileserver":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/fileserver/refs/heads/master/schema.json"},"grpc":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/grpc/refs/heads/master/schema.json"},"http":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/http/refs/heads/master/schema.json"},"jobs":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/jobs/refs/heads/master/schema.json"},"kafka":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/kafka/refs/heads/master/schema.json#/definitions/driver"},"kv":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/kv/refs/heads/master/schema.json"},"logs":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/logger/refs/heads/master/schema.json"},"metrics":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/metrics/refs/heads/master/schema.json"},"nats":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/nats/refs/heads/master/schema.json#/definitions/driver"},"otel":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/otel/refs/heads/master/schema.json"},"redis":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/redis/refs/heads/master/schema.json"},"rpc":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/rpc/refs/heads/master/schema.json"},"server":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/server/refs/heads/master/schema.json"},"service":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/service/refs/heads/master/schema.json"},"status":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/status/refs/heads/master/schema.json"},"sqs":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/sqs/refs/heads/master/schema.json#/definitions/driver"},"temporal":{"$ref":"https://raw.githubusercontent.com/temporalio/roadrunner-temporal/refs/heads/master/schema.json"},"tcp":{"$ref":"https://raw.githubusercontent.com/roadrunner-server/tcp/refs/heads/master/schema.json"}},"definitions":{"Duration":{"description":"Time duration","type":"string","pattern":"^([0-9]*(\\.[0-9]*)?(ms|h|m|s))+$","examples":["1h","2.5h","2m",".2m","30s","30.03s","300ms","1h3m40s500ms"]}}}
|
Provide a JSON object that satisfies the schema "RoadRunner Main Configuration File". Here are the required top‑level fields: version. Return only the valid JSON object.
|
RoadRunner Main Configuration File
|
schema-store
|
schema_store_9
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"openapi\":\"3.0.2\",\"components\":{\"parameters\":{\"$filter\":{\"name\":\"$filter\",\"in\":\"query\",\"description\":\"\\n An OData filter\\n\\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter\\n \",\"schema\":{\"type\":\"string\"}},\"$orderby\":{\"name\":\"$orderby\",\"in\":\"query\",\"description\":\"\\n An OData query option to fetch ordered data\\n\\n https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby\\n \",\"schema\":{\"type\":\"string\"}},\"$own\":{\"name\":\"$own\",\"schema\":{\"type\":\"boolean\"},\"description\":\"If only the resources created by the authenticated app member should be included\",\"in\":\"query\"},\"$select\":{\"name\":\"$select\",\"in\":\"query\",\"description\":\"\\n The OData `$select` query option.\\n\\n This is a comma separated string of fields to select. Only filtering flat properties is\\n supported.\\n\\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect\\n \",\"schema\":{\"type\":\"string\"}},\"$skip\":{\"name\":\"$skip\",\"in\":\"query\",\"description\":\"Start the query from an offset.\",\"schema\":{\"type\":\"integer\",\"minimum\":0}},\"$top\":{\"name\":\"$top\",\"in\":\"query\",\"description\":\"Limit the number of entities returned.\",\"schema\":{\"type\":\"integer\",\"minimum\":0}},\"appId\":{\"name\":\"appId\",\"in\":\"path\",\"description\":\"The ID of the app on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/App/properties/id\"}},\"appMemberId\":{\"name\":\"memberId\",\"in\":\"path\",\"description\":\"The id of the app member on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppMember/properties/id\"}},\"appOAuth2SecretId\":{\"name\":\"appOAuth2SecretId\",\"in\":\"path\",\"description\":\"The ID of the app OAuth2 secret on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret/properties/id\"}},\"appSamlSecretId\":{\"name\":\"appSamlSecretId\",\"in\":\"path\",\"description\":\"The ID of the app SAML secret on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}},\"appVariableId\":{\"name\":\"appVariableId\",\"in\":\"path\",\"description\":\"The id of the app variable on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}},\"assetId\":{\"name\":\"assetId\",\"in\":\"path\",\"description\":\"The ID of the asset on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/Asset/properties/id\"}},\"blockId\":{\"name\":\"blockId\",\"in\":\"path\",\"description\":\"The ID of the block on which to perform an operation, but without the organization scope.\",\"required\":true,\"schema\":{\"type\":\"string\",\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\"}},\"blockVersion\":{\"name\":\"blockVersion\",\"in\":\"path\",\"description\":\"The version of the block on which to perform an operation.\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/BlockVersion/properties/version\"}},\"delimiter\":{\"name\":\"delimiter\",\"in\":\"query\",\"description\":\"\\nDelimiter to be used to parse the CSV file\\n \",\"schema\":{\"type\":\"string\"}},\"endpoint\":{\"name\":\"endpoint\",\"in\":\"query\",\"description\":\"The URL of the endpoint associated with the subscription.\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uri\"}},\"groupId\":{\"name\":\"groupId\",\"in\":\"path\",\"description\":\"The ID of the group on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"number\"}},\"groupMemberId\":{\"name\":\"groupMemberId\",\"in\":\"path\",\"description\":\"The id of the group member on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppMember/properties/id\"}},\"language\":{\"name\":\"language\",\"in\":\"path\",\"description\":\"The language on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}},\"organizationId\":{\"name\":\"organizationId\",\"required\":true,\"in\":\"path\",\"description\":\"The ID of the organization on which to perform an operation\",\"schema\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"}},\"readmeId\":{\"name\":\"readmeId\",\"in\":\"path\",\"description\":\"The id of an app readme\",\"required\":true,\"schema\":{\"type\":\"number\"}},\"resourceId\":{\"name\":\"resourceId\",\"in\":\"path\",\"description\":\"The ID of the resource on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/Resource/properties/id\"}},\"resourceType\":{\"name\":\"resourceType\",\"in\":\"path\",\"description\":\"The type of the resource on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}},\"roles\":{\"name\":\"roles\",\"in\":\"query\",\"description\":\"The roles of app members on which to perform an operation\",\"schema\":{\"type\":\"string\"}},\"screenshotId\":{\"name\":\"screenshotId\",\"in\":\"path\",\"description\":\"The id of an app screenshot\",\"required\":true,\"schema\":{\"type\":\"number\"}},\"seed\":{\"name\":\"seed\",\"in\":\"query\",\"description\":\"\\n Whether the resources or assets are seed instead.\\n \",\"schema\":{\"type\":\"string\"}},\"selectedGroupId\":{\"name\":\"selectedGroupId\",\"in\":\"query\",\"description\":\"The currently selected group of the app member.\",\"schema\":{\"type\":\"number\"}},\"serviceSecretId\":{\"name\":\"serviceSecretId\",\"in\":\"path\",\"description\":\"The id of the app service secret on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}},\"trainingId\":{\"name\":\"trainingId\",\"in\":\"path\",\"description\":\"Id of the training on which the operation will be performed.\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/Training/properties/id\"}},\"view\":{\"name\":\"view\",\"in\":\"query\",\"description\":\"The view of the resource to fetch.\",\"schema\":{\"type\":\"string\"}},\"webhookName\":{\"name\":\"webhookName\",\"in\":\"path\",\"description\":\"The name of the webhook to call\",\"required\":true,\"schema\":{\"type\":\"string\"}},\"webhookSecretId\":{\"name\":\"webhookSecretId\",\"in\":\"path\",\"description\":\"The id of the app webhook secret on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}}},\"requestBodies\":{\"oauth2Consent\":{\"description\":\"The OAuth2 client credentials\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"redirectUri\",\"scope\"],\"description\":\"A representation of a user\\u2019s OAuth2 consent when logging in to an app.\",\"additionalProperties\":false,\"properties\":{\"redirectUri\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The URI to redirect the user back to.\"},\"scope\":{\"type\":\"string\",\"description\":\"The OAuth2 scope requested by the app.\"}}}}}},\"resource\":{\"description\":\"A resource definition\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Resource\"}},\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"required\":[\"resource\"],\"description\":\"A `multipart/form-data` representation of a resource.\",\"additionalProperties\":false,\"properties\":{\"resource\":{\"$ref\":\"#/components/schemas/Resource\"},\"assets\":{\"type\":\"array\",\"description\":\"A list of assets that should be linked to the resource.\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}}}}}}},\"user\":{\"description\":\"A user profile\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserInfo\"}}}}},\"responses\":{\"app\":{\"description\":\"An app response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/App\"}}}},\"blockVersion\":{\"description\":\"A block definition response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/BlockVersion\"}}}},\"default\":{\"description\":\"The default error response.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}},\"invite\":{\"description\":\"An invite response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Organization\"}}}},\"oauth2AuthorizationCode\":{\"description\":\"An OAuth2 authorization code.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/App\"}}}},\"organization\":{\"description\":\"An organization response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Organization\"}}}},\"resource\":{\"description\":\"A resource response\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Resource\"}},\"text/csv\":{\"schema\":{\"type\":\"string\"}}}},\"subscriptions\":{\"description\":\"A subscription response.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"description\":\"A mapping of resources names to resource subscriptions.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/ResourceSubscription\"}}}}}},\"schemas\":{\"ActionDefinition\":{\"allOf\":[{\"type\":\"object\",\"description\":\"The base properties of an action definition.\",\"additionalProperties\":true,\"properties\":{\"remapBefore\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"This may be used to remap data before it is passed into the action function.\"},\"remapAfter\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"This may be used to remap data after it is passed into the action function.\"},\"onSuccess\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"Another action that is dispatched when the action has been dispatched successfully.\"},\"onError\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"Another action that is dispatched when the action has failed to dispatch successfully.\"}}},{\"anyOf\":[{\"$ref\":\"#/components/schemas/AnalyticsActionDefinition\"},{\"$ref\":\"#/components/schemas/ControllerActionDefinition\"},{\"$ref\":\"#/components/schemas/ConditionActionDefinition\"},{\"$ref\":\"#/components/schemas/CsvParseActionDefinition\"},{\"$ref\":\"#/components/schemas/DialogActionDefinition\"},{\"$ref\":\"#/components/schemas/DialogErrorActionDefinition\"},{\"$ref\":\"#/components/schemas/DialogOkActionDefinition\"},{\"$ref\":\"#/components/schemas/DownloadActionDefinition\"},{\"$ref\":\"#/components/schemas/EachActionDefinition\"},{\"$ref\":\"#/components/schemas/EmailActionDefinition\"},{\"$ref\":\"#/components/schemas/EventActionDefinition\"},{\"$ref\":\"#/components/schemas/FlowBackActionDefinition\"},{\"$ref\":\"#/components/schemas/FlowFinishActionDefinition\"},{\"$ref\":\"#/components/schemas/FlowNextActionDefinition\"},{\"$ref\":\"#/components/schemas/FlowCancelActionDefinition\"},{\"$ref\":\"#/components/schemas/FlowToActionDefinition\"},{\"$ref\":\"#/components/schemas/LinkActionDefinition\"},{\"$ref\":\"#/components/schemas/LinkBackActionDefinition\"},{\"$ref\":\"#/components/schemas/LinkNextActionDefinition\"},{\"$ref\":\"#/components/schemas/LogActionDefinition\"},{\"$ref\":\"#/components/schemas/MatchActionDefinition\"},{\"$ref\":\"#/components/schemas/MessageActionDefinition\"},{\"$ref\":\"#/components/schemas/NoopActionDefinition\"},{\"$ref\":\"#/components/schemas/NotifyActionDefinition\"},{\"$ref\":\"#/components/schemas/RequestActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceCountActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceCreateActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceDeleteActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceDeleteAllActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceDeleteBulkActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceGetActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceHistoryGetActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceQueryActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceSubscriptionStatusActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceSubscriptionSubscribeActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceSubscriptionToggleActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceUpdateActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourceUpdatePositionsActionDefinition\"},{\"$ref\":\"#/components/schemas/ResourcePatchActionDefinition\"},{\"$ref\":\"#/components/schemas/ShareActionDefinition\"},{\"$ref\":\"#/components/schemas/StaticActionDefinition\"},{\"$ref\":\"#/components/schemas/StorageAppendActionDefinition\"},{\"$ref\":\"#/components/schemas/StorageSubtractActionDefinition\"},{\"$ref\":\"#/components/schemas/StorageReadActionDefinition\"},{\"$ref\":\"#/components/schemas/StorageWriteActionDefinition\"},{\"$ref\":\"#/components/schemas/StorageUpdateActionDefinition\"},{\"$ref\":\"#/components/schemas/StorageDeleteActionDefinition\"},{\"$ref\":\"#/components/schemas/GroupMemberInviteActionDefinition\"},{\"$ref\":\"#/components/schemas/GroupMemberQueryActionDefinition\"},{\"$ref\":\"#/components/schemas/GroupMemberDeleteActionDefinition\"},{\"$ref\":\"#/components/schemas/GroupMemberRoleUpdateActionDefinition\"},{\"$ref\":\"#/components/schemas/GroupQueryActionDefinition\"},{\"$ref\":\"#/components/schemas/ThrowActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberLoginActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberLogoutActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberRegisterActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberInviteActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberRoleUpdateActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberCurrentPatchActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberPropertiesPatchActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberQueryActionDefinition\"},{\"$ref\":\"#/components/schemas/AppMemberDeleteActionDefinition\"}]}]},\"AnalyticsActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"target\"],\"properties\":{\"type\":{\"enum\":[\"analytics\"],\"description\":\"This action sends a Google Analytics event.\\n\\nIt returns the input data.\\n\"},\"target\":{\"type\":\"string\",\"description\":\"The name of the analytics target event to send.\"},\"config\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper whose result will be sent to Google Analytics as additional context\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"App\":{\"type\":\"object\",\"description\":\"An app definition defines what an app will look like.\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"number\",\"minimum\":0,\"readOnly\":true,\"description\":\"The unique identifier for the app.\\n\\nThis value will be generated automatically by the API.\\n\"},\"OrganizationId\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"},\"path\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":41,\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"description\":\"The URL path segment on which this app is reachable.\\n\\nThis may only contain lower case characters, numbers, and hyphens. By default this is a\\nnormalized version of the app name.\\n\"},\"domain\":{\"anyOf\":[{\"type\":\"string\",\"maxLength\":0},{\"type\":\"string\",\"format\":\"hostname\"}],\"description\":\"The domain name on which this app should be served.\\n\\nIf this is unspecified, the app will be served from the path on the domain of the server\\n`HOSTNAME` variable.\\n\"},\"visibility\":{\"description\":\"Determine the app visibility of the app in the Appsemble app store.\\n\\nThis doesn\\u2019t affect whether or not the app can be accessed on its own domain.\\n\\n- **public**: The app is publicly listed in the Appsemble app store.\\n- **unlisted**: The app store page can be accessed, but the app isn\\u2019t listed publicly in the\\n Appsemble app store.\\n- **private**: The app is only visible to people who are part of the organization.\\n\",\"default\":\"unlisted\",\"enum\":[\"public\",\"unlisted\",\"private\"]},\"showAppDefinition\":{\"type\":\"boolean\",\"description\":\"Whether or not people who have access to the app may see the app definition.\"},\"locked\":{\"enum\":[\"fullLock\",\"studioLock\",\"unlocked\"],\"default\":\"unlocked\",\"description\":\"Determines whether this app should be locked from being updated.\\n If this is set to `fullLock`, no changes can be made to the app,\\n if this is set to `studioLock`, no changes can be made from the studio but updating from the CLI is possible,\\n and to make any changes from the studio, this should be set to `unlocked`.\\n\"},\"displayAppMemberName\":{\"type\":\"boolean\",\"description\":\"Whether to display app member name in the title bar.\"},\"displayInstallationPrompt\":{\"type\":\"boolean\",\"description\":\"Whether to display installtion prompt to the users of app\"},\"template\":{\"type\":\"boolean\",\"description\":\"Determines whether this app should be included when fetching for templates.\"},\"demoMode\":{\"type\":\"boolean\",\"description\":\"Determines whether this app should be used in demo mode.\"},\"longDescription\":{\"type\":\"string\",\"description\":\"\\nA long description for the app.\\n\\nThe long description will be rendered on the app details page. Markdown content is supported.\\n\"},\"definition\":{\"$ref\":\"#/components/schemas/AppDefinition\"},\"screenshotUrls\":{\"type\":\"array\",\"description\":\"A list of URLs referencing app screenshots\",\"items\":{\"type\":\"string\"}},\"googleAnalyticsID\":{\"type\":\"string\",\"description\":\"If this is specified, Google analytics will be applied to the app\",\"pattern\":\"^(|UA-\\\\d{4,10}-\\\\d{1,4}|G-[\\\\dA-Z]{4,})$\"},\"sentryDsn\":{\"type\":\"string\",\"description\":\"The Sentry DSN to use for this app.\\n\\nIf this is specified, the given Sentry DSN will be used for error tracking. Apps without a custom\\ndomain fall back to use the Appsemble server Sentry DSN.\\n\",\"format\":\"url\"},\"sentryEnvironment\":{\"type\":\"string\",\"description\":\"The name that should be used as the sentry environment.\\n\\n This is only applied when `sentryDsn` is specified.\"},\"controllerCode\":{\"type\":\"string\",\"description\":\"Custom app logic as a JavaScript string\"},\"controllerImplementations\":{\"type\":\"string\",\"description\":\"Appsemble SDK interfaces implementations\"}}},\"AppAccount\":{\"type\":\"object\",\"description\":\"An object representing a member of an app\",\"additionalProperties\":false,\"properties\":{\"app\":{\"$ref\":\"#/components/schemas/App\",\"description\":\"The app this account is for.\"},\"appMemberInfo\":{\"$ref\":\"#/components/schemas/AppMemberInfo\",\"description\":\"The app member info.\"},\"sso\":{\"type\":\"array\",\"description\":\"The single sign on configurations which link the user to an external account.\",\"items\":{\"$ref\":\"#/components/schemas/SSOConfiguration\"}}}},\"AppCollection\":{\"type\":\"object\",\"description\":\"An app collection\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"integer\",\"readOnly\":true,\"description\":\"The unique ID of the app collection.\"},\"name\":{\"type\":\"string\",\"description\":\"The name of the app collection.\"},\"OrganizationId\":{\"type\":\"string\",\"description\":\"The ID of the organization that owns the app collection.\"},\"OrganizationName\":{\"type\":\"string\",\"description\":\"The name of the organization that owns the app collection.\"},\"visibility\":{\"enum\":[\"private\",\"public\"],\"description\":\"The visibility of the app collection.\"},\"$expert\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"The app collection\\u2019s expert/curator.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the expert.\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the expert.\"},\"profileImage\":{\"type\":\"string\",\"description\":\"The URL at which the expert\\u2019s profile image can be found.\"}}},\"headerImage\":{\"type\":\"string\",\"description\":\"The URL at which the app collection\\u2019s header image can be found.\"},\"$created\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"When the collection was first created as an ISO 8601 formatted string\"},\"$updated\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"When the collection was last updated as an ISO 8601 formatted string\"}}},\"AppCollectionDefinition\":{\"type\":\"object\",\"description\":\"An app collection\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the app collection.\",\"minLength\":1,\"maxLength\":30},\"visibility\":{\"enum\":[\"private\",\"public\"],\"description\":\"The visibility of the app collection.\"},\"expertName\":{\"type\":\"string\",\"description\":\"The name of the app collection\\u2019s expert/curator.\",\"minLength\":1,\"maxLength\":30},\"expertDescription\":{\"type\":\"string\",\"description\":\"The description of the app collection\\u2019s expert/curator.\",\"maxLength\":4000},\"expertProfileImage\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The profile image of the app collection\\u2019s expert/curator.\"},\"headerImage\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The header image of the app collection.\"},\"domain\":{\"anyOf\":[{\"type\":\"string\",\"maxLength\":0},{\"type\":\"string\",\"format\":\"hostname\",\"maxLength\":253}]}}},\"AppDefinition\":{\"type\":\"object\",\"required\":[\"name\",\"defaultPage\",\"pages\"],\"additionalProperties\":false,\"description\":\"An app definition describes what an Appsemble app looks like.\",\"properties\":{\"name\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":30,\"description\":\"The human readable name of the app.\\n\\nThis will be displayed for example on the home screen or in the browser tab.\\n\"},\"description\":{\"type\":\"string\",\"maxLength\":80,\"description\":\"A short description describing the app.\\n\\nThis will be displayed on the app store.\\n\"},\"layout\":{\"$ref\":\"#/components/schemas/AppLayoutDefinition\",\"description\":\"Properties related to the layout of the app.\"},\"notifications\":{\"enum\":[\"login\",\"opt-in\",\"startup\"],\"description\":\"The strategy to use for apps to subscribe to push notifications.\\n\\nIf specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the\\napp details page in Appsemble Studio. Setting this to `opt-in` allows for users to opt into\\nreceiving push notifications by pressing the subscribe button in the App settings page. Setting this\\nto `startup` will cause Appsemble to immediately request for the permission upon opening the app.\\nIf this is set to `login`, the app will request permissions for push notification once the user\\nlogs in.\\n\\n> **Note**: Setting `notifications` to `startup` is not recommended, due to its invasive nature.\\n\"},\"defaultPage\":{\"type\":\"string\",\"description\":\"The name of the page that should be displayed when the app is initially loaded.\\n\\nThis **must** match the name of a page defined for the app.\\n\"},\"defaultLanguage\":{\"type\":\"string\",\"default\":\"en\",\"minLength\":2,\"description\":\"The default language for the app.\"},\"controller\":{\"$ref\":\"#/components/schemas/ControllerDefinition\"},\"members\":{\"$ref\":\"#/components/schemas/AppMembersDefinition\"},\"resources\":{\"type\":\"object\",\"description\":\"Resources define how Appsemble can store data for an app.\\n\\nThe most basic resource has a `schema` property and defines the minimal security rules.\\n\",\"additionalProperties\":{\"description\":\"A single resource definition.\",\"$ref\":\"#/components/schemas/ResourceDefinition\"}},\"security\":{\"$ref\":\"#/components/schemas/SecurityDefinition\",\"description\":\"Role and guest definitions that may be used by the app.\"},\"pages\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The pages of the app.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/PageDefinition\"},{\"$ref\":\"#/components/schemas/TabsPageDefinition\"},{\"$ref\":\"#/components/schemas/FlowPageDefinition\"},{\"$ref\":\"#/components/schemas/LoopPageDefinition\"},{\"$ref\":\"#/components/schemas/ContainerPageDefinition\"}]}},\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"cron\":{\"type\":\"object\",\"minProperties\":1,\"description\":\"A list of cron jobs that are associated with this app.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/CronDefinition\"}},\"webhooks\":{\"type\":\"object\",\"minProperties\":1,\"description\":\"A list of callable webhooks that are associated with this app.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/WebhookDefinition\"}},\"anchors\":{\"type\":\"array\",\"minItems\":1,\"description\":\"Helper property that can be used to store YAML anchors.\",\"items\":{}},\"containers\":{\"type\":\"array\",\"minItems\":1,\"additionalProperties\":false,\"description\":\"Definition of the companion containers to be created.\",\"items\":{\"$ref\":\"#/components/schemas/ContainerDefinition\"}},\"registry\":{\"type\":\"string\",\"default\":null,\"description\":\"The default registry used to pull images for companion containers.\"}}},\"AppLayoutDefinition\":{\"type\":\"object\",\"description\":\"The layout definition allows you to tweak several layout elements of the app.\",\"additionalProperties\":false,\"minProperties\":1,\"properties\":{\"login\":{\"enum\":[\"navbar\",\"navigation\",\"hidden\"],\"default\":\"navbar\",\"description\":\"The location of the login button.\"},\"settings\":{\"enum\":[\"navbar\",\"navigation\",\"hidden\"],\"default\":\"navbar\",\"description\":\"The location of the settings button.\\n\\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\\n\"},\"feedback\":{\"enum\":[\"navbar\",\"navigation\",\"hidden\"],\"default\":\"navigation\",\"description\":\"The location of the feedback button.\\n\\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\\n\"},\"install\":{\"enum\":[\"navbar\",\"navigation\",\"hidden\"],\"default\":\"navigation\",\"description\":\"The location of the install button.\\n\\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\\n\"},\"navigation\":{\"enum\":[\"bottom\",\"left-menu\",\"hidden\"],\"default\":\"left-menu\",\"description\":\"The navigation type to use.\\n\\nIf this is omitted, a collapsable side navigation menu will be rendered on the left.\\n\"}}},\"AppMember\":{\"type\":\"object\",\"description\":\"An object representing a member of an app\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The id of the app member.\"},\"role\":{\"type\":\"string\",\"description\":\"The role of the app member within the app.\"},\"name\":{\"type\":\"string\",\"description\":\"The full name of the app member.\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The email address of the app member.\"}}},\"AppMemberCurrentPatchActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"app.member.current.patch\"],\"description\":\"Allows the app member to patch their own app member account.\\n\\nDoes nothing if the app member isn\\u2019t logged in.\"},\"name\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The new full name of the app member.\"},\"properties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The updated custom properties for the app member.\\n\\nValues will be validated based on `members.properties`, if defined in the app definition.\"},\"picture\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The picture for the patched app member\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberDeleteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"sub\"],\"properties\":{\"type\":{\"enum\":[\"app.member.delete\"],\"description\":\"Allows the app member to delete another app member.\\n\\nDoes nothing if the app member isn\\u2019t logged in.\"},\"sub\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The id of the app member to be deleted.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberInfo\":{\"type\":\"object\",\"description\":\"An object representing the OAuth2 info of a member of an app\",\"additionalProperties\":false,\"properties\":{\"sub\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The id of the app member.\"},\"name\":{\"type\":\"string\",\"description\":\"The full name of the app member.\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The email address of the app member.\"},\"email_verified\":{\"type\":\"boolean\",\"description\":\"Whether this email address has been verified.\"},\"picture\":{\"type\":\"string\",\"format\":\"url\",\"description\":\"The URL of the profile picture of the app member.\"},\"locale\":{\"type\":\"string\",\"description\":\"The locale of the app member.\"},\"zoneinfo\":{\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/La_Rioja\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Ciudad_Juarez\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Fort_Nelson\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Monticello\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Ojinaga\",\"America/Panama\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Colombo\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Hebron\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Ulyanovsk\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\"],\"description\":\"The time zone of the app member.\"},\"role\":{\"type\":\"string\",\"description\":\"The role of the app member within the app\"},\"properties\":{\"type\":\"object\",\"description\":\"The custom properties of the app member.\",\"additionalProperties\":true}}},\"AppMemberInviteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"email\",\"role\"],\"properties\":{\"type\":{\"enum\":[\"app.member.invite\"],\"description\":\"Allows the app member to invite another app member using an email address and a role.\\n\\nDoes nothing if the app member is not logged in.\"},\"email\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The email to invite.\"},\"role\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The role of the invited app member.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberLoginActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"app.member.login\"],\"description\":\"Allows the app member to login using an email address and a password.\\n\\nDoes nothing if the app member is already logged in.\"},\"password\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The password to log in with.\"},\"email\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The email to log in with.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberLogoutActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"app.member.logout\"],\"description\":\"Allow the app members to log out of the application.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberPropertiesPatchActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"sub\"],\"properties\":{\"type\":{\"enum\":[\"app.member.properties.patch\"],\"description\":\"Allows the app member to patch the properties of another app member account.\\n\\nDoes nothing if the app member isn\\u2019t logged in.\"},\"sub\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The new full name name of the app member.\"},\"properties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The updated custom properties for the app member.\\n\\nValues will be validated based on `members.properties`, if defined in the app definition.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberPropertyDefinition\":{\"anyOf\":[{\"type\":\"object\",\"description\":\"Definition for an app member custom property.\",\"required\":[\"schema\"],\"additionalProperties\":false,\"properties\":{\"schema\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/JSONSchemaInteger\"},{\"$ref\":\"#/components/schemas/JSONSchemaArray\"}]},\"reference\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"The object for the reference to another resource\",\"properties\":{\"resource\":{\"type\":\"string\",\"description\":\"The resource referenced by this app member property.\"}}}}},{\"type\":\"object\",\"description\":\"Definition for an app member property.\",\"required\":[\"schema\"],\"additionalProperties\":false,\"properties\":{\"schema\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/JSONSchemaInteger\"},{\"$ref\":\"#/components/schemas/JSONSchemaArray\"},{\"$ref\":\"#/components/schemas/JSONSchemaString\"},{\"$ref\":\"#/components/schemas/JSONSchemaNumber\"},{\"$ref\":\"#/components/schemas/JSONSchemaEnum\"},{\"$ref\":\"#/components/schemas/JSONSchemaBoolean\"},{\"$ref\":\"#/components/schemas/JSONSchemaObject\"}]}}}]},\"AppMemberQueryActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"app.member.query\"],\"description\":\"Allows the currently logged in app member to fetch a list of app members by their roles.\\n\\nDoes nothing if the app member isn\\u2019t logged in.\"},\"roles\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The roles of the app members that would be fetched.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"Additional filters to fetch members based on properties and other fields\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberRegisterActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"email\",\"password\"],\"properties\":{\"type\":{\"enum\":[\"app.member.register\"],\"description\":\"Allows the app member to register using an email address and a password.\\n\\nDoes nothing if the app member is already logged in.\"},\"password\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The password to log in with.\"},\"email\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The email to log in with.\"},\"name\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The full name of the app member.\"},\"picture\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The image to use for the profile picture of the app member.\"},\"properties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The custom properties for the app member.\\n\\nValues will be validated based on `members.properties`, if defined in the app definition.\"},\"login\":{\"type\":\"boolean\",\"description\":\"Whether to login after registering.\",\"default\":true},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMemberRoleUpdateActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"sub\"],\"properties\":{\"type\":{\"enum\":[\"app.member.role.update\"],\"description\":\"Allows the app member to update the role of another app member account.\\n\\nDoes nothing if the app member isn\\u2019t logged in.\"},\"sub\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The id of the app member.\"},\"role\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The updated role of the app member.\\n\\nThe role must exist in the roles property of the app's security definition or in the predefined app roles in the system -\\n`Member`, `MembersManager`, `GroupMembersManager`, `GroupsManager`, `ResourcesManager` and `Owner`\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"AppMembersDefinition\":{\"type\":\"object\",\"description\":\"Definition for app member properties.\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"properties\":{\"type\":\"object\",\"description\":\"The properties object configuring app members\",\"additionalProperties\":{\"description\":\"A single app member property definition.\",\"$ref\":\"#/components/schemas/AppMemberPropertyDefinition\"}}}},\"AppMessages\":{\"type\":\"object\",\"description\":\"The response object of an messages create call.\",\"required\":[\"language\",\"messages\"],\"additionalProperties\":false,\"properties\":{\"language\":{\"type\":\"string\",\"description\":\"The language the messages represent.\"},\"messages\":{\"$ref\":\"#/components/schemas/AppsembleMessages\"},\"force\":{\"type\":\"boolean\",\"writeOnly\":true,\"description\":\"If this is true, the app lock is ignored.\"}}},\"AppOAuth2Secret\":{\"type\":\"object\",\"description\":\"Settings for login in apps using third party OAuth2 providers\",\"required\":[\"authorizationUrl\",\"clientId\",\"clientSecret\",\"icon\",\"name\",\"scope\",\"tokenUrl\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"number\",\"description\":\"An autogenerated ID\",\"readOnly\":true},\"authorizationUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The OAuth2 redirect URL.\"},\"tokenUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The URL to request access tokens from.\"},\"clientId\":{\"type\":\"string\",\"description\":\"The public client id which identifies Appsemble to the authorization server.\"},\"clientSecret\":{\"type\":\"string\",\"description\":\"The OAuth2 client secret.\"},\"icon\":{\"type\":\"string\",\"description\":\"A Font Awesome icon which represents the OAuth2 provider.\"},\"name\":{\"type\":\"string\",\"description\":\"A display name which represents the OAuth2 provider.\"},\"scope\":{\"type\":\"string\",\"description\":\"The login scope that will be requested from the authorization server.\"},\"userInfoUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The URL to request user info from\"},\"remapper\":{\"type\":\"array\",\"description\":\"A remapper to apply on retrieved user information from the user info endpoint.\",\"items\":{}},\"created\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"When the secret was created originally.\"},\"updated\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"When the secret was last updated.\"}}},\"AppServiceSecret\":{\"type\":\"object\",\"description\":\"App service secret settings\",\"required\":[\"urlPatterns\",\"authenticationMethod\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"number\",\"description\":\"An autogenerated ID.\",\"readOnly\":true},\"name\":{\"type\":\"string\",\"description\":\"An optional name to give extra clarity what the secret is used for.\"},\"urlPatterns\":{\"type\":\"string\",\"description\":\"The url pattern that is matched when a proxied request action is called.\"},\"authenticationMethod\":{\"enum\":[\"http-basic\",\"client-certificate\",\"client-credentials\",\"cookie\",\"custom-header\",\"query-parameter\"],\"description\":\"The method to authenticate the request action with.\"},\"identifier\":{\"type\":\"string\",\"description\":\"The parameter name, header name, username or certificate that goes with the secret.\"},\"secret\":{\"type\":\"string\",\"description\":\"The secret to authenticate the proxied outgoing request with.\"},\"tokenUrl\":{\"type\":\"string\",\"description\":\"The URL to request access tokens from.\"},\"scope\":{\"type\":\"string\",\"description\":\"The scope to request access tokens for.\"},\"public\":{\"type\":\"boolean\",\"description\":\"If a secret is marked public, it can be applied to the unauthenticated users, e.g. in the requests originating in a custom sign up or login page.\",\"default\":false},\"ca\":{\"type\":\"string\",\"description\":\"The custom certificate authority.\"}}},\"AppVariable\":{\"type\":\"object\",\"description\":\"App variable\",\"required\":[\"name\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"number\",\"description\":\"An autogenerated ID.\",\"readOnly\":true},\"name\":{\"type\":\"string\",\"description\":\"The name of the variable, that will be accessible from clients.\"},\"value\":{\"description\":\"The value of the variable.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"boolean\"},{\"type\":\"number\"}]}}},\"AppWebhookSecret\":{\"type\":\"object\",\"description\":\"App webhook secret settings\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"number\",\"description\":\"An autogenerated ID.\",\"readOnly\":true},\"name\":{\"type\":\"string\",\"description\":\"An optional name to give extra clarity what the secret is used for.\"},\"webhookName\":{\"type\":\"string\",\"description\":\"The name of the webhook the secret is tied to\"},\"secret\":{\"type\":\"string\",\"description\":\"The autogenerated secret to authenticate the webhook caller with.\"}}},\"AppsembleMessages\":{\"type\":\"object\",\"description\":\"A mapping of the messages for this language\",\"additionalProperties\":false,\"properties\":{\"core\":{\"type\":\"object\",\"description\":\"Translations for the core of the app.\",\"additionalProperties\":{\"type\":\"string\"}},\"app\":{\"type\":\"object\",\"description\":\"Translations for global block messages and meta properties of the app.\",\"additionalProperties\":{\"type\":\"string\"}},\"blocks\":{\"type\":\"object\",\"description\":\"Translations for the core of the app.\",\"additionalProperties\":{\"type\":\"object\",\"description\":\"The name of the block type.\",\"pattern\":\"^@([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)/([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"additionalProperties\":{\"type\":\"object\",\"description\":\"The version of the block.\",\"pattern\":\"^\\\\d+\\\\.\\\\d+\\\\.\\\\d+(-[\\\\d.a-z-]+)?$\",\"additionalProperties\":{\"type\":\"string\"}}}},\"messageIds\":{\"type\":\"object\",\"description\":\"A list of custom message IDs used by the app.\",\"additionalProperties\":{\"type\":\"string\"}}}},\"ArrayRemapperDefinition\":{\"type\":\"array\",\"description\":\"If a remapper is an array, it represents a chain of remappers.\\n\\nEach item represents a remapper which is called with the result of the remapper before it.\\n\\nIf an array is nested, it will be flattened. This allows you to create reusable remappers and\\nreference them using YAML anchors.\\n\",\"minItems\":1,\"items\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/ObjectRemapperDefinition\"},{\"$ref\":\"#/components/schemas/ArrayRemapperDefinition\"}]}},\"Asset\":{\"type\":\"object\",\"description\":\"The response object of an asset publish call.\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The unique identifier for the asset.\",\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\"},\"mime\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The IANA MIME type of the asset.\"},\"filename\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The filename of the asset.\"},\"name\":{\"type\":\"string\",\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"description\":\"The given name of the asset. Assets may be referenced by their name or ID in the API.\"}}},\"BlockDefinition\":{\"type\":\"object\",\"description\":\"A block that is displayed on a page.\",\"required\":[\"type\",\"version\"],\"additionalProperties\":false,\"properties\":{\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"type\":{\"type\":\"string\",\"pattern\":\"^(@([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)/)?([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"description\":\"The type of the block.\\n\\nA block type follows the format `@organization/name`. If the organization is _appsemble_, it may\\nbe omitted.\\n\\nSome examples:\\n\\n- `form`\\n- `@amsterdam/splash`\\n\"},\"version\":{\"type\":\"string\",\"pattern\":\"^\\\\d+\\\\.\\\\d+\\\\.\\\\d+(-[\\\\d.a-z-]+)?$\",\"description\":\"The version of the block to use.\\n\\nSince blocks may change over time, a version must be specified in order to ensure that the block\\nwill remain the same until it is manually updated.\\n\"},\"layout\":{\"description\":\"An override of the block\\u2019s default layout.\\n\\n`float` sets the block position to float on the page and does not collide with other blocks.\\nLayout float can be combined with the `position` property to place the block on the desired location.\\n`grow` adds space between blocks so the page is filled.\\n`static` on the contrary, does not add extra space between blocks.\\n\",\"enum\":[\"float\",\"grow\",\"static\"]},\"hide\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"Whether to render the block or not\"},\"header\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"An optional header to render above the block.\"},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this block.\\n\\nIf a user does not have the right role, the block is not rendered.\\n\",\"items\":{\"type\":\"string\"}},\"position\":{\"description\":\"For floating blocks this property defines where the block should float.\",\"default\":\"bottom right\",\"enum\":[\"top left\",\"top\",\"top right\",\"left\",\"right\",\"bottom left\",\"bottom\",\"bottom right\"]},\"parameters\":{\"type\":\"object\",\"description\":\"A free form mapping of named parameters.\\n\\nThe exact meaning of the parameters depends on the block type.\\n\",\"additionalProperties\":true},\"actions\":{\"type\":\"object\",\"description\":\"A mapping of actions that can be fired by the block to action handlers.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/ActionDefinition\"}},\"events\":{\"$ref\":\"#/components/schemas/EventsDefinition\"}}},\"BlockVersion\":{\"type\":\"object\",\"description\":\"A version of a block definition\\n\\nBlock versions can\\u2019t be updated or deleted. This ensures apps that use a block version can never\\nbe broken by alterations of block definitions.\\n\",\"required\":[\"name\",\"version\",\"files\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The name of a block.\\n\\nThis uses the same form as scoped npm packages. For example, `@appsemble/form`.\\n\",\"pattern\":\"^@([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)/([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the block.\",\"maxLength\":160},\"longDescription\":{\"type\":\"string\",\"description\":\"The long description of the block.\"},\"icon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"An icon to represent the block in Appsemble studio.\"},\"iconUrl\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The relative URL on which the icon is served\",\"readOnly\":true},\"version\":{\"type\":\"string\",\"pattern\":\"^\\\\d+\\\\.\\\\d+\\\\.\\\\d+(-[\\\\d.a-z-]+)?$\",\"description\":\"A [semver](https://semver.org) representation of the block version.\"},\"visibility\":{\"enum\":[\"public\",\"unlisted\"],\"default\":\"public\",\"description\":\"Whether the block should be listed publicly for users who aren\\u2019t part of the block\\u2019s organization.\\n\\n- **`public`**: The block is visible for everyone.\\n- **`unlisted`**: The block will only be visible if the user is logged in and is part of the block\\u2019s organization.\"},\"layout\":{\"description\":\"How the block will be displayed on the screen.\\n\\n- **`float`**: The block will float somewhere on the screen.\\n- **`grow`**: The block will be positioned in the main page. It will grow to fill up remaining\\n space on the page.\\n- **`static`**: The block will be positioned in the main page. It will take up a fixed amount of\\n space.\\n- **`hidden`**: The block will not be rendered at all.\\n\",\"default\":\"grow\",\"enum\":[\"float\",\"grow\",\"static\",\"hidden\"]},\"actions\":{\"type\":\"object\",\"description\":\"An object which describes the actions a block can trigger.\\n\\nThis will be used to validate app definitions.\\n\",\"additionalProperties\":true},\"parameters\":{\"$ref\":\"#/components/schemas/JSONSchemaRoot\",\"description\":\"A draft 7 JSON schema to use for block parameter validation.\\n\\nIf the parameters of a block definition don\\u2019t conform to this schema, the app definition will be\\nconsidered invalid.\\n\"},\"events\":{\"type\":\"object\",\"description\":\"An object describing the names of the events the block can listen and emit to.\",\"additionalProperties\":false,\"properties\":{\"listen\":{\"type\":\"object\",\"description\":\"A mapping of events this block may listen on\",\"additionalProperties\":{\"description\":\"A mapping of events this block may listen on\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"description\":{\"type\":\"string\"}}}},\"emit\":{\"type\":\"object\",\"description\":\"A mapping of events this block may emit\",\"additionalProperties\":{\"description\":\"A mapping of events this block may emit\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"description\":{\"type\":\"string\"}}}}}},\"resources\":{\"type\":\"object\",\"description\":\"deprecated\",\"additionalProperties\":true},\"messages\":{\"type\":\"object\",\"description\":\"The translated messages for the block.\\n\\nEnglish (`en`) messages are required.\\n\",\"required\":[\"en\"],\"properties\":{\"en\":{\"type\":\"object\",\"description\":\"A mapping of language IDs to their English translation\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"The default translations to use.\",\"minLength\":1}}},\"additionalProperties\":{\"type\":\"object\",\"description\":\"A mapping of language IDs to their internationalized translation\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"The translated messages for this language.\"}}},\"files\":{\"type\":\"array\",\"description\":\"A list of file assets that belong to the app version.\",\"minLength\":1,\"items\":{\"type\":\"string\",\"format\":\"binary\"}},\"examples\":{\"type\":\"array\",\"description\":\"A list of exmples how the block can be used within an app definition.\",\"items\":{\"type\":\"string\"}}}},\"ConditionActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"if\"],\"properties\":{\"type\":{\"enum\":[\"condition\"],\"description\":\"Run another action if a certain contition is met.\"},\"if\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper to determine the condition to check.\\n\\nIf this yields a truthy value, the `then` action is called. Otherwise the `else` action is\\ncalled.\\n\"},\"then\":{\"description\":\"This action is called if the `if` remapper yields a truthy value.\",\"$ref\":\"#/components/schemas/ActionDefinition\"},\"else\":{\"description\":\"This action is called if the `if` remapper yields a falsy value.\",\"$ref\":\"#/components/schemas/ActionDefinition\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ContainerDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"An object describing a companion container\",\"required\":[\"name\",\"image\",\"port\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Alias used to reference the container\"},\"image\":{\"type\":\"string\",\"description\":\"Name of the image used for the container\"},\"port\":{\"type\":\"number\",\"description\":\"Port used by the image provided\"},\"resources\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"Maximum amount of resources the container can use. Deafult: 1 CPU and 512Mi memory\"},\"env\":{\"type\":\"array\",\"description\":\"Environment variables that will be used within the container\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Each item is an environment variable. `useValueFromSecret` property determines whether the value is taken literally or from and existing secret\",\"required\":[\"name\",\"value\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the environment variable\"},\"useValueFromSecret\":{\"type\":\"boolean\",\"description\":\"If set to true, will retrieve the value from the Kubernetes secret, the value property will refer to the secret key. If false, will take the value literally\"},\"value\":{\"type\":\"string\",\"description\":\"The value of the environment variable. If `useValueFromSecret` is true, this property will refer to the Kubernetes secret's key\"}}}},\"metadata\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"Metadata including labels and annotations to be added to the container\"}}},\"ContainerPageDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Groups pages together under a collapsible parent page. Following is an example of\\nhow this can be used:\\n```yaml\\npages:\\n - name: Page 1\\n type: container\\n pages:\\n - name: Contained page 1\\n blocks:\\n - type: action-button\\n version: 0.29.8\\n parameters:\\n icon: git-alt\\n actions:\\n onClick:\\n type: link\\n to: Contained page 2\\n - name: Contained page 2\\n blocks:\\n - type: action-button\\n version: 0.29.8\\n parameters:\\n icon: git-alt\\n actions:\\n onClick:\\n type: link\\n to: Contained page 1\\n```\\n\",\"required\":[\"type\",\"pages\",\"name\"],\"properties\":{\"type\":{\"enum\":[\"container\"]},\"pages\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The pages of the app.\",\"items\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/PageDefinition\"},{\"$ref\":\"#/components/schemas/TabsPageDefinition\"},{\"$ref\":\"#/components/schemas/FlowPageDefinition\"},{\"$ref\":\"#/components/schemas/LoopPageDefinition\"},{\"$ref\":\"#/components/schemas/ContainerPageDefinition\"}]}},\"name\":{\"type\":\"string\",\"maxLength\":50,\"description\":\"The name of an app.\\n\\nThis field is always required and must be unique within the app, meaning that it is not possible to\\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\\n\\n> **Note**: The URL used to navigate to pages is determined by this property.\\n\"},\"hideName\":{\"type\":\"boolean\",\"description\":\"Whether or not the page name should be displayed in the *app bar*.\"},\"navTitle\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the page when displayed in the navigation menu.\\n\\n Context property `name` can be used to access the name of the page.\\n \"},\"hideNavTitle\":{\"type\":\"boolean\",\"description\":\"Whether or not the page should be displayed in navigational menus.\\n\\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\\n page from menus.\\n \",\"default\":false},\"navigation\":{\"$ref\":\"#/components/schemas/AppLayoutDefinition/properties/navigation\",\"description\":\"The type of navigation displayed on the page.\\n\\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\\nApp navigation are not set.\\n\\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\\nmenu. Set to `hidden` to display no navigational menus at all.\\n\"},\"icon\":{\"type\":\"string\",\"description\":\"An optional icon from the fontawesome icon set\\n\\nThis will be displayed in the navigation menu.\\n\"},\"parameters\":{\"type\":\"array\",\"description\":\"Page parameters can be used for linking to a page that should display a single resource.\\n\\nThis defined as a list of strings representing the properties to pass through. More often than not\\npassing `id` through is sufficient, depending on the block.\\n\",\"items\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":30}},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this page.\\n\\nIf the user doesn\\u2019t have any of the roles in the list the page will be unavailable to them. An empty\\nlist can be used to specify that users need to log in but do not need a specific role.\\n\\nUsers trying to visit a page without having the correct roles will be redirected to the first page\\nthat they are allowed to view. If there aren\\u2019t any accessible pages, the user will be logged out and\\ninstructed to contact the app owner to get permissions.\\n\",\"items\":{\"type\":\"string\"}},\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"badgeCount\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A Remapper that resolves to a number to be visibile in the side-menu.\"}}},\"ControllerActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"handler\"],\"properties\":{\"type\":{\"enum\":[\"controller\"],\"description\":\"Use the controller to handle the action.\"},\"handler\":{\"type\":\"string\",\"description\":\"The name of the function in the controller that will handle the action\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ControllerDefinition\":{\"type\":\"object\",\"description\":\"A controller for application logic.\",\"required\":[],\"additionalProperties\":false,\"properties\":{\"actions\":{\"type\":\"object\",\"description\":\"A mapping of actions that can be fired by the controller to action handlers.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/ActionDefinition\"}},\"events\":{\"$ref\":\"#/components/schemas/EventsDefinition\"}}},\"CronDefinition\":{\"type\":\"object\",\"required\":[\"schedule\"],\"description\":\"A cron definition defines tasks that Appsemble will run periodically for the app.\",\"additionalProperties\":false,\"properties\":{\"schedule\":{\"description\":\"A crontab string to define when the action should be run.\\n\\nSee [Crontab guru](https://crontab.guru) for details\\n\",\"type\":\"string\"},\"action\":{\"description\":\"The action to run when the cronjob is triggered.\",\"$ref\":\"#/components/schemas/ActionDefinition\"}}},\"CsvParseActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"file\"],\"properties\":{\"type\":{\"description\":\"An action to parse the CSV files\",\"enum\":[\"csv.parse\"]},\"file\":{\"description\":\"The CSV file to be parsed\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"delimiter\":{\"description\":\"The delimiter to be used, defaults to comma(\\\",\\\")\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"CustomFontDefinition\":{\"type\":\"object\",\"description\":\"A custom font definition.\",\"additionalProperties\":false,\"required\":[\"source\",\"family\"],\"properties\":{\"source\":{\"description\":\"Use a custom font.\",\"enum\":[\"custom\"]},\"family\":{\"type\":\"string\",\"description\":\"The font family to use in the app.\\n\\nMake sure the font is available using custom CSS.\\n\"}}},\"DialogActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"blocks\"],\"properties\":{\"type\":{\"enum\":[\"dialog\"],\"description\":\"This action opens a pop-up dialog that can be used to seamlessly transition to a new set of blocks temporarily.\\n\\nDialogs can be closed by calling the [`dialog.ok`](#DialogOkActionDefinition) or\\n[`dialog.error`](#DialogErrorActionDefinition). Users can still manually close dialogs, which\\nshould be supported by the app.\\n\\nBlocks with the layout type `float` (e.g. `action-button`) do not work in this action.\\n\"},\"title\":{\"description\":\"An optional title to set in the dialog header.\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"closable\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Whether users are allowed to close the dialog by clicking outside of it or on the close button.\"},\"fullscreen\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Whether the dialog should be displayed full screen as if it\\u2019s a new page, or as a pop-up.\"},\"blocks\":{\"type\":\"array\",\"description\":\"A list of blocks to display in the dialog.\",\"items\":{\"$ref\":\"#/components/schemas/BlockDefinition\"}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"DialogErrorActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"dialog.error\"],\"description\":\"Close an open dialog.\\n\\nThe dialog action that opened the dialog will be rejected with the data passed to this action.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"DialogOkActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"dialog.ok\"],\"description\":\"Close an open dialog.\\n\\nThe dialog action that opened the dialog will be resolved with the data passed to this action.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"DownloadActionDefinition\":{\"type\":\"object\",\"required\":[\"type\",\"filename\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"enum\":[\"download\"],\"description\":\"Download the data as a file.\"},\"filename\":{\"type\":\"string\",\"description\":\"The filename to save the file as. This must include a file extension.\",\"pattern\":\"\\\\.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"EachActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"do\"],\"properties\":{\"type\":{\"enum\":[\"each\"],\"description\":\"Run an action for each entry in an array.\\n\\nThe actions are run in parallel.\\n\\nIf the input is not an array, the action will be applied to the input instead.\"},\"serial\":{\"description\":\"Runs the action in series instead of parallel\",\"type\":\"boolean\"},\"do\":{\"description\":\"This action is called for each item in the input array.\",\"$ref\":\"#/components/schemas/ActionDefinition\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"EmailActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"subject\",\"body\"],\"properties\":{\"type\":{\"enum\":[\"email\"],\"description\":\"The email action can be used to send emails via the Appsemble server.\\n\\nIf `to`, `cc`, and `bcc` all end up being empty, no emails will be sent but the action will still continue as normal.\\n\"},\"to\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The address the email should be sent to. Can be either in the format of `[email protected]`, or `John Doe <[email protected]>`\"},\"from\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the sender of the email.\"},\"cc\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The list of additional email addresses email should be sent to. Uses the same format as `to`. Every email address in the CC is visible to all recipients.\"},\"bcc\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The list of additional email addresses email should be sent to. Uses the same format as `to`. Email addresses in the BCC are hidden from other recipients.\"},\"subject\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The subject of the email.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The body of the email. The content of the body is converted to HTML using the Markdown syntax.\"},\"attachments\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The attachments to include in the email.\\n\\nThe remapper must resolve to an object containing the following properties:\\n\\n- `target`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with `content`.\\n- `content`: The raw content to include as the file content. This is mutually exclusive with `target`.\\n- `filename`: The filename to include the attachment as.\\n- `accept` If the target is a URL, this will be set as the HTTP `Accept` header when downloading the file.\\n\\nIf the attachment is a string, it will be treated as the target.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"Error\":{\"type\":\"object\",\"description\":\"The generic error object returned by any expected API errors.\",\"readOnly\":true,\"additionalProperties\":false,\"properties\":{\"statusCode\":{\"type\":\"number\",\"description\":\"Matches the HTTP response status code.\",\"example\":404},\"error\":{\"type\":\"string\",\"description\":\"Matches the HTTP response status description.\",\"example\":\"Not Found\"},\"message\":{\"type\":\"string\",\"description\":\"A message describing the error.\",\"example\":\"Entity not found\"}}},\"EventActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"event\"],\"properties\":{\"type\":{\"enum\":[\"event\"],\"description\":\"This action allows for other blocks to emit data upon triggering the action.\\n\\nThis can be used to make blocks interact with each other, such as triggering the `data-loader`\\nblock to refresh itself by sending an event action that matches the name of what the block is\\nlistening to.\\n\"},\"event\":{\"type\":\"string\",\"description\":\"The name of the event to emit.\"},\"waitFor\":{\"type\":\"string\",\"description\":\"If specified, the action will wait for this event to have been emitted and respond with its data.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"EventsDefinition\":{\"type\":\"object\",\"description\":\"An object describing the names of the events the block can listen and emit to.\",\"additionalProperties\":false,\"minProperties\":1,\"properties\":{\"listen\":{\"type\":\"object\",\"description\":\"This property defines the events this block will listen on.\\n\\nThe key is the name of the event will listen on. The value is a user defined event name which should\\nmatch the name of an emitted event on the same page.\\n\",\"minProperties\":1,\"additionalProperties\":{\"type\":\"string\"}},\"emit\":{\"type\":\"object\",\"description\":\"This property defines the events this block will emit.\\n\\nThe key is the name of the event will emit. The value is a user defined event name which should\\nmatch the name of a event on the same page that\\u2019s being listened on.\\n\",\"minProperties\":1,\"additionalProperties\":{\"type\":\"string\"}}}},\"FilterParametersDefinition\":{\"type\":\"object\",\"description\":\"An object describing the comparison that should be applied to the key in an OData filter.\",\"additionalProperties\":false,\"properties\":{\"type\":{\"enum\":[\"Boolean\",\"String\",\"Number\",\"Date\",\"Guid\"]},\"value\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"comparator\":{\"enum\":[\"eq\",\"ge\",\"gt\",\"le\",\"lt\",\"ne\"]}}},\"FlowBackActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"flow.back\"],\"description\":\"On [flow pages](#flow-page-definition-sub-pages), return to the previous page if\\nit is present. If this is called on the first page, nothing happens.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"FlowCancelActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"flow.cancel\"],\"description\":\"On [flow pages](../guides/page-types#flow-page), cancel the ongoing flow and invoke the page's [`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"FlowFinishActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"flow.finish\"],\"description\":\"On [flow pages](../guides/page-types#flow-page), triggers the\\n[`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action on the page.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"FlowNextActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"flow.next\"],\"description\":\"On [flow pages](#flow-page-definition-sub-pages), proceed to the next page if it\\nis present. Otherwise, the flow is considered to be complete and [`flow.finish`](#flowfinish) will\\nbe called instead.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"FlowPageActionsDefinition\":{\"type\":\"object\",\"description\":\"These actions are fired on a flow page.\",\"additionalProperties\":false,\"properties\":{\"onFlowCancel\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action gets triggered when `flow.cancel` gets called.\"},\"onFlowFinish\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action gets triggered when a flow is finished.\\n\\nA flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final\\nsubpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action.\"},\"onLoad\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action is fired when a page loads, highly helpful in loading data for the page\"}}},\"FlowPageDefinition\":{\"type\":\"object\",\"description\":\"Shows a set of sub pages in a certain order which the user can navigate through.\",\"required\":[\"type\",\"steps\",\"name\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"enum\":[\"flow\"]},\"steps\":{\"type\":\"array\",\"minItems\":2,\"description\":\"Steps belonging to this page's flow.\",\"items\":{\"$ref\":\"#/components/schemas/SubPage\"}},\"actions\":{\"$ref\":\"#/components/schemas/FlowPageActionsDefinition\"},\"progress\":{\"description\":\"The method that should be used to display the status of flow pages.\",\"enum\":[\"corner-dots\",\"hidden\"]},\"retainFlowData\":{\"type\":\"boolean\",\"description\":\"Whether to retain the flow data when navigating away to another page outside the flow.\\n\\nBy default the flow page retains it's data after navigating once. Set to false to clear it.\\n\",\"default\":true},\"name\":{\"type\":\"string\",\"maxLength\":50,\"description\":\"The name of an app.\\n\\nThis field is always required and must be unique within the app, meaning that it is not possible to\\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\\n\\n> **Note**: The URL used to navigate to pages is determined by this property.\\n\"},\"hideName\":{\"type\":\"boolean\",\"description\":\"Whether or not the page name should be displayed in the *app bar*.\"},\"navTitle\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the page when displayed in the navigation menu.\\n\\n Context property `name` can be used to access the name of the page.\\n \"},\"hideNavTitle\":{\"type\":\"boolean\",\"description\":\"Whether or not the page should be displayed in navigational menus.\\n\\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\\n page from menus.\\n \",\"default\":false},\"navigation\":{\"$ref\":\"#/components/schemas/AppLayoutDefinition/properties/navigation\",\"description\":\"The type of navigation displayed on the page.\\n\\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\\nApp navigation are not set.\\n\\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\\nmenu. Set to `hidden` to display no navigational menus at all.\\n\"},\"icon\":{\"type\":\"string\",\"description\":\"An optional icon from the fontawesome icon set\\n\\nThis will be displayed in the navigation menu.\\n\"},\"parameters\":{\"type\":\"array\",\"description\":\"Page parameters can be used for linking to a page that should display a single resource.\\n\\nThis defined as a list of strings representing the properties to pass through. More often than not\\npassing `id` through is sufficient, depending on the block.\\n\",\"items\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":30}},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this page.\\n\\nIf the user doesn\\u2019t have any of the roles in the list the page will be unavailable to them. An empty\\nlist can be used to specify that users need to log in but do not need a specific role.\\n\\nUsers trying to visit a page without having the correct roles will be redirected to the first page\\nthat they are allowed to view. If there aren\\u2019t any accessible pages, the user will be logged out and\\ninstructed to contact the app owner to get permissions.\\n\",\"items\":{\"type\":\"string\"}},\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"badgeCount\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A Remapper that resolves to a number to be visibile in the side-menu.\"}}},\"FlowToActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"step\"],\"properties\":{\"type\":{\"enum\":[\"flow.to\"],\"description\":\"On [flow pages](#flow-page-definition-sub-pages), move to a specific step.\"},\"step\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the step to move to.\\n\\nThis is a remapper which gets called with the action input and context.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"GoogleFontDefinition\":{\"type\":\"object\",\"description\":\"A Google font definition.\",\"additionalProperties\":false,\"required\":[\"family\"],\"properties\":{\"source\":{\"description\":\"Use a font from [Google Fonts](https://fonts.google.com).\",\"enum\":[\"google\"]},\"family\":{\"enum\":[\"ABeeZee\",\"ADLaM Display\",\"AR One Sans\",\"Abel\",\"Abhaya Libre\",\"Aboreto\",\"Abril Fatface\",\"Abyssinica SIL\",\"Aclonica\",\"Acme\",\"Actor\",\"Adamina\",\"Advent Pro\",\"Afacad\",\"Agbalumo\",\"Agdasima\",\"Aguafina Script\",\"Akatab\",\"Akaya Kanadaka\",\"Akaya Telivigala\",\"Akronim\",\"Akshar\",\"Aladin\",\"Alata\",\"Alatsi\",\"Albert Sans\",\"Aldrich\",\"Alef\",\"Alegreya\",\"Alegreya SC\",\"Alegreya Sans\",\"Alegreya Sans SC\",\"Aleo\",\"Alex Brush\",\"Alexandria\",\"Alfa Slab One\",\"Alice\",\"Alike\",\"Alike Angular\",\"Alkalami\",\"Alkatra\",\"Allan\",\"Allerta\",\"Allerta Stencil\",\"Allison\",\"Allura\",\"Almarai\",\"Almendra\",\"Almendra Display\",\"Almendra SC\",\"Alumni Sans\",\"Alumni Sans Collegiate One\",\"Alumni Sans Inline One\",\"Alumni Sans Pinstripe\",\"Amarante\",\"Amaranth\",\"Amatic SC\",\"Amethysta\",\"Amiko\",\"Amiri\",\"Amiri Quran\",\"Amita\",\"Anaheim\",\"Andada Pro\",\"Andika\",\"Anek Bangla\",\"Anek Devanagari\",\"Anek Gujarati\",\"Anek Gurmukhi\",\"Anek Kannada\",\"Anek Latin\",\"Anek Malayalam\",\"Anek Odia\",\"Anek Tamil\",\"Anek Telugu\",\"Angkor\",\"Annie Use Your Telescope\",\"Anonymous Pro\",\"Antic\",\"Antic Didone\",\"Antic Slab\",\"Anton\",\"Antonio\",\"Anuphan\",\"Anybody\",\"Aoboshi One\",\"Arapey\",\"Arbutus\",\"Arbutus Slab\",\"Architects Daughter\",\"Archivo\",\"Archivo Black\",\"Archivo Narrow\",\"Are You Serious\",\"Aref Ruqaa\",\"Aref Ruqaa Ink\",\"Arima\",\"Arimo\",\"Arizonia\",\"Armata\",\"Arsenal\",\"Artifika\",\"Arvo\",\"Arya\",\"Asap\",\"Asap Condensed\",\"Asar\",\"Asset\",\"Assistant\",\"Astloch\",\"Asul\",\"Athiti\",\"Atkinson Hyperlegible\",\"Atma\",\"Atomic Age\",\"Aubrey\",\"Audiowide\",\"Autour One\",\"Average\",\"Average Sans\",\"Averia Gruesa Libre\",\"Averia Libre\",\"Averia Sans Libre\",\"Averia Serif Libre\",\"Azeret Mono\",\"B612\",\"B612 Mono\",\"BIZ UDGothic\",\"BIZ UDMincho\",\"BIZ UDPGothic\",\"BIZ UDPMincho\",\"Babylonica\",\"Bacasime Antique\",\"Bad Script\",\"Bagel Fat One\",\"Bahiana\",\"Bahianita\",\"Bai Jamjuree\",\"Bakbak One\",\"Ballet\",\"Baloo 2\",\"Baloo Bhai 2\",\"Baloo Bhaijaan 2\",\"Baloo Bhaina 2\",\"Baloo Chettan 2\",\"Baloo Da 2\",\"Baloo Paaji 2\",\"Baloo Tamma 2\",\"Baloo Tammudu 2\",\"Baloo Thambi 2\",\"Balsamiq Sans\",\"Balthazar\",\"Bangers\",\"Barlow\",\"Barlow Condensed\",\"Barlow Semi Condensed\",\"Barriecito\",\"Barrio\",\"Basic\",\"Baskervville\",\"Battambang\",\"Baumans\",\"Bayon\",\"Be Vietnam Pro\",\"Beau Rivage\",\"Bebas Neue\",\"Belanosima\",\"Belgrano\",\"Bellefair\",\"Belleza\",\"Bellota\",\"Bellota Text\",\"BenchNine\",\"Benne\",\"Bentham\",\"Berkshire Swash\",\"Besley\",\"Beth Ellen\",\"Bevan\",\"BhuTuka Expanded One\",\"Big Shoulders Display\",\"Big Shoulders Inline Display\",\"Big Shoulders Inline Text\",\"Big Shoulders Stencil Display\",\"Big Shoulders Stencil Text\",\"Big Shoulders Text\",\"Bigelow Rules\",\"Bigshot One\",\"Bilbo\",\"Bilbo Swash Caps\",\"BioRhyme\",\"BioRhyme Expanded\",\"Birthstone\",\"Birthstone Bounce\",\"Biryani\",\"Bitter\",\"Black And White Picture\",\"Black Han Sans\",\"Black Ops One\",\"Blaka\",\"Blaka Hollow\",\"Blaka Ink\",\"Blinker\",\"Bodoni Moda\",\"Bokor\",\"Bona Nova\",\"Bonbon\",\"Bonheur Royale\",\"Boogaloo\",\"Borel\",\"Bowlby One\",\"Bowlby One SC\",\"Braah One\",\"Brawler\",\"Bree Serif\",\"Bricolage Grotesque\",\"Bruno Ace\",\"Bruno Ace SC\",\"Brygada 1918\",\"Bubblegum Sans\",\"Bubbler One\",\"Buda\",\"Buenard\",\"Bungee\",\"Bungee Hairline\",\"Bungee Inline\",\"Bungee Outline\",\"Bungee Shade\",\"Bungee Spice\",\"Butcherman\",\"Butterfly Kids\",\"Cabin\",\"Cabin Condensed\",\"Cabin Sketch\",\"Caesar Dressing\",\"Cagliostro\",\"Cairo\",\"Cairo Play\",\"Caladea\",\"Calistoga\",\"Calligraffitti\",\"Cambay\",\"Cambo\",\"Candal\",\"Cantarell\",\"Cantata One\",\"Cantora One\",\"Caprasimo\",\"Capriola\",\"Caramel\",\"Carattere\",\"Cardo\",\"Carlito\",\"Carme\",\"Carrois Gothic\",\"Carrois Gothic SC\",\"Carter One\",\"Castoro\",\"Castoro Titling\",\"Catamaran\",\"Caudex\",\"Caveat\",\"Caveat Brush\",\"Cedarville Cursive\",\"Ceviche One\",\"Chakra Petch\",\"Changa\",\"Changa One\",\"Chango\",\"Charis SIL\",\"Charm\",\"Charmonman\",\"Chathura\",\"Chau Philomene One\",\"Chela One\",\"Chelsea Market\",\"Chenla\",\"Cherish\",\"Cherry Bomb One\",\"Cherry Cream Soda\",\"Cherry Swash\",\"Chewy\",\"Chicle\",\"Chilanka\",\"Chivo\",\"Chivo Mono\",\"Chokokutai\",\"Chonburi\",\"Cinzel\",\"Cinzel Decorative\",\"Clicker Script\",\"Climate Crisis\",\"Coda\",\"Codystar\",\"Coiny\",\"Combo\",\"Comfortaa\",\"Comforter\",\"Comforter Brush\",\"Comic Neue\",\"Coming Soon\",\"Comme\",\"Commissioner\",\"Concert One\",\"Condiment\",\"Content\",\"Contrail One\",\"Convergence\",\"Cookie\",\"Copse\",\"Corben\",\"Corinthia\",\"Cormorant\",\"Cormorant Garamond\",\"Cormorant Infant\",\"Cormorant SC\",\"Cormorant Unicase\",\"Cormorant Upright\",\"Courgette\",\"Courier Prime\",\"Cousine\",\"Coustard\",\"Covered By Your Grace\",\"Crafty Girls\",\"Creepster\",\"Crete Round\",\"Crimson Pro\",\"Crimson Text\",\"Croissant One\",\"Crushed\",\"Cuprum\",\"Cute Font\",\"Cutive\",\"Cutive Mono\",\"DM Mono\",\"DM Sans\",\"DM Serif Display\",\"DM Serif Text\",\"Dai Banna SIL\",\"Damion\",\"Dancing Script\",\"Dangrek\",\"Darker Grotesque\",\"Darumadrop One\",\"David Libre\",\"Dawning of a New Day\",\"Days One\",\"Dekko\",\"Dela Gothic One\",\"Delicious Handrawn\",\"Delius\",\"Delius Swash Caps\",\"Delius Unicase\",\"Della Respira\",\"Denk One\",\"Devonshire\",\"Dhurjati\",\"Didact Gothic\",\"Diphylleia\",\"Diplomata\",\"Diplomata SC\",\"Do Hyeon\",\"Dokdo\",\"Domine\",\"Donegal One\",\"Dongle\",\"Doppio One\",\"Dorsa\",\"Dosis\",\"DotGothic16\",\"Dr Sugiyama\",\"Duru Sans\",\"DynaPuff\",\"Dynalight\",\"EB Garamond\",\"Eagle Lake\",\"East Sea Dokdo\",\"Eater\",\"Economica\",\"Eczar\",\"Edu NSW ACT Foundation\",\"Edu QLD Beginner\",\"Edu SA Beginner\",\"Edu TAS Beginner\",\"Edu VIC WA NT Beginner\",\"El Messiri\",\"Electrolize\",\"Elsie\",\"Elsie Swash Caps\",\"Emblema One\",\"Emilys Candy\",\"Encode Sans\",\"Encode Sans Condensed\",\"Encode Sans Expanded\",\"Encode Sans SC\",\"Encode Sans Semi Condensed\",\"Encode Sans Semi Expanded\",\"Engagement\",\"Englebert\",\"Enriqueta\",\"Ephesis\",\"Epilogue\",\"Erica One\",\"Esteban\",\"Estonia\",\"Euphoria Script\",\"Ewert\",\"Exo\",\"Exo 2\",\"Expletus Sans\",\"Explora\",\"Fahkwang\",\"Familjen Grotesk\",\"Fanwood Text\",\"Farro\",\"Farsan\",\"Fascinate\",\"Fascinate Inline\",\"Faster One\",\"Fasthand\",\"Fauna One\",\"Faustina\",\"Federant\",\"Federo\",\"Felipa\",\"Fenix\",\"Festive\",\"Figtree\",\"Finger Paint\",\"Finlandica\",\"Fira Code\",\"Fira Mono\",\"Fira Sans\",\"Fira Sans Condensed\",\"Fira Sans Extra Condensed\",\"Fjalla One\",\"Fjord One\",\"Flamenco\",\"Flavors\",\"Fleur De Leah\",\"Flow Block\",\"Flow Circular\",\"Flow Rounded\",\"Foldit\",\"Fondamento\",\"Fontdiner Swanky\",\"Forum\",\"Fragment Mono\",\"Francois One\",\"Frank Ruhl Libre\",\"Fraunces\",\"Freckle Face\",\"Fredericka the Great\",\"Fredoka\",\"Freehand\",\"Fresca\",\"Frijole\",\"Fruktur\",\"Fugaz One\",\"Fuggles\",\"Fuzzy Bubbles\",\"GFS Didot\",\"GFS Neohellenic\",\"Gabarito\",\"Gabriela\",\"Gaegu\",\"Gafata\",\"Gajraj One\",\"Galada\",\"Galdeano\",\"Galindo\",\"Gamja Flower\",\"Gantari\",\"Gasoek One\",\"Gayathri\",\"Gelasio\",\"Gemunu Libre\",\"Genos\",\"Gentium Book Plus\",\"Gentium Plus\",\"Geo\",\"Geologica\",\"Georama\",\"Geostar\",\"Geostar Fill\",\"Germania One\",\"Gideon Roman\",\"Gidugu\",\"Gilda Display\",\"Girassol\",\"Give You Glory\",\"Glass Antiqua\",\"Glegoo\",\"Gloock\",\"Gloria Hallelujah\",\"Glory\",\"Gluten\",\"Goblin One\",\"Gochi Hand\",\"Goldman\",\"Golos Text\",\"Gorditas\",\"Gothic A1\",\"Gotu\",\"Goudy Bookletter 1911\",\"Gowun Batang\",\"Gowun Dodum\",\"Graduate\",\"Grand Hotel\",\"Grandiflora One\",\"Grandstander\",\"Grape Nuts\",\"Gravitas One\",\"Great Vibes\",\"Grechen Fuemen\",\"Grenze\",\"Grenze Gotisch\",\"Grey Qo\",\"Griffy\",\"Gruppo\",\"Gudea\",\"Gugi\",\"Gulzar\",\"Gupter\",\"Gurajada\",\"Gwendolyn\",\"Habibi\",\"Hachi Maru Pop\",\"Hahmlet\",\"Halant\",\"Hammersmith One\",\"Hanalei\",\"Hanalei Fill\",\"Handjet\",\"Handlee\",\"Hanken Grotesk\",\"Hanuman\",\"Happy Monkey\",\"Harmattan\",\"Headland One\",\"Hedvig Letters Sans\",\"Hedvig Letters Serif\",\"Heebo\",\"Henny Penny\",\"Hepta Slab\",\"Herr Von Muellerhoff\",\"Hi Melody\",\"Hina Mincho\",\"Hind\",\"Hind Guntur\",\"Hind Madurai\",\"Hind Siliguri\",\"Hind Vadodara\",\"Holtwood One SC\",\"Homemade Apple\",\"Homenaje\",\"Honk\",\"Hubballi\",\"Hurricane\",\"IBM Plex Mono\",\"IBM Plex Sans\",\"IBM Plex Sans Arabic\",\"IBM Plex Sans Condensed\",\"IBM Plex Sans Devanagari\",\"IBM Plex Sans Hebrew\",\"IBM Plex Sans JP\",\"IBM Plex Sans KR\",\"IBM Plex Sans Thai\",\"IBM Plex Sans Thai Looped\",\"IBM Plex Serif\",\"IM Fell DW Pica\",\"IM Fell DW Pica SC\",\"IM Fell Double Pica\",\"IM Fell Double Pica SC\",\"IM Fell English\",\"IM Fell English SC\",\"IM Fell French Canon\",\"IM Fell French Canon SC\",\"IM Fell Great Primer\",\"IM Fell Great Primer SC\",\"Ibarra Real Nova\",\"Iceberg\",\"Iceland\",\"Imbue\",\"Imperial Script\",\"Imprima\",\"Inclusive Sans\",\"Inconsolata\",\"Inder\",\"Indie Flower\",\"Ingrid Darling\",\"Inika\",\"Inknut Antiqua\",\"Inria Sans\",\"Inria Serif\",\"Inspiration\",\"Instrument Sans\",\"Instrument Serif\",\"Inter\",\"Inter Tight\",\"Irish Grover\",\"Island Moments\",\"Istok Web\",\"Italiana\",\"Italianno\",\"Itim\",\"Jacques Francois\",\"Jacques Francois Shadow\",\"Jaldi\",\"JetBrains Mono\",\"Jim Nightshade\",\"Joan\",\"Jockey One\",\"Jolly Lodger\",\"Jomhuria\",\"Jomolhari\",\"Josefin Sans\",\"Josefin Slab\",\"Jost\",\"Joti One\",\"Jua\",\"Judson\",\"Julee\",\"Julius Sans One\",\"Junge\",\"Jura\",\"Just Another Hand\",\"Just Me Again Down Here\",\"K2D\",\"Kablammo\",\"Kadwa\",\"Kaisei Decol\",\"Kaisei HarunoUmi\",\"Kaisei Opti\",\"Kaisei Tokumin\",\"Kalam\",\"Kalnia\",\"Kameron\",\"Kanit\",\"Kantumruy Pro\",\"Karantina\",\"Karla\",\"Karma\",\"Katibeh\",\"Kaushan Script\",\"Kavivanar\",\"Kavoon\",\"Kay Pho Du\",\"Kdam Thmor Pro\",\"Keania One\",\"Kelly Slab\",\"Kenia\",\"Khand\",\"Khmer\",\"Khula\",\"Kings\",\"Kirang Haerang\",\"Kite One\",\"Kiwi Maru\",\"Klee One\",\"Knewave\",\"KoHo\",\"Kodchasan\",\"Koh Santepheap\",\"Kolker Brush\",\"Konkhmer Sleokchher\",\"Kosugi\",\"Kosugi Maru\",\"Kotta One\",\"Koulen\",\"Kranky\",\"Kreon\",\"Kristi\",\"Krona One\",\"Krub\",\"Kufam\",\"Kulim Park\",\"Kumar One\",\"Kumar One Outline\",\"Kumbh Sans\",\"Kurale\",\"La Belle Aurore\",\"Labrada\",\"Lacquer\",\"Laila\",\"Lakki Reddy\",\"Lalezar\",\"Lancelot\",\"Langar\",\"Lateef\",\"Lato\",\"Lavishly Yours\",\"League Gothic\",\"League Script\",\"League Spartan\",\"Leckerli One\",\"Ledger\",\"Lekton\",\"Lemon\",\"Lemonada\",\"Lexend\",\"Lexend Deca\",\"Lexend Exa\",\"Lexend Giga\",\"Lexend Mega\",\"Lexend Peta\",\"Lexend Tera\",\"Lexend Zetta\",\"Libre Barcode 128\",\"Libre Barcode 128 Text\",\"Libre Barcode 39\",\"Libre Barcode 39 Extended\",\"Libre Barcode 39 Extended Text\",\"Libre Barcode 39 Text\",\"Libre Barcode EAN13 Text\",\"Libre Baskerville\",\"Libre Bodoni\",\"Libre Caslon Display\",\"Libre Caslon Text\",\"Libre Franklin\",\"Licorice\",\"Life Savers\",\"Lilita One\",\"Lily Script One\",\"Limelight\",\"Linden Hill\",\"Linefont\",\"Lisu Bosa\",\"Literata\",\"Liu Jian Mao Cao\",\"Livvic\",\"Lobster\",\"Lobster Two\",\"Londrina Outline\",\"Londrina Shadow\",\"Londrina Sketch\",\"Londrina Solid\",\"Long Cang\",\"Lora\",\"Love Light\",\"Love Ya Like A Sister\",\"Loved by the King\",\"Lovers Quarrel\",\"Luckiest Guy\",\"Lugrasimo\",\"Lumanosimo\",\"Lunasima\",\"Lusitana\",\"Lustria\",\"Luxurious Roman\",\"Luxurious Script\",\"M PLUS 1\",\"M PLUS 1 Code\",\"M PLUS 1p\",\"M PLUS 2\",\"M PLUS Code Latin\",\"M PLUS Rounded 1c\",\"Ma Shan Zheng\",\"Macondo\",\"Macondo Swash Caps\",\"Mada\",\"Magra\",\"Maiden Orange\",\"Maitree\",\"Major Mono Display\",\"Mako\",\"Mali\",\"Mallanna\",\"Mandali\",\"Manjari\",\"Manrope\",\"Mansalva\",\"Manuale\",\"Marcellus\",\"Marcellus SC\",\"Marck Script\",\"Margarine\",\"Marhey\",\"Markazi Text\",\"Marko One\",\"Marmelad\",\"Martel\",\"Martel Sans\",\"Martian Mono\",\"Marvel\",\"Mate\",\"Mate SC\",\"Material Icons\",\"Material Icons Outlined\",\"Material Icons Round\",\"Material Icons Sharp\",\"Material Icons Two Tone\",\"Material Symbols Outlined\",\"Material Symbols Rounded\",\"Material Symbols Sharp\",\"Maven Pro\",\"McLaren\",\"Mea Culpa\",\"Meddon\",\"MedievalSharp\",\"Medula One\",\"Meera Inimai\",\"Megrim\",\"Meie Script\",\"Meow Script\",\"Merienda\",\"Merriweather\",\"Merriweather Sans\",\"Metal\",\"Metal Mania\",\"Metamorphous\",\"Metrophobic\",\"Michroma\",\"Milonga\",\"Miltonian\",\"Miltonian Tattoo\",\"Mina\",\"Mingzat\",\"Miniver\",\"Miriam Libre\",\"Mirza\",\"Miss Fajardose\",\"Mitr\",\"Mochiy Pop One\",\"Mochiy Pop P One\",\"Modak\",\"Modern Antiqua\",\"Mogra\",\"Mohave\",\"Moirai One\",\"Molengo\",\"Molle\",\"Monda\",\"Monofett\",\"Monomaniac One\",\"Monoton\",\"Monsieur La Doulaise\",\"Montaga\",\"Montagu Slab\",\"MonteCarlo\",\"Montez\",\"Montserrat\",\"Montserrat Alternates\",\"Montserrat Subrayada\",\"Moo Lah Lah\",\"Mooli\",\"Moon Dance\",\"Moul\",\"Moulpali\",\"Mountains of Christmas\",\"Mouse Memoirs\",\"Mr Bedfort\",\"Mr Dafoe\",\"Mr De Haviland\",\"Mrs Saint Delafield\",\"Mrs Sheppards\",\"Ms Madi\",\"Mukta\",\"Mukta Mahee\",\"Mukta Malar\",\"Mukta Vaani\",\"Mulish\",\"Murecho\",\"MuseoModerno\",\"My Soul\",\"Mynerve\",\"Mystery Quest\",\"NTR\",\"Nabla\",\"Nanum Brush Script\",\"Nanum Gothic\",\"Nanum Gothic Coding\",\"Nanum Myeongjo\",\"Nanum Pen Script\",\"Narnoor\",\"Neonderthaw\",\"Nerko One\",\"Neucha\",\"Neuton\",\"New Rocker\",\"New Tegomin\",\"News Cycle\",\"Newsreader\",\"Niconne\",\"Niramit\",\"Nixie One\",\"Nobile\",\"Nokora\",\"Norican\",\"Nosifer\",\"Notable\",\"Nothing You Could Do\",\"Noticia Text\",\"Noto Color Emoji\",\"Noto Emoji\",\"Noto Kufi Arabic\",\"Noto Music\",\"Noto Naskh Arabic\",\"Noto Nastaliq Urdu\",\"Noto Rashi Hebrew\",\"Noto Sans\",\"Noto Sans Adlam\",\"Noto Sans Adlam Unjoined\",\"Noto Sans Anatolian Hieroglyphs\",\"Noto Sans Arabic\",\"Noto Sans Armenian\",\"Noto Sans Avestan\",\"Noto Sans Balinese\",\"Noto Sans Bamum\",\"Noto Sans Bassa Vah\",\"Noto Sans Batak\",\"Noto Sans Bengali\",\"Noto Sans Bhaiksuki\",\"Noto Sans Brahmi\",\"Noto Sans Buginese\",\"Noto Sans Buhid\",\"Noto Sans Canadian Aboriginal\",\"Noto Sans Carian\",\"Noto Sans Caucasian Albanian\",\"Noto Sans Chakma\",\"Noto Sans Cham\",\"Noto Sans Cherokee\",\"Noto Sans Chorasmian\",\"Noto Sans Coptic\",\"Noto Sans Cuneiform\",\"Noto Sans Cypriot\",\"Noto Sans Cypro Minoan\",\"Noto Sans Deseret\",\"Noto Sans Devanagari\",\"Noto Sans Display\",\"Noto Sans Duployan\",\"Noto Sans Egyptian Hieroglyphs\",\"Noto Sans Elbasan\",\"Noto Sans Elymaic\",\"Noto Sans Ethiopic\",\"Noto Sans Georgian\",\"Noto Sans Glagolitic\",\"Noto Sans Gothic\",\"Noto Sans Grantha\",\"Noto Sans Gujarati\",\"Noto Sans Gunjala Gondi\",\"Noto Sans Gurmukhi\",\"Noto Sans HK\",\"Noto Sans Hanifi Rohingya\",\"Noto Sans Hanunoo\",\"Noto Sans Hatran\",\"Noto Sans Hebrew\",\"Noto Sans Imperial Aramaic\",\"Noto Sans Indic Siyaq Numbers\",\"Noto Sans Inscriptional Pahlavi\",\"Noto Sans Inscriptional Parthian\",\"Noto Sans JP\",\"Noto Sans Javanese\",\"Noto Sans KR\",\"Noto Sans Kaithi\",\"Noto Sans Kannada\",\"Noto Sans Kawi\",\"Noto Sans Kayah Li\",\"Noto Sans Kharoshthi\",\"Noto Sans Khmer\",\"Noto Sans Khojki\",\"Noto Sans Khudawadi\",\"Noto Sans Lao\",\"Noto Sans Lao Looped\",\"Noto Sans Lepcha\",\"Noto Sans Limbu\",\"Noto Sans Linear A\",\"Noto Sans Linear B\",\"Noto Sans Lisu\",\"Noto Sans Lycian\",\"Noto Sans Lydian\",\"Noto Sans Mahajani\",\"Noto Sans Malayalam\",\"Noto Sans Mandaic\",\"Noto Sans Manichaean\",\"Noto Sans Marchen\",\"Noto Sans Masaram Gondi\",\"Noto Sans Math\",\"Noto Sans Mayan Numerals\",\"Noto Sans Medefaidrin\",\"Noto Sans Meetei Mayek\",\"Noto Sans Mende Kikakui\",\"Noto Sans Meroitic\",\"Noto Sans Miao\",\"Noto Sans Modi\",\"Noto Sans Mongolian\",\"Noto Sans Mono\",\"Noto Sans Mro\",\"Noto Sans Multani\",\"Noto Sans Myanmar\",\"Noto Sans NKo\",\"Noto Sans NKo Unjoined\",\"Noto Sans Nabataean\",\"Noto Sans Nag Mundari\",\"Noto Sans Nandinagari\",\"Noto Sans New Tai Lue\",\"Noto Sans Newa\",\"Noto Sans Nushu\",\"Noto Sans Ogham\",\"Noto Sans Ol Chiki\",\"Noto Sans Old Hungarian\",\"Noto Sans Old Italic\",\"Noto Sans Old North Arabian\",\"Noto Sans Old Permic\",\"Noto Sans Old Persian\",\"Noto Sans Old Sogdian\",\"Noto Sans Old South Arabian\",\"Noto Sans Old Turkic\",\"Noto Sans Oriya\",\"Noto Sans Osage\",\"Noto Sans Osmanya\",\"Noto Sans Pahawh Hmong\",\"Noto Sans Palmyrene\",\"Noto Sans Pau Cin Hau\",\"Noto Sans Phags Pa\",\"Noto Sans Phoenician\",\"Noto Sans Psalter Pahlavi\",\"Noto Sans Rejang\",\"Noto Sans Runic\",\"Noto Sans SC\",\"Noto Sans Samaritan\",\"Noto Sans Saurashtra\",\"Noto Sans Sharada\",\"Noto Sans Shavian\",\"Noto Sans Siddham\",\"Noto Sans SignWriting\",\"Noto Sans Sinhala\",\"Noto Sans Sogdian\",\"Noto Sans Sora Sompeng\",\"Noto Sans Soyombo\",\"Noto Sans Sundanese\",\"Noto Sans Syloti Nagri\",\"Noto Sans Symbols\",\"Noto Sans Symbols 2\",\"Noto Sans Syriac\",\"Noto Sans Syriac Eastern\",\"Noto Sans TC\",\"Noto Sans Tagalog\",\"Noto Sans Tagbanwa\",\"Noto Sans Tai Le\",\"Noto Sans Tai Tham\",\"Noto Sans Tai Viet\",\"Noto Sans Takri\",\"Noto Sans Tamil\",\"Noto Sans Tamil Supplement\",\"Noto Sans Tangsa\",\"Noto Sans Telugu\",\"Noto Sans Thaana\",\"Noto Sans Thai\",\"Noto Sans Thai Looped\",\"Noto Sans Tifinagh\",\"Noto Sans Tirhuta\",\"Noto Sans Ugaritic\",\"Noto Sans Vai\",\"Noto Sans Vithkuqi\",\"Noto Sans Wancho\",\"Noto Sans Warang Citi\",\"Noto Sans Yi\",\"Noto Sans Zanabazar Square\",\"Noto Serif\",\"Noto Serif Ahom\",\"Noto Serif Armenian\",\"Noto Serif Balinese\",\"Noto Serif Bengali\",\"Noto Serif Devanagari\",\"Noto Serif Display\",\"Noto Serif Dogra\",\"Noto Serif Ethiopic\",\"Noto Serif Georgian\",\"Noto Serif Grantha\",\"Noto Serif Gujarati\",\"Noto Serif Gurmukhi\",\"Noto Serif HK\",\"Noto Serif Hebrew\",\"Noto Serif JP\",\"Noto Serif KR\",\"Noto Serif Kannada\",\"Noto Serif Khitan Small Script\",\"Noto Serif Khmer\",\"Noto Serif Khojki\",\"Noto Serif Lao\",\"Noto Serif Makasar\",\"Noto Serif Malayalam\",\"Noto Serif Myanmar\",\"Noto Serif NP Hmong\",\"Noto Serif Old Uyghur\",\"Noto Serif Oriya\",\"Noto Serif Ottoman Siyaq\",\"Noto Serif SC\",\"Noto Serif Sinhala\",\"Noto Serif TC\",\"Noto Serif Tamil\",\"Noto Serif Tangut\",\"Noto Serif Telugu\",\"Noto Serif Thai\",\"Noto Serif Tibetan\",\"Noto Serif Toto\",\"Noto Serif Vithkuqi\",\"Noto Serif Yezidi\",\"Noto Traditional Nushu\",\"Nova Cut\",\"Nova Flat\",\"Nova Mono\",\"Nova Oval\",\"Nova Round\",\"Nova Script\",\"Nova Slim\",\"Nova Square\",\"Numans\",\"Nunito\",\"Nunito Sans\",\"Nuosu SIL\",\"Odibee Sans\",\"Odor Mean Chey\",\"Offside\",\"Oi\",\"Old Standard TT\",\"Oldenburg\",\"Ole\",\"Oleo Script\",\"Oleo Script Swash Caps\",\"Onest\",\"Oooh Baby\",\"Open Sans\",\"Oranienbaum\",\"Orbit\",\"Orbitron\",\"Oregano\",\"Orelega One\",\"Orienta\",\"Original Surfer\",\"Oswald\",\"Outfit\",\"Over the Rainbow\",\"Overlock\",\"Overlock SC\",\"Overpass\",\"Overpass Mono\",\"Ovo\",\"Oxanium\",\"Oxygen\",\"Oxygen Mono\",\"PT Mono\",\"PT Sans\",\"PT Sans Caption\",\"PT Sans Narrow\",\"PT Serif\",\"PT Serif Caption\",\"Pacifico\",\"Padauk\",\"Padyakke Expanded One\",\"Palanquin\",\"Palanquin Dark\",\"Palette Mosaic\",\"Pangolin\",\"Paprika\",\"Parisienne\",\"Passero One\",\"Passion One\",\"Passions Conflict\",\"Pathway Extreme\",\"Pathway Gothic One\",\"Patrick Hand\",\"Patrick Hand SC\",\"Pattaya\",\"Patua One\",\"Pavanam\",\"Paytone One\",\"Peddana\",\"Peralta\",\"Permanent Marker\",\"Petemoss\",\"Petit Formal Script\",\"Petrona\",\"Philosopher\",\"Phudu\",\"Piazzolla\",\"Piedra\",\"Pinyon Script\",\"Pirata One\",\"Pixelify Sans\",\"Plaster\",\"Play\",\"Playball\",\"Playfair\",\"Playfair Display\",\"Playfair Display SC\",\"Playpen Sans\",\"Plus Jakarta Sans\",\"Podkova\",\"Poiret One\",\"Poller One\",\"Poltawski Nowy\",\"Poly\",\"Pompiere\",\"Pontano Sans\",\"Poor Story\",\"Poppins\",\"Port Lligat Sans\",\"Port Lligat Slab\",\"Potta One\",\"Pragati Narrow\",\"Praise\",\"Prata\",\"Preahvihear\",\"Press Start 2P\",\"Pridi\",\"Princess Sofia\",\"Prociono\",\"Prompt\",\"Prosto One\",\"Proza Libre\",\"Public Sans\",\"Puppies Play\",\"Puritan\",\"Purple Purse\",\"Qahiri\",\"Quando\",\"Quantico\",\"Quattrocento\",\"Quattrocento Sans\",\"Questrial\",\"Quicksand\",\"Quintessential\",\"Qwigley\",\"Qwitcher Grypen\",\"REM\",\"Racing Sans One\",\"Radio Canada\",\"Radley\",\"Rajdhani\",\"Rakkas\",\"Raleway\",\"Raleway Dots\",\"Ramabhadra\",\"Ramaraja\",\"Rambla\",\"Rammetto One\",\"Rampart One\",\"Ranchers\",\"Rancho\",\"Ranga\",\"Rasa\",\"Rationale\",\"Ravi Prakash\",\"Readex Pro\",\"Recursive\",\"Red Hat Display\",\"Red Hat Mono\",\"Red Hat Text\",\"Red Rose\",\"Redacted\",\"Redacted Script\",\"Redressed\",\"Reem Kufi\",\"Reem Kufi Fun\",\"Reem Kufi Ink\",\"Reenie Beanie\",\"Reggae One\",\"Rethink Sans\",\"Revalia\",\"Rhodium Libre\",\"Ribeye\",\"Ribeye Marrow\",\"Righteous\",\"Risque\",\"Road Rage\",\"Roboto\",\"Roboto Condensed\",\"Roboto Flex\",\"Roboto Mono\",\"Roboto Serif\",\"Roboto Slab\",\"Rochester\",\"Rock 3D\",\"Rock Salt\",\"RocknRoll One\",\"Rokkitt\",\"Romanesco\",\"Ropa Sans\",\"Rosario\",\"Rosarivo\",\"Rouge Script\",\"Rowdies\",\"Rozha One\",\"Rubik\",\"Rubik 80s Fade\",\"Rubik Beastly\",\"Rubik Broken Fax\",\"Rubik Bubbles\",\"Rubik Burned\",\"Rubik Dirt\",\"Rubik Distressed\",\"Rubik Doodle Shadow\",\"Rubik Doodle Triangles\",\"Rubik Gemstones\",\"Rubik Glitch\",\"Rubik Glitch Pop\",\"Rubik Iso\",\"Rubik Lines\",\"Rubik Maps\",\"Rubik Marker Hatch\",\"Rubik Maze\",\"Rubik Microbe\",\"Rubik Mono One\",\"Rubik Moonrocks\",\"Rubik Pixels\",\"Rubik Puddles\",\"Rubik Scribble\",\"Rubik Spray Paint\",\"Rubik Storm\",\"Rubik Vinyl\",\"Rubik Wet Paint\",\"Ruda\",\"Rufina\",\"Ruge Boogie\",\"Ruluko\",\"Rum Raisin\",\"Ruslan Display\",\"Russo One\",\"Ruthie\",\"Ruwudu\",\"Rye\",\"STIX Two Text\",\"Sacramento\",\"Sahitya\",\"Sail\",\"Saira\",\"Saira Condensed\",\"Saira Extra Condensed\",\"Saira Semi Condensed\",\"Saira Stencil One\",\"Salsa\",\"Sanchez\",\"Sancreek\",\"Sansita\",\"Sansita Swashed\",\"Sarabun\",\"Sarala\",\"Sarina\",\"Sarpanch\",\"Sassy Frass\",\"Satisfy\",\"Sawarabi Gothic\",\"Sawarabi Mincho\",\"Scada\",\"Scheherazade New\",\"Schibsted Grotesk\",\"Schoolbell\",\"Scope One\",\"Seaweed Script\",\"Secular One\",\"Sedgwick Ave\",\"Sedgwick Ave Display\",\"Sen\",\"Send Flowers\",\"Sevillana\",\"Seymour One\",\"Shadows Into Light\",\"Shadows Into Light Two\",\"Shalimar\",\"Shantell Sans\",\"Shanti\",\"Share\",\"Share Tech\",\"Share Tech Mono\",\"Shippori Antique\",\"Shippori Antique B1\",\"Shippori Mincho\",\"Shippori Mincho B1\",\"Shizuru\",\"Shojumaru\",\"Short Stack\",\"Shrikhand\",\"Siemreap\",\"Sigmar\",\"Sigmar One\",\"Signika\",\"Signika Negative\",\"Silkscreen\",\"Simonetta\",\"Single Day\",\"Sintony\",\"Sirin Stencil\",\"Six Caps\",\"Sixtyfour\",\"Skranji\",\"Slabo 13px\",\"Slabo 27px\",\"Slackey\",\"Slackside One\",\"Smokum\",\"Smooch\",\"Smooch Sans\",\"Smythe\",\"Sniglet\",\"Snippet\",\"Snowburst One\",\"Sofadi One\",\"Sofia\",\"Sofia Sans\",\"Sofia Sans Condensed\",\"Sofia Sans Extra Condensed\",\"Sofia Sans Semi Condensed\",\"Solitreo\",\"Solway\",\"Sometype Mono\",\"Song Myung\",\"Sono\",\"Sonsie One\",\"Sora\",\"Sorts Mill Goudy\",\"Source Code Pro\",\"Source Sans 3\",\"Source Serif 4\",\"Space Grotesk\",\"Space Mono\",\"Special Elite\",\"Spectral\",\"Spectral SC\",\"Spicy Rice\",\"Spinnaker\",\"Spirax\",\"Splash\",\"Spline Sans\",\"Spline Sans Mono\",\"Squada One\",\"Square Peg\",\"Sree Krushnadevaraya\",\"Sriracha\",\"Srisakdi\",\"Staatliches\",\"Stalemate\",\"Stalinist One\",\"Stardos Stencil\",\"Stick\",\"Stick No Bills\",\"Stint Ultra Condensed\",\"Stint Ultra Expanded\",\"Stoke\",\"Strait\",\"Style Script\",\"Stylish\",\"Sue Ellen Francisco\",\"Suez One\",\"Sulphur Point\",\"Sumana\",\"Sunflower\",\"Sunshiney\",\"Supermercado One\",\"Sura\",\"Suranna\",\"Suravaram\",\"Suwannaphum\",\"Swanky and Moo Moo\",\"Syncopate\",\"Syne\",\"Syne Mono\",\"Syne Tactile\",\"Tai Heritage Pro\",\"Tajawal\",\"Tangerine\",\"Tapestry\",\"Taprom\",\"Tauri\",\"Taviraj\",\"Teko\",\"Tektur\",\"Telex\",\"Tenali Ramakrishna\",\"Tenor Sans\",\"Text Me One\",\"Texturina\",\"Thasadith\",\"The Girl Next Door\",\"The Nautigal\",\"Tienne\",\"Tillana\",\"Tilt Neon\",\"Tilt Prism\",\"Tilt Warp\",\"Timmana\",\"Tinos\",\"Tiro Bangla\",\"Tiro Devanagari Hindi\",\"Tiro Devanagari Marathi\",\"Tiro Devanagari Sanskrit\",\"Tiro Gurmukhi\",\"Tiro Kannada\",\"Tiro Tamil\",\"Tiro Telugu\",\"Titan One\",\"Titillium Web\",\"Tomorrow\",\"Tourney\",\"Trade Winds\",\"Train One\",\"Trirong\",\"Trispace\",\"Trocchi\",\"Trochut\",\"Truculenta\",\"Trykker\",\"Tsukimi Rounded\",\"Tulpen One\",\"Turret Road\",\"Twinkle Star\",\"Ubuntu\",\"Ubuntu Condensed\",\"Ubuntu Mono\",\"Uchen\",\"Ultra\",\"Unbounded\",\"Uncial Antiqua\",\"Underdog\",\"Unica One\",\"UnifrakturCook\",\"UnifrakturMaguntia\",\"Unkempt\",\"Unlock\",\"Unna\",\"Updock\",\"Urbanist\",\"VT323\",\"Vampiro One\",\"Varela\",\"Varela Round\",\"Varta\",\"Vast Shadow\",\"Vazirmatn\",\"Vesper Libre\",\"Viaoda Libre\",\"Vibes\",\"Vibur\",\"Victor Mono\",\"Vidaloka\",\"Viga\",\"Vina Sans\",\"Voces\",\"Volkhov\",\"Vollkorn\",\"Vollkorn SC\",\"Voltaire\",\"Vujahday Script\",\"Waiting for the Sunrise\",\"Wallpoet\",\"Walter Turncoat\",\"Warnes\",\"Water Brush\",\"Waterfall\",\"Wavefont\",\"Wellfleet\",\"Wendy One\",\"Whisper\",\"WindSong\",\"Wire One\",\"Wix Madefor Display\",\"Wix Madefor Text\",\"Work Sans\",\"Workbench\",\"Xanh Mono\",\"Yaldevi\",\"Yanone Kaffeesatz\",\"Yantramanav\",\"Yatra One\",\"Yellowtail\",\"Yeon Sung\",\"Yeseva One\",\"Yesteryear\",\"Yomogi\",\"Young Serif\",\"Yrsa\",\"Ysabeau\",\"Ysabeau Infant\",\"Ysabeau Office\",\"Ysabeau SC\",\"Yuji Boku\",\"Yuji Hentaigana Akari\",\"Yuji Hentaigana Akebono\",\"Yuji Mai\",\"Yuji Syuku\",\"Yusei Magic\",\"ZCOOL KuaiLe\",\"ZCOOL QingKe HuangYou\",\"ZCOOL XiaoWei\",\"Zen Antique\",\"Zen Antique Soft\",\"Zen Dots\",\"Zen Kaku Gothic Antique\",\"Zen Kaku Gothic New\",\"Zen Kurenaido\",\"Zen Loop\",\"Zen Maru Gothic\",\"Zen Old Mincho\",\"Zen Tokyo Zoo\",\"Zeyada\",\"Zhi Mang Xing\",\"Zilla Slab\",\"Zilla Slab Highlight\"],\"description\":\"The font to use in the app.\\n\\nAny font available on [Google Fonts](https://fonts.google.com) may be used.\\n\",\"default\":{\"family\":\"Open Sans\",\"source\":\"google\"}}}},\"GroupMember\":{\"type\":\"object\",\"description\":\"An object representing a member of a group\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The id of the app member.\"},\"role\":{\"type\":\"string\",\"description\":\"The role of the app member within the group.\"},\"name\":{\"$ref\":\"#/components/schemas/AppMember/properties/name\"},\"email\":{\"$ref\":\"#/components/schemas/AppMember/properties/email\"}}},\"GroupMemberDeleteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"id\"],\"properties\":{\"type\":{\"enum\":[\"group.member.delete\"],\"description\":\"Delete a group member from the group in which the invoking user is a member\"},\"id\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The id of the group member to delete\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"GroupMemberInviteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"group.member.invite\"],\"description\":\"Invite an app member to join a group.\"},\"id\":{\"description\":\"The ID of the group to invite the app member to.\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"email\":{\"description\":\"The email address of the user to invite.\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"role\":{\"description\":\"The role to invite the user as.\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"GroupMemberQueryActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"id\"],\"properties\":{\"type\":{\"enum\":[\"group.member.query\"],\"description\":\"Get a list of a group's members\"},\"id\":{\"description\":\"The ID of a specific group to get the members from\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"GroupMemberRoleUpdateActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"id\",\"role\"],\"properties\":{\"type\":{\"enum\":[\"group.member.role.update\"],\"description\":\"Update the role of a group member.\"},\"id\":{\"description\":\"The id of the group member to update the role of.\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"role\":{\"description\":\"The new role of the group member.\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"GroupQueryActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"group.query\"],\"description\":\"Get a list of all of the groups in an app.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"Health\":{\"type\":\"object\",\"description\":\"A health check status\",\"readOnly\":true,\"additionalProperties\":false,\"properties\":{\"database\":{\"type\":\"boolean\",\"description\":\"Whether or not the database status is healthy\"}}},\"JSONPointer\":{\"type\":\"object\",\"description\":\"A JSON pointer which may be used to reference a JSON schema.\",\"additionalProperties\":false,\"required\":[\"$ref\"],\"properties\":{\"$ref\":{\"type\":\"string\",\"description\":\"A JSON schema reference.\",\"pattern\":\"^#\\\\/definitions\\\\/\",\"example\":\"#/definitions/MyReusableSchema\"},\"default\":{\"description\":\"The default value that will be used.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchema\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/JSONPointer\"},{\"$ref\":\"#/components/schemas/JSONSchemaAnyOf\"},{\"$ref\":\"#/components/schemas/JSONSchemaArray\"},{\"$ref\":\"#/components/schemas/JSONSchemaBoolean\"},{\"$ref\":\"#/components/schemas/JSONSchemaConst\"},{\"$ref\":\"#/components/schemas/JSONSchemaEnum\"},{\"$ref\":\"#/components/schemas/JSONSchemaInteger\"},{\"$ref\":\"#/components/schemas/JSONSchemaMultiType\"},{\"$ref\":\"#/components/schemas/JSONSchemaNot\"},{\"$ref\":\"#/components/schemas/JSONSchemaNull\"},{\"$ref\":\"#/components/schemas/JSONSchemaNumber\"},{\"$ref\":\"#/components/schemas/JSONSchemaObject\"},{\"$ref\":\"#/components/schemas/JSONSchemaOneOf\"},{\"$ref\":\"#/components/schemas/JSONSchemaRemapper\"},{\"$ref\":\"#/components/schemas/JSONSchemaString\"}]},\"JSONSchemaAnyOf\":{\"type\":\"object\",\"description\":\"A JSON schema which determines the value must match one or more of the given schemas.\",\"additionalProperties\":false,\"required\":[\"anyOf\"],\"properties\":{\"anyOf\":{\"type\":\"array\",\"description\":\"The JSON schema must match one or more of the given schemas.\",\"items\":{\"$ref\":\"#/components/schemas/JSONSchema\"}},\"examples\":{\"type\":\"array\",\"description\":\"An example value which is valid according to this schema.\",\"items\":{}},\"default\":{\"description\":\"The default value which is used if no value is supplied.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaArray\":{\"type\":\"object\",\"description\":\"A JSON schema for an array.\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"array\"],\"description\":\"The type of the JSON schema. An array means a list of data.\"},\"example\":{\"type\":\"array\",\"description\":\"An example array which is valid according to this schema.\",\"items\":{\"type\":\"array\",\"items\":{}}},\"default\":{\"type\":\"array\",\"description\":\"The default value which is used if no value is supplied.\",\"items\":{}},\"maxItems\":{\"type\":\"integer\",\"description\":\"The minimum amount of items the array is allowed to have.\",\"minimum\":1},\"minItems\":{\"type\":\"integer\",\"description\":\"The maximum amount of items the array is allowed to have.\",\"minimum\":0},\"uniqueItems\":{\"type\":\"boolean\",\"description\":\"If true, all items in the array need to be unique\",\"default\":false},\"items\":{\"$ref\":\"#/components/schemas/JSONSchema\",\"description\":\"This property describes what the items in an array should look like.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaBoolean\":{\"type\":\"object\",\"description\":\"A JSON schema for a boolean.\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"boolean\"],\"description\":\"The type of the JSON schema. A boolean means either true or false.\"},\"examples\":{\"type\":\"array\",\"items\":{\"type\":\"boolean\",\"description\":\"An example boolean which is valid according to this schema.\"}},\"default\":{\"type\":\"boolean\",\"description\":\"The default value which is used if no value is supplied.\"},\"enum\":{\"type\":\"array\",\"description\":\"If an enum is specified, the type can be safely removed.\",\"items\":{\"type\":\"boolean\"}},\"const\":{\"type\":\"boolean\",\"description\":\"If const is specified, the type can be safely removed.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaConst\":{\"type\":\"object\",\"description\":\"A JSON schema which describes a constant\",\"additionalProperties\":false,\"required\":[\"const\"],\"properties\":{\"const\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"string\"},{\"enum\":[null]}],\"description\":\"The given value must exactly match one the value specified here.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaEnum\":{\"type\":\"object\",\"description\":\"A JSON schema for an enum.\",\"additionalProperties\":false,\"required\":[\"enum\"],\"properties\":{\"enum\":{\"type\":\"array\",\"description\":\"A specific set of values this property is allowed to have.\",\"items\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"string\"},{\"enum\":[null]}]}},\"enumDescriptions\":{\"type\":\"array\",\"description\":\"An array is descriptions for the enum values.\\n\\nThe description is applied to the enum value at the same index.\",\"items\":{\"type\":\"string\"}},\"examples\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"string\"},{\"enum\":[null]}],\"description\":\"An example which is valid according to this schema.\"}},\"default\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"string\"},{\"enum\":[null]}],\"description\":\"The default value which is used if no value is supplied.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaInteger\":{\"type\":\"object\",\"description\":\"A JSON schema for an integer.\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"integer\"],\"description\":\"The type of the JSON schema. An integer means a fractionless number.\"},\"examples\":{\"type\":\"array\",\"items\":{\"type\":\"integer\",\"description\":\"An example integer which is valid according to this schema.\"}},\"default\":{\"type\":\"integer\",\"description\":\"The default value which is used if no value is supplied.\"},\"enum\":{\"type\":\"array\",\"description\":\"If an enum is specified, the type can be safely removed.\",\"items\":{\"type\":\"integer\"}},\"const\":{\"type\":\"integer\",\"description\":\"If const is specified, the type can be safely removed.\"},\"minimum\":{\"type\":\"integer\",\"description\":\"The minimum value of the number.\",\"example\":0},\"maximum\":{\"type\":\"integer\",\"description\":\"The maximum value of the number.\",\"example\":100},\"multipleOf\":{\"type\":\"integer\",\"description\":\"The value must be a multiple of this number.\\n\\nFor example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,\\n5, 7, 8, etc.\\n\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaMultiType\":{\"type\":\"object\",\"description\":\"A JSON schema which defines multiple types.\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"array\",\"uniqueItems\":true,\"minItems\":2,\"description\":\"The type of the JSON schema. It\\u2019s recommended to use only one.\",\"items\":{\"enum\":[\"array\",\"boolean\",\"integer\",\"null\",\"number\",\"string\"]}},\"examples\":{\"type\":\"array\",\"description\":\"An example which is valid according to this schema.\",\"items\":{}},\"default\":{\"description\":\"The default value which is used if no value is supplied.\"},\"maxItems\":{\"type\":\"integer\",\"description\":\"The minimum amount of items the array is allowed to have.\",\"minimum\":1},\"minItems\":{\"type\":\"integer\",\"description\":\"The maximum amount of items the array is allowed to have.\",\"minimum\":0},\"uniqueItems\":{\"type\":\"boolean\",\"description\":\"If true, all items in the array need to be unique\",\"default\":false},\"items\":{\"$ref\":\"#/components/schemas/JSONSchema\",\"description\":\"This property describes what the items in an array should look like.\"},\"minimum\":{\"type\":\"integer\",\"description\":\"The minimum value of the number.\",\"example\":0},\"maximum\":{\"type\":\"integer\",\"description\":\"The maximum value of the number.\",\"example\":100},\"multipleOf\":{\"type\":\"integer\",\"description\":\"The value must be a multiple of this number.\\n\\nFor example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,\\n5, 7, 8, etc.\\n\"},\"maxProperties\":{\"type\":\"integer\",\"description\":\"The maximum number of properties the object is allowed to have.\",\"minimum\":0},\"minProperties\":{\"type\":\"integer\",\"description\":\"The minimum number of properties the object is must have.\",\"minimum\":1},\"properties\":{\"type\":\"object\",\"description\":\"A mapping of object keys for the object to nested JSON schemas.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/JSONSchema\"}},\"required\":{\"type\":\"array\",\"description\":\"A list of properties that are required.\",\"minItems\":1,\"items\":{\"type\":\"string\",\"description\":\"A property name which is required on the object.\"}},\"additionalProperties\":{\"description\":\"Describe if this object is allowed to have properties besides those defined in `properties`\\n\\nIt\\u2019s recommended to set this to `false`.\\n\",\"example\":false,\"anyOf\":[{\"type\":\"boolean\",\"description\":\"If false, the object may not have any additional properties.\\n\\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\\n\"},{\"$ref\":\"#/components/schemas/JSONSchema\",\"description\":\"If this is a JSON schema, it describes any additional properties.\"}]},\"format\":{\"enum\":[\"date-time\",\"time\",\"date\",\"duration\",\"email\",\"idn-email\",\"hostname\",\"idn-hostname\",\"ipv4\",\"ipv6\",\"uuid\",\"uri\",\"uri-reference\",\"iri\",\"iri-reference\",\"uri-template\",\"json-pointer\",\"relative-json-pointer\",\"regex\",\"action\",\"binary\",\"event-emitter\",\"event-listener\",\"fontawesome\"],\"description\":\"The format values should adhere to.\"},\"minLength\":{\"type\":\"integer\",\"description\":\"The minimum length of the string.\",\"minimum\":1},\"maxLength\":{\"type\":\"integer\",\"description\":\"The maximum length of the string.\\n\\nIt\\u2019s highly recommended to set this property, even if it\\u2019s a big number. For example 5000 characters\\nis plenty for most larger input fields. Not doing so may result in extremely large user input, which\\nresults in a bad user experience.\\n\",\"minimum\":1,\"example\":5000},\"pattern\":{\"type\":\"string\",\"description\":\"A regular expression to describe user input.\\n\\nRegular expressions are a powerful way to enforce proper user input, but the learning curve is high.\\nIf you don\\u2019t know what this is, we recommend to omit this field for now.\\n\",\"minLength\":1,\"format\":\"regex\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaNot\":{\"type\":\"object\",\"description\":\"A JSON schema which may not be matched.\",\"additionalProperties\":false,\"required\":[\"not\"],\"properties\":{\"not\":{\"$ref\":\"#/components/schemas/JSONSchema\",\"description\":\"The JSON schema which the value may not match.\"},\"examples\":{\"type\":\"array\",\"description\":\"An example value which is valid according to this schema.\",\"items\":{}},\"default\":{\"description\":\"The default value which is used if no value is supplied.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaNull\":{\"type\":\"object\",\"description\":\"A JSON schema of type null only accepts a null value\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"null\"],\"description\":\"Only accept a null value.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaNumber\":{\"type\":\"object\",\"description\":\"A JSON schema for a number which has fractions.\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"number\"],\"description\":\"The type of the JSON schema. A number represents a number which has fractions. For fractionless numbers, use `integer` instead.\"},\"enum\":{\"type\":\"array\",\"description\":\"If an enum is specified, the type can be safely removed.\",\"items\":{\"type\":\"number\"}},\"const\":{\"type\":\"number\",\"description\":\"If const is specified, the type can be safely removed.\"},\"examples\":{\"type\":\"array\",\"items\":{\"type\":\"number\",\"description\":\"An example number which is valid according to this schema.\"}},\"default\":{\"type\":\"number\",\"description\":\"The default value which is used if no value is supplied.\"},\"minimum\":{\"type\":\"number\",\"description\":\"The minimum value of the number.\",\"example\":0},\"maximum\":{\"type\":\"number\",\"description\":\"The maximum value of the number.\",\"example\":100},\"exclusiveMinimum\":{\"type\":\"number\",\"description\":\"The value must be bigger than this number. The given value itself is not allowed.\"},\"exclusiveMaximum\":{\"type\":\"number\",\"description\":\"The value must be smaller than this number. The given value itself is not allowed.\"},\"multipleOf\":{\"type\":\"number\",\"description\":\"The value must be a multiple of this number.\\n\\nFor example, if this is set to 0.5, then the values 0, 0.5, 1, 1.5, 2, 2.5, etc. will be allowed,\\nbut not 0.3, 1.7, etc.\\n\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaObject\":{\"type\":\"object\",\"description\":\"A JSON schema for an object.\",\"additionalProperties\":false,\"required\":[\"type\",\"additionalProperties\"],\"properties\":{\"type\":{\"enum\":[\"object\"],\"description\":\"The type of the JSON schema.\"},\"examples\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"description\":\"An example object which is valid according to this schema.\",\"additionalProperties\":true}},\"default\":{\"type\":\"object\",\"description\":\"The default value which is used if no value is supplied.\",\"additionalProperties\":true},\"maxProperties\":{\"type\":\"integer\",\"description\":\"The maximum number of properties the object is allowed to have.\",\"minimum\":0},\"minProperties\":{\"type\":\"integer\",\"description\":\"The minimum number of properties the object is must have.\",\"minimum\":1},\"required\":{\"type\":\"array\",\"description\":\"A list of properties that are required.\",\"minItems\":1,\"items\":{\"type\":\"string\",\"description\":\"A property name which is required on the object.\"}},\"properties\":{\"type\":\"object\",\"description\":\"A mapping of object keys for the object to nested JSON schemas.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/JSONSchema\"}},\"additionalProperties\":{\"description\":\"Describe if this object is allowed to have properties besides those defined in `properties`\\n\\nIt\\u2019s recommended to set this to `false`.\\n\",\"example\":false,\"anyOf\":[{\"type\":\"boolean\",\"description\":\"If false, the object may not have any additional properties.\\n\\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\\n\"},{\"$ref\":\"#/components/schemas/JSONSchema\",\"description\":\"If this is a JSON schema, it describes any additional properties.\"}]},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaOneOf\":{\"type\":\"object\",\"description\":\"A JSON schema which determines the value must match exactly one of the given schemas.\",\"additionalProperties\":false,\"required\":[\"oneOf\"],\"properties\":{\"oneOf\":{\"type\":\"array\",\"description\":\"The JSON schema must match exactly one of the given schemas.\",\"items\":{\"$ref\":\"#/components/schemas/JSONSchema\"}},\"example\":{\"description\":\"An example value which is valid according to this schema.\"},\"default\":{\"description\":\"The default value which is used if no value is supplied.\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaRemapper\":{\"type\":\"object\",\"description\":\"A JSON schema which allows a format of remapper without a type.\",\"additionalProperties\":false,\"required\":[\"format\"],\"properties\":{\"format\":{\"enum\":[\"remapper\"],\"description\":\"Allow a remapper definition. This is supported for blocks only.\"},\"default\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"JSONSchemaRoot\":{\"type\":\"object\",\"description\":\"A top level JSON schema.\",\"additionalProperties\":false,\"properties\":{\"definitions\":{\"description\":\"This property may be used to store JSON schemas that may be referenced from other places.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/JSONSchema\"}},\"$schema\":{\"description\":\"The JSON schema meta schema. You probably don\\u2019t need to specify this explicitly.\",\"enum\":[\"http://json-schema.org/draft-04/schema#\",\"http://json-schema.org/draft-07/schema#\"],\"default\":\"http://json-schema.org/draft-07/schema#\"},\"type\":{\"enum\":[\"object\"],\"description\":\"The type of the JSON schema.\"},\"examples\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"description\":\"An example object which is valid according to this schema.\",\"additionalProperties\":true}},\"default\":{\"type\":\"object\",\"description\":\"The default value which is used if no value is supplied.\",\"additionalProperties\":true},\"maxProperties\":{\"type\":\"integer\",\"description\":\"The maximum number of properties the object is allowed to have.\",\"minimum\":0},\"minProperties\":{\"type\":\"integer\",\"description\":\"The minimum number of properties the object is must have.\",\"minimum\":1},\"required\":{\"type\":\"array\",\"description\":\"A list of properties that are required.\",\"minItems\":1,\"items\":{\"type\":\"string\",\"description\":\"A property name which is required on the object.\"}},\"properties\":{\"type\":\"object\",\"description\":\"A mapping of object keys for the object to nested JSON schemas.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/JSONSchema\"}},\"additionalProperties\":{\"description\":\"Describe if this object is allowed to have properties besides those defined in `properties`\\n\\nIt\\u2019s recommended to set this to `false`.\\n\",\"example\":false,\"anyOf\":[{\"type\":\"boolean\",\"description\":\"If false, the object may not have any additional properties.\\n\\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\\n\"},{\"$ref\":\"#/components/schemas/JSONSchema\",\"description\":\"If this is a JSON schema, it describes any additional properties.\"}]},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}},\"required\":[\"type\",\"additionalProperties\"]},\"JSONSchemaString\":{\"type\":\"object\",\"description\":\"A JSON schema for a string.\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"string\"],\"description\":\"The type of the JSON schema. A string is the technical term for a piece of text.\"},\"examples\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"An example string which is valid according to this schema.\"}},\"default\":{\"type\":\"string\",\"description\":\"The default value which is used if no value is supplied.\"},\"enum\":{\"type\":\"array\",\"description\":\"If an enum is specified, the type can be safely removed.\",\"items\":{\"type\":\"string\"}},\"const\":{\"type\":\"string\",\"description\":\"If const is specified, the type can be safely removed.\"},\"format\":{\"enum\":[\"date-time\",\"time\",\"date\",\"duration\",\"email\",\"idn-email\",\"hostname\",\"idn-hostname\",\"ipv4\",\"ipv6\",\"uuid\",\"uri\",\"uri-reference\",\"iri\",\"iri-reference\",\"uri-template\",\"json-pointer\",\"relative-json-pointer\",\"regex\",\"action\",\"binary\",\"event-emitter\",\"event-listener\",\"fontawesome\"],\"description\":\"The format values should adhere to.\"},\"minLength\":{\"type\":\"integer\",\"description\":\"The minimum length of the string.\",\"minimum\":1},\"maxLength\":{\"type\":\"integer\",\"description\":\"The maximum length of the string.\\n\\nIt\\u2019s highly recommended to set this property, even if it\\u2019s a big number. For example 5000 characters\\nis plenty for most larger input fields. Not doing so may result in extremely large user input, which\\nresults in a bad user experience.\\n\",\"minimum\":1,\"example\":5000},\"pattern\":{\"type\":\"string\",\"description\":\"A regular expression to describe user input.\\n\\nRegular expressions are a powerful way to enforce proper user input, but the learning curve is high.\\nIf you don\\u2019t know what this is, we recommend to omit this field for now.\\n\",\"minLength\":1,\"format\":\"regex\"},\"multiline\":{\"type\":\"boolean\",\"description\":\"If true, Appsemble renders a textarea in the graphical JSON editor.\",\"default\":false},\"title\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":50,\"description\":\"A short title of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"},\"description\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":5000,\"description\":\"A description of the instance.\\n\\nThis is used in various places inside Appsemble Studio.\\n\"}}},\"LinkActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"to\"],\"properties\":{\"type\":{\"enum\":[\"link\"],\"description\":\"The link action can be used to redirect the user to other pages or absolute URLs.\"},\"to\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"$ref\":\"#/components/schemas/RemapperDefinition\"}],\"description\":\"The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"LinkBackActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"link.back\"],\"description\":\"Link back to the previous page in the browser history.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"LinkNextActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"link.next\"],\"description\":\"Link to the next page in the browser history.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"LogActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"log\"],\"description\":\"Output the result of the action into the console.\\n\\nThis is mostly useful for debugging blocks during development.\\n\"},\"level\":{\"enum\":[\"error\",\"info\",\"warn\"],\"default\":\"info\",\"description\":\"The logging level on which to log.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"LoopPageActionsDefinition\":{\"type\":\"object\",\"description\":\"These actions are fired on a loop page.\",\"required\":[\"onLoad\"],\"additionalProperties\":false,\"properties\":{\"onLoad\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action is used to define the data to pass onto the loop type array\"},\"onFlowCancel\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action gets triggered when `flow.cancel` gets called.\"},\"onFlowFinish\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action gets triggered when a flow is finished.\\n\\nA flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final\\nsubpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action.\"}}},\"LoopPageDefinition\":{\"type\":\"object\",\"description\":\"Generates sub pages dynamically based on data and display in a flow page.\",\"required\":[\"type\",\"foreach\",\"actions\",\"name\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"enum\":[\"loop\"]},\"actions\":{\"$ref\":\"#/components/schemas/LoopPageActionsDefinition\"},\"foreach\":{\"$ref\":\"#/components/schemas/SubPage\"},\"progress\":{\"description\":\"The method that should be used to display the status of flow pages.\",\"enum\":[\"corner-dots\",\"hidden\"]},\"retainFlowData\":{\"type\":\"boolean\",\"description\":\"Whether to retain the flow data when navigating away to another page outside the flow.\\n\\nBy default the flow page retains it's data after navigating once. Set to false to clear it.\\n\",\"default\":true},\"name\":{\"type\":\"string\",\"maxLength\":50,\"description\":\"The name of an app.\\n\\nThis field is always required and must be unique within the app, meaning that it is not possible to\\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\\n\\n> **Note**: The URL used to navigate to pages is determined by this property.\\n\"},\"hideName\":{\"type\":\"boolean\",\"description\":\"Whether or not the page name should be displayed in the *app bar*.\"},\"navTitle\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the page when displayed in the navigation menu.\\n\\n Context property `name` can be used to access the name of the page.\\n \"},\"hideNavTitle\":{\"type\":\"boolean\",\"description\":\"Whether or not the page should be displayed in navigational menus.\\n\\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\\n page from menus.\\n \",\"default\":false},\"navigation\":{\"$ref\":\"#/components/schemas/AppLayoutDefinition/properties/navigation\",\"description\":\"The type of navigation displayed on the page.\\n\\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\\nApp navigation are not set.\\n\\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\\nmenu. Set to `hidden` to display no navigational menus at all.\\n\"},\"icon\":{\"type\":\"string\",\"description\":\"An optional icon from the fontawesome icon set\\n\\nThis will be displayed in the navigation menu.\\n\"},\"parameters\":{\"type\":\"array\",\"description\":\"Page parameters can be used for linking to a page that should display a single resource.\\n\\nThis defined as a list of strings representing the properties to pass through. More often than not\\npassing `id` through is sufficient, depending on the block.\\n\",\"items\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":30}},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this page.\\n\\nIf the user doesn\\u2019t have any of the roles in the list the page will be unavailable to them. An empty\\nlist can be used to specify that users need to log in but do not need a specific role.\\n\\nUsers trying to visit a page without having the correct roles will be redirected to the first page\\nthat they are allowed to view. If there aren\\u2019t any accessible pages, the user will be logged out and\\ninstructed to contact the app owner to get permissions.\\n\",\"items\":{\"type\":\"string\"}},\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"badgeCount\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A Remapper that resolves to a number to be visibile in the side-menu.\"}}},\"MatchActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"match\"],\"properties\":{\"type\":{\"enum\":[\"match\"],\"description\":\"Run another action if one of the cases is true.\\n\\nOnly the first case that equals true is called.\"},\"match\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"case\",\"action\"],\"description\":\"\",\"properties\":{\"case\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The case to be matched.\"},\"action\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"Action to be called if the case equals true.\"}}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"MessageActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"body\"],\"properties\":{\"type\":{\"enum\":[\"message\"],\"description\":\"Display a message to the user.\\n\\nThis is useful in combination with action chaining to notify users they have performed a certain action.\\n\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The body of the message.\"},\"color\":{\"enum\":[\"dark\",\"primary\",\"link\",\"success\",\"info\",\"warning\",\"danger\"],\"default\":\"info\",\"description\":\"The Bulma color to apply to the message.\"},\"layout\":{\"enum\":[\"bottom\",\"top\"],\"default\":\"bottom\",\"description\":\"The position of the message on the screen.\"},\"dismissable\":{\"type\":\"boolean\",\"description\":\"Boolean value indicating whether the user is able to dismiss the message manually.\"},\"timeout\":{\"type\":\"integer\",\"default\":5000,\"description\":\"The time in milliseconds how long the message should be visible.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"NoopActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"noop\"],\"description\":\"Do nothing when this action is triggered.\\n\\nThis is the default action for block actions that are not required.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"NotificationHookDataDefinition\":{\"type\":\"object\",\"description\":\"The data used to display the content of the notification.\",\"additionalProperties\":true,\"minProperties\":1,\"properties\":{\"title\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The title of the notification.\"},\"content\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The body of the notification.\"},\"link\":{\"type\":\"string\",\"description\":\"The URL of the page the user gets redirected to after being clicked.\\n\\nIf the URL is relative, it will be relative to the app.\\n\"}}},\"NotificationHookDefinition\":{\"type\":\"object\",\"description\":\"The strategy used to notify users.\",\"additionalProperties\":false,\"minProperties\":1,\"properties\":{\"to\":{\"type\":\"array\",\"description\":\"The list of roles to notify.\\n\\nAside from roles, `$author` can also be used to notify the author of the resource.\\n\",\"minItems\":1,\"items\":{\"type\":\"string\"}},\"subscribe\":{\"description\":\"If set, allows users to manually subscribe for notifications for this resource regardless of roles.\\n\\nThe following values are allowed:\\n- `all`: Allows users to be notified about actions on all of the resources of this type.\\n- `single`: Allows users to be notified about actions a single instance of a resource of this\\n type.\\n- `both`: Allows users to be notified about all resources or a single resource of this type.\\n\",\"enum\":[\"all\",\"single\",\"both\"]},\"data\":{\"$ref\":\"#/components/schemas/NotificationHookDataDefinition\"}}},\"NotifyActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"title\",\"body\",\"to\"],\"properties\":{\"type\":{\"enum\":[\"notify\"],\"description\":\"Send notifications to one or all the users of an app.\"},\"title\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The title of the notification.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The description of the notification.\"},\"to\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"To whom the notification should be sent.\\n\\nUse `all` to send the notification to all app subscribed users.\\nOr notify specific users by passing either a single user id or an array of user ids.\\n\\nNothing is sent if the value is **not** a valid user id.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"OAuth2AuthorizationCode\":{\"type\":\"object\",\"description\":\"OAuth2 client credentials\",\"required\":[\"code\"],\"additionalProperties\":false,\"properties\":{\"code\":{\"type\":\"string\",\"description\":\"The OAuth2 authorization code.\",\"readOnly\":true}}},\"OAuth2ClientCredentials\":{\"type\":\"object\",\"description\":\"OAuth2 client credentials\",\"required\":[\"description\",\"scopes\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"The generated client id\",\"readOnly\":true},\"secret\":{\"type\":\"string\",\"description\":\"The generated client secret\",\"readOnly\":true},\"description\":{\"type\":\"string\",\"description\":\"A description for the user to recognize the client.\",\"maxLength\":50},\"expires\":{\"type\":\"string\",\"description\":\"When the client credentials expire automatically.\",\"format\":\"date-time\"},\"scopes\":{\"type\":\"array\",\"description\":\"The scopes that have been granted to the client.\",\"items\":{\"enum\":[\"apps:export\",\"apps:write\",\"apps:delete\",\"blocks:write\",\"blocks:delete\",\"organizations:write\",\"resources:read\",\"resources:write\",\"assets:write\",\"groups:read\",\"groups:write\"]}}}},\"ObjectRemapperDefinition\":{\"type\":\"object\",\"description\":\"An object based remapper is defined by a specific implementation\\n\\nObject based remappers may only define 1 key. The allowed value depends on the remapper.\\n\",\"minProperties\":1,\"maxProperties\":1,\"additionalProperties\":false,\"properties\":{\"array.map\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"\\nThe remapper goes through the given array and applies the given remappers on each individual item.\\nThis can be very handy when sorting arrays by certain data. The remapper always returns an array.\\nOutput can be an empty array if the supplied data isn\\u2019t an array.\\n\\nFor example, if you want to sort through a list of people and only get their occupations you can do\\nthe following:\\n\\nInput:\\n\\n```json\\n[\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\"\\n },\\n {\\n \\\"name\\\": \\\"Otto\\\",\\n \\\"occupation\\\": \\\"Scientist\\\"\\n },\\n {\\n \\\"name\\\": \\\"Harry\\\",\\n \\\"occupation\\\": \\\"CEO\\\"\\n }\\n]\\n```\\n```yaml\\narray.map:\\n object.omit:\\n - name\\n\\n```\\nResult:\\n\\n```json\\n[{\\\"occupation\\\":\\\"Delivery driver\\\"},{\\\"occupation\\\":\\\"Scientist\\\"},{\\\"occupation\\\":\\\"CEO\\\"}]\\n```\\n\\n\\nAnother great use for `array.map` is to combine it with the `if` remapper and sort your arrays on\\nspecific values.\\n\\nUsing the same input data from the previous example, look at how you can change the code to get\\npeople from a specific occupation:\\n\\n```yaml\\n- array.map:\\n if:\\n condition:\\n equals:\\n - prop: occupation\\n - Scientist\\n else: null\\n then:\\n object.from:\\n name:\\n prop: name\\n occupation:\\n prop: occupation\\n- null.strip: null\\n\\n```\\nResult:\\n\\n```json\\n[{\\\"name\\\":\\\"Otto\\\",\\\"occupation\\\":\\\"Scientist\\\"}]\\n```\\n\\n\\nBecause `array.map` returns an array, every item has to return something. This is why we have to\\nreturn the full object with the data we want in the `then` section. It\\u2019s also why we return `null`.\\nThis results in an array consisting of `null` values and objects with actual data in them. To solve\\nthis problem, we use the `null.strip` remapper to remove any null values which results in a clean\\narray.\\n\"},\"array.unique\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"\\nFilters out unique values from an array. The value Remapper is applied to each entry in the array\\nusing its result to determine uniqueness.\\n\\nIf the value Remapper results in undefined or null, the entire entry is used for uniqueness.\\n\\nIf the input is not an array, the input is returned without any modifications.\\n\\nInput:\\n\\n```json\\n[1,1,2,3]\\n```\\n```yaml\\narray.unique: null\\n\\n```\\nResult:\\n\\n```json\\n[1,2,3]\\n```\\n\\n\\nYou can also check for more complex values in arrays. The remapper accepts remappers as well, so you\\ncan also use entire objects to check for unique values.\\n\\nFor this example, we have the following extended data with some duplicate values:\\n\\n```json\\n[\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\",\\n \\\"age\\\": 19\\n },\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Photographer\\\",\\n \\\"age\\\": 19\\n },\\n {\\n \\\"name\\\": \\\"Otto\\\",\\n \\\"occupation\\\": \\\"Scientist\\\",\\n \\\"age\\\": 50\\n },\\n {\\n \\\"name\\\": \\\"Harry\\\",\\n \\\"occupation\\\": \\\"CEO\\\",\\n \\\"age\\\": 20\\n }\\n]\\n```\\n\\nWe can be fairly sure in this list of people the first two Peters are the same person but with a\\ndifferent occupation. To get more complex unique values from here, we can do the following:\\n\\n```yaml\\narray.unique:\\n object.from:\\n name: { prop: name }\\n age: { prop: age }\\n```\\n\\nThis then checks the array for unique values in both the `name` and `age` fields. The result of this\\nremapper is a filtered list:\\n\\n```json\\n[\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\",\\n \\\"age\\\": 19\\n },\\n {\\n \\\"name\\\": \\\"Otto\\\",\\n \\\"occupation\\\": \\\"Scientist\\\",\\n \\\"age\\\": 50\\n },\\n {\\n \\\"name\\\": \\\"Harry\\\",\\n \\\"occupation\\\": \\\"CEO\\\",\\n \\\"age\\\": 20\\n }\\n]\\n```\\n \"},\"array.filter\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"\\nFilters out values based on the input conditions provided.\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n[{\\\"name\\\":\\\"Peter\\\"},{\\\"name\\\":\\\"Louis\\\"},{\\\"name\\\":\\\"Brian\\\"}]\\n```\\n```yaml\\narray.filter:\\n equals:\\n - prop: name\\n - Louis\\n\\n```\\nResult:\\n\\n```json\\n[{\\\"name\\\":\\\"Louis\\\"}]\\n```\\n\\n\\nExample of how it can be used to filter a number array.\\n\\nInput:\\n\\n```json\\n[1,2,1,3,4,1,5]\\n```\\n\\n```yaml\\narray.filter:\\n equals:\\n - array: item\\n - 1\\n```\\n\\nResult:\\n\\n```json\\n[1,1,1]\\n```\\n \"},\"array.find\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"\\nReturns a single object or value from an array based on the given condition.\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n[{\\\"name\\\":\\\"Craig\\\"},{\\\"name\\\":\\\"Joey\\\"},{\\\"name\\\":\\\"Stuart\\\"}]\\n```\\n```yaml\\narray.find:\\n equals:\\n - prop: name\\n - Craig\\n\\n```\\nResult:\\n\\n```json\\n{\\\"name\\\":\\\"Craig\\\"}\\n```\\n\\n\"},\"array.from\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"\\nCreates a new array based on a provided array of remappers. This array can also consist of static\\nvalues.\\n\\nFor example:\\n\\n```yaml\\narray.from:\\n - Peter\\n - Otto\\n - Harry\\n\\n```\\nResult:\\n\\n```json\\n[\\\"Peter\\\",\\\"Otto\\\",\\\"Harry\\\"]\\n```\\n\\n\\nThis remapper can also be used to convert given data into an array.\\n\\nInput:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\"\\n}\\n```\\n\\n```yaml\\narray.from:\\n - root: null # Takes the data passed to this remapper, explained more in the 'Data' page\\n```\\n\\nResult:\\n\\n```json\\n[\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\"\\n }\\n]\\n```\\n \"},\"array.append\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"\\nAppend new values to the end of an array. If the input is not an array an empty array is returned.\\n\\nUsing the array from the previous example, we can add a new object on top of it using this remapper:\\n\\n```yaml\\narray.append:\\n - object.from:\\n name: James\\n occupation: News reporter\\n\\n```\\nResult:\\n\\n```json\\n[\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\"\\n },\\n {\\n \\\"name\\\": \\\"Otto\\\",\\n \\\"occupation\\\": \\\"Scientist\\\"\\n },\\n {\\n \\\"name\\\": \\\"Harry\\\",\\n \\\"occupation\\\": \\\"CEO\\\"\\n },\\n {\\n \\\"name\\\": \\\"James\\\",\\n \\\"occupation\\\": \\\"News reporter\\\"\\n }\\n]\\n```\\n\\n\\nExtra example:\\n\\narray remapper can also be used in combination with different remappers as in the current example comes object remapper:\\n\\nExample object:\\n```json\\n{\\n \\\"names\\\": [\\\"Bart\\\", \\\"Bas\\\", \\\"Sam\\\"]\\n}\\n```\\n\\nCombination of object and array remapper:\\n\\n```yaml\\nobject.assign:\\n names:\\n - { prop: Applicants }\\n - array.append:\\n - Kevin\\n```\\n\\nResult:\\n```json\\n{\\n \\\"names\\\": [\\\"Bart\\\", \\\"Bas\\\", \\\"Sam\\\", \\\"Kevin\\\"]\\n}\\n```\\n \"},\"array.omit\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"\\nRemove values from an array. The input is expected to be the index(es) of the items to be deleted.\\nAccepts an array of static or remapper values.\\n\\nWith the previous example we added a new person to the list of people, so now we can remove that\\nperson. We already know the index of this person in the array is `3`, so it\\u2019s easy:\\n\\n```yaml\\narray.omit:\\n - 3\\n\\n```\\nResult:\\n\\n```json\\n[\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"occupation\\\": \\\"Delivery driver\\\"\\n },\\n {\\n \\\"name\\\": \\\"Otto\\\",\\n \\\"occupation\\\": \\\"Scientist\\\"\\n },\\n {\\n \\\"name\\\": \\\"Harry\\\",\\n \\\"occupation\\\": \\\"CEO\\\"\\n }\\n]\\n```\\n\\n\\nHowever, usually we don\\u2019t know the exact index of the item we want to delete. Because the remapper\\naccepts remappers as input we can get the desired item\\u2019s ID from another source as well. Take the\\nfollowing example:\\n\\nIn this example we assume the data from the previous example is passed to this table block using a\\ndata loader\\u2019s emitting event called \\u201cpeople\\u201d. When the user clicks on one of the people in the\\ntable, it gets the list of people again. Using the index of this person, and the `array.omit`\\nremapper, the person gets removed from the list.\\n\\n```yaml\\ntype: table\\nversion: 0.20.38\\nevents:\\n listen:\\n data: people\\nparameters:\\n fields:\\n - label: Name\\n value: { prop: name }\\n onClick: removePerson\\n - label: Occupation\\n value: { prop: occupation }\\nactions:\\n removePerson:\\n type: resource.query\\n resource: citizensNYC\\n remapAfter:\\n array.omit:\\n - context: index # This gets the index of the item in the table, explained more in the 'Data' page.\\n onSuccess:\\n type: resource.update\\n resource: citizensNYC\\n```\\n \"},\"array.flatten\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"\\nFlatten an array. Accepts an array of static or remapper values.\\n\\nSay for example that each person has some pets. We could get an array of all pets like so:\\n\\nInput:\\n\\n```json\\n[\\n [\\n \\\"Milka\\\",\\n \\\"Sven\\\"\\n ],\\n \\\"Goldie\\\"\\n]\\n```\\nResult:\\n\\n```json\\n[\\\"Milka\\\",\\\"Sven\\\",\\\"Goldie\\\"]\\n```\\n\\n\"},\"array.contains\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"\\nChecks if the input array includes the provided item.\\nInput:\\n\\n```json\\n[1,2,3,4,5]\\n```\\n```yaml\\narray.contains:\\n static: 6\\n\\n```\\nResult:\\n\\n```json\\nfalse\\n```\\n\\n\"},\"if\":{\"type\":\"object\",\"description\":\"Check if condition results in a truthy value.\\n\\nReturns value of `then` if condition is truthy, otherwise it returns the value of `else`.\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n{\\\"guess\\\":4}\\n```\\n```yaml\\nif:\\n condition:\\n equals:\\n - prop: guess\\n - 4\\n then:\\n static: You guessed right!\\n else:\\n static: You guessed wrong!\\n\\n```\\nResult:\\n\\n```json\\n\\\"You guessed right!\\\"\\n```\\n\\n\\nInput:\\n\\n```json\\n{\\\"guess\\\":5}\\n```\\nResult:\\n\\n```json\\n\\\"You guessed wrong!\\\"\\n```\\n\\n\",\"additionalProperties\":false,\"required\":[\"condition\",\"then\",\"else\"],\"properties\":{\"condition\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The condition to check.\"},\"then\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"This remapper is used if the condition returns true.\"},\"else\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"This remapper is used if the condition returns false.\"}}},\"equals\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"Compare all computed remapper values against each other.\\n\\nReturns `true` if all entries are equal, otherwise `false`.\\n\\nIn the following example, if the `inputValue` and `expectedValue` are of the same value, the\\ncondition will return `true` and the `then` remapper will fire.\\n\\nInput:\\n\\n```json\\n{\\\"inputValue\\\":\\\"example\\\",\\\"expectedValue\\\":\\\"example\\\"}\\n```\\n```yaml\\nequals:\\n - prop: inputValue\\n - prop: expectedValue\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"gt\":{\"type\":\"array\",\"description\":\"**(gt = Greater than)**\\n\\nCompare the first computed remapper value with the second computed remapper value.\\n\\nReturns `true` if the first entry is greater than the second entry.\\n\\nFor example, if `stock` is more than 5 here, it returns `true`.\\n\\nInput:\\n\\n```json\\n{\\\"stock\\\":100}\\n```\\n```yaml\\ngt:\\n - prop: stock\\n - 5\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\",\"minItems\":2,\"maxItems\":2,\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"}},\"lt\":{\"type\":\"array\",\"description\":\"**(lt = Lesser than)\\n\\nCompare the first computed remapper value with the second computed remapper value.\\n\\nReturns `true` if the first entry is lesser than the second entry.\\n\\nFor example, if `stock` is less than 5 here, it returns `true`.\\n\\nInput:\\n\\n```json\\n{\\\"stock\\\":100}\\n```\\n```yaml\\ngt:\\n - prop: stock\\n - 5\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\",\"minItems\":2,\"maxItems\":2,\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"}},\"not\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"Compare all computed remapper values against the first.\\n\\nReturns `false` if all entries are equal to the first entry, otherwise `true`.\\n\\nIf only one remapper or none is passed, the remapper value gets computed and then inverted.\\n\\nIf `number` in the following example is something other than 4, the condition returns `true`.\\n\\nInput:\\n\\n```json\\n{\\\"number\\\":3}\\n```\\n```yaml\\nnot:\\n - prop: number\\n - 4\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"match\":{\"type\":\"array\",\"description\":\"Check if any case results in a truthy value.\\n\\nReturns the value of the first case where the condition equals true, otherwise returns null.\\n\\nIn the following example, let's say the `Gem` is a \\\"Ruby\\\". The match remapper then returns\\n`value: 75`.\\n\\nInput:\\n\\n```json\\n{\\\"Gem\\\":\\\"Ruby\\\"}\\n```\\n```yaml\\nmatch:\\n - case:\\n equals:\\n - prop: Gem\\n - Diamond\\n value: 100\\n - case:\\n equals:\\n - prop: Gem\\n - Ruby\\n value: 75\\n - case:\\n equals:\\n - prop: Gem\\n - Gold\\n value: 50\\n - case:\\n equals:\\n - prop: Gem\\n - Sapphire\\n value: 25\\n result: {}\\n\\n```\\nResult:\\n\\n```json\\n75\\n```\\n\\n\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"case\",\"value\"],\"description\":\"\",\"properties\":{\"case\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The condition to check.\"},\"value\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"This remapper is used if the case is true\"}}}},\"and\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"Compare all computed remapper values against each other.\\n\\nReturns `true` if all entries are equal to `true`, otherwise `false`.\\n\\nIf only one remapper or none is passed, the remapper value gets computed.\\n\\nInput:\\n\\n```json\\n{\\\"foo\\\":true}\\n```\\n```yaml\\nand:\\n - prop: foo\\n - true\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"or\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"Compare all computed remapper values against each other.\\n\\nReturns `false` if all entries are equal to `false`, otherwise `true`.\\n\\nIf only one remapper or none is passed, the remapper value gets computed.\\n\\nInput:\\n\\n```json\\n{\\\"foo\\\":true}\\n```\\n```yaml\\nor:\\n - prop: foo\\n - false\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"defined\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"Check if a value is defined. Returns `true` if defined, `false` if not.\\n\\nConsiders falsy values like `0`, `\\\"\\\"` and `false` as defined.\\n\\nThe `null` and `undefined` values are considered as not defined.\\n\\nInput:\\n\\n```json\\n[0,\\\"\\\",false,null,null]\\n```\\n```yaml\\narray.map:\\n defined:\\n array: item\\n\\n```\\nResult:\\n\\n```json\\n[true,true,true,false,false]\\n```\\n\\n\"},\"variable\":{\"type\":\"string\",\"description\":\"Get a predefined app variable by name\\n\\nFor example:\\n\\n```yaml\\nvariable: MY_VARIABLE\\n\\n```\\nResult:\\n\\n```json\\n\\\"variable value\\\"\\n```\\n\\n\"},\"array\":{\"enum\":[\"index\",\"length\",\"item\",\"prevItem\",\"nextItem\"],\"description\":\"Get the current array.map\\u2019s index, length, the current item, previous item or next item.\\n\\nReturns nothing when not in the context of `array.map\\u2019s`.\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n[\\\"a\\\",\\\"b\\\",\\\"c\\\"]\\n```\\n```yaml\\narray.map:\\n object.from:\\n index:\\n array: index\\n length:\\n array: length\\n item:\\n array: item\\n prevItem:\\n array: prevItem\\n nextItem:\\n array: nextItem\\n\\n```\\nResult:\\n\\n```json\\n[\\n {\\n \\\"index\\\": 0,\\n \\\"length\\\": 3,\\n \\\"item\\\": \\\"a\\\",\\n \\\"nextItem\\\": \\\"b\\\"\\n },\\n {\\n \\\"index\\\": 1,\\n \\\"length\\\": 3,\\n \\\"item\\\": \\\"b\\\",\\n \\\"prevItem\\\": \\\"a\\\",\\n \\\"nextItem\\\": \\\"c\\\"\\n },\\n {\\n \\\"index\\\": 2,\\n \\\"length\\\": 3,\\n \\\"item\\\": \\\"c\\\",\\n \\\"prevItem\\\": \\\"b\\\"\\n }\\n]\\n```\\n\\n\"},\"app\":{\"enum\":[\"id\",\"locale\",\"url\"],\"description\":\"Gives information about the current app. Using this remapper you can get access to the\\nfollowing information:\\n\\n- `id`: App ID\\n- `locale`: Current locale (user selected language) of the app\\n- `url`: Base URL of the app\\n\\nExample:\\n\\n```yaml\\napp: url\\n\\n```\\nResult:\\n\\n```json\\n\\\"https://example-app.example-organization.example.com\\\"\\n```\\n\\n\"},\"context\":{\"type\":\"string\",\"description\":\"Gets a property from custom context passed by blocks. This property is specific to each block. To\\nunderstand what the context of a certain block does, check the block\\u2019s description.\\n\\nFor this example, we will take the [`table`](/blocks/@appsemble/table/0.20.39) block. As of now,\\nthis block provides two options for context: `index` and `repeatedIndex`. Whenever you click on an\\nitem in the table, it gives the index of that table row in the associated action.\\n\\nSo with the following example:\\n\\n```yaml\\ntype: table\\nversion: 0.20.39\\nevents:\\n listen:\\n data: contextData\\nparameters:\\n fields:\\n - label: Name\\n value: { prop: name }\\n onClick: clickName\\n - label: Age\\n value: { prop: age }\\nactions:\\n clickName:\\n remapBefore:\\n context: index\\n type: log\\n```\\n\\nClicking on the first item would log `0`, the second item `1` and so on.\\n\"},\"history\":{\"type\":\"integer\",\"description\":\"> **Note:** This remapper is explained more in depth in the [History](/docs/remappers/history) page\\n\\nGives the data at the history entry at the specified history index. The history at specified index\\nis the data that is passed to that action.\\n\\n```yaml\\nremapBefore:\\n object.from:\\n title: Most influential bands of all time\\n content: ...\\ntype: noop # history 0\\nonSuccess:\\n type: resource.query # history 1\\n resource: people\\n onSuccess:\\n type: noop # history 2\\n onSuccess:\\n remapBefore:\\n history: 1\\n type: log # history 3\\n```\\n\\nResult:\\n\\n```json\\n{\\n \\\"title\\\": \\\"Most influential bands of all time\\\",\\n \\\"content\\\": ...\\n}\\n```\\n \"},\"tab.name\":{\"enum\":[null],\"description\":\"\\n\\nReturns the name of the current tab in a `tabs` page.\\n\\n```yaml\\nname: Example Page A\\ntype: tabs\\n tabs:\\n - name: Tab2\\n blocks:\\n - type: action-button\\n version: \\\"0.27.12\\\"\\n parameters:\\n icon: chevron-right\\n actions:\\n onClick:\\n type: log\\n remapBefore:\\n { tab.name: null }\\n```\\n \"},\"step\":{\"type\":\"string\",\"description\":\"\\n\\nWhile in a loop page, this remapper allows you to get properties from the data at the current index.\\n\\n```yaml\\nname: Survey\\ntype: loop\\nactions:\\n onLoad:\\n type: resource.query\\n resource: questions\\nforeach:\\n blocks:\\n - type: detail-viewer\\n version: 0.20.39\\n parameters:\\n fields:\\n - label: { step: title }\\n```\\n\\nWith this example, we load an array of questions that have the `title` property. What the `step`\\nremapper does in this case is show the title of the current question in the loop.\\n\\nThe result of this is a flow page where each page shows the question\\u2019s title.\\n\\n\"},\"page\":{\"enum\":[\"data\",\"url\"],\"description\":\"Gives actual information about the current page. This remapper gives access to the following\\ninformation:\\n\\n- `data`: Current page data (FlowPage)\\n- `url`: Full URL of the current page\\n\\nExample:\\n\\n```json\\n{\\n \\\"data\\\": {\\n \\\"name\\\": \\\"Peter\\\"\\n },\\n \\\"url\\\": \\\"https://example-app.examplecompany.appsemble.app/en/example-page-a\\\"\\n}\\n```\\n\\nThe page data only works in the context of a flow page. Let\\u2019s say you have a\\n[\\u201cFlowPage\\u201d](/docs/reference/app#-flow-page-definition) type with multiple subpages. Whenever you\\nnavigate to the next page it adds the data from that page to the flow page\\u2019s data. The page remapper\\nallows you to access this cumulative data.\\n\\nThe following page definition shows a page definition for a flow page where the user has to fill in\\nsome user information. For each subpage the result of `page: data` is shown.\\n\\n\\n```yaml\\nname: PageDataFlow\\ntype: flow\\nsteps:\\n # page: data = {}\\n - blocks:\\n - type: form\\n version: 0.20.39\\n parameters:\\n fields:\\n - name: name\\n type: string\\n actions:\\n onSubmit:\\n type: flow.next\\n # page: data = { name: \\\"Peter\\\" }\\n - blocks:\\n - type: form\\n version: 0.20.39\\n parameters:\\n fields:\\n - name: age\\n type: string\\n actions:\\n onSubmit:\\n type: flow.next\\n # page: data = { name: \\\"Peter\\\", age: \\\"47\\\" }\\n - blocks:\\n - type: data-loader\\n version: 0.20.39\\n actions:\\n onLoad:\\n remapBefore:\\n page: data\\n type: log\\n```\\n\\nThe result of the final page\\u2019s log would then be:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"age\\\": \\\"47\\\"\\n}\\n```\\n\\n\"},\"prop\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"array\",\"minItems\":1,\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"}]}},{\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/components/schemas/ObjectRemapperDefinition\"}},{\"$ref\":\"#/components/schemas/ObjectRemapperDefinition\"}],\"description\":\"Gets the chosen property from an object.\\n\\nInput:\\n\\n```json\\n{\\\"age\\\":52,\\\"name\\\":\\\"John\\\"}\\n```\\n```yaml\\nprop: name\\n\\n```\\nResult:\\n\\n```json\\n\\\"John\\\"\\n```\\n\\n\"},\"len\":{\"enum\":[null],\"description\":\"\\nReturns the length of an input array or an input string, unlike { array: length } remapper this remapper does not require\\nan array to be in the context. This can be very useful when working with nested arrays.\\nInput:\\n\\n```json\\n\\\"string\\\"\\n```\\n```yaml\\nlen: null\\n\\n```\\nResult:\\n\\n```json\\n6\\n```\\n\\n\"},\"root\":{\"enum\":[null],\"description\":\"Gets the input data as it was initially passed to the remapper function.\\n\\n```yaml\\ntype: resource.query\\nresource: people\\nquery:\\n object.from:\\n $filter: city eq 'Eindhoven'\\nonSuccess:\\n remapBefore:\\n object.from:\\n name: Residents of Eindhoven\\n people:\\n root: null\\n```\\n\\nResult:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Residents of Eindhoven\\\",\\n \\\"people\\\": [\\n {\\n \\\"name\\\": ...,\\n \\\"city\\\": \\\"Eindhoven\\\"\\n },\\n ...\\n ]\\n}\\n```\\n \"},\"static\":{\"description\":\"Create a static value\\n\\n```yaml\\nstatic: Hello!\\n\\n```\\nResult:\\n\\n```json\\n\\\"Hello!\\\"\\n```\\n\\n\"},\"translate\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"> **Note:** This is explained much more in depth at [Translating](/docs/guides/translating)\\n\\nThis remapper allows you to easily add translations to your app. To make this remapper work, replace\\nany static text with `translate: {name}`. Then, in your app\\u2019s Translations page pick the language\\nyou want to translate. You will see a list of names with input text below. Translations you manually\\nput in the app using the `translate` remapper are found under \\u201cCustom messages\\u201d.\\n\\nAfter putting the translation in, any user that logs in with that language selected will see the\\ntranslated message.\\n\\nExample:\\n\\n```yaml\\ntype: detail-viewer\\nversion: 0.20.39\\nparameters:\\n fields:\\n - label: { translate: weatherTitle }\\n value: { translate: weatherBody }\\n```\\n\\n\"},\"app.member\":{\"enum\":[\"sub\",\"name\",\"email\",\"email_verified\",\"picture\",\"locale\",\"zoneinfo\",\"role\",\"properties\"],\"description\":\"\\n> **Note:** For this remapper to work, the app member that activated the remapper has to be logged in to\\n> the app\\n\\nProvides some fields of app member information taken from the OpenID user info. These fields are:\\n\\n- `sub`: The app member\\u2019s identifier\\n- `name`: The app member\\u2019s name\\n- `email`: The app member\\u2019s **primary** email address\\n- `email_verified`: Whether the app member\\u2019s primary email address is verified or not (`boolean`)\\n- `picture`: Full URL to the app member\\u2019s profile picture web address\\n- `locale`: The app member\\u2019s default language [`BCP47`](https://en.wikipedia.org/wiki/IETF_language_tag)\\n language tag (ex. `en`) (Broken)\\n- `zoneinfo`: The app member\\u2019s timezone\\n- `role`: The role of the app member in the app\\n- `properties`: Custom properties defined on the app member\\n\\nExample:\\n\\n```json\\n{\\n \\\"email\\\": \\\"[email protected]\\\",\\n \\\"email_verified\\\": true,\\n \\\"locale\\\": \\\"en\\\",\\n \\\"name\\\": \\\"Test User\\\",\\n \\\"picture\\\": \\\"https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp\\\",\\n \\\"sub\\\": \\\"5c6270e2-ad31-414f-bcab-6752a2c4dcfd\\\",\\n \\\"properties\\\": {}\\n}\\n```\\n \"},\"container\":{\"type\":\"string\",\"description\":\"\\n> **Note:** For this remapper to work, the application needs to define a companion container.\\n\\nThis remapper provides a short way to access a companion container for the purpose of making http requests.\\nWhen using the 'request' action, the url can be provided by using the 'container' remapper, and providing a string.\\nThe string should contain the name of the companion container, followed by the API endpoint path.\\n\\nExample:\\n```yaml\\n type: request\\n url: { container: my-container/api/endpoint }\\n proxy: true\\n method: get\\n```\\n \"},\"slice\":{\"description\":\"Extract characters from a string, or items from an array\\naccepts either an array of two numbers (indexes of starting point and ending point)\\nor a number (index of the starting point).\\nstartIndex is inclusive whereas the endIndex is not.\\nInput:\\n\\n```json\\n\\\"Laziness\\\"\\n```\\n```yaml\\nslice:\\n - 3\\n - 6\\n\\n```\\nResult:\\n\\n```json\\n\\\"ine\\\"\\n```\\n\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"number\"}},{\"type\":\"number\"}]},\"date.add\":{\"type\":\"string\",\"description\":\"Adds a specified date value to the provided date.\\n\\nThe value to add should be specified according to the\\n[parse-duration](https://www.npmjs.com/package/parse-duration) API. If you want to add a day to a\\ndate for example, the syntax would be `date.add: 1d`.\\n\\nFull list of supported unit types:\\n- nanoseconds (ns)\\n- microseconds (\\u03bcs)\\n- milliseconds (ms)\\n- seconds (s, sec)\\n- minutes (m, min)\\n- hours (h, hr)\\n- days (d)\\n- weeks (w, wk)\\n- months\\n- years (y, yr)\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n\\\"2023-06-30T14:50:19.601Z\\\"\\n```\\n```yaml\\n- date.now: null\\n- date.add: 1w\\n- date.format: null\\n\\n```\\nResult:\\n\\n```json\\n\\\"2023-07-07T14:50:19.601Z\\\"\\n```\\n\\n\"},\"date.format\":{\"oneOf\":[{\"enum\":[null]},{\"type\":\"string\"}],\"description\":\"Format a date according to the RFC3339 format.\\n\\nHere is an example of a RFC3339 complicit date:\\n`2002-10-02T15:00:00Z`\\n\\nIn an app definition, it\\u2019s best to use this when you want to display a date in a specific format.\\nFor example, if your app has a form with a Datepicker field the incoming data will be formatted\\nas a simple date format. If you want to format it to the RFC3339 format, you can use this remapper.\\n\\nWhen you submit a form with a DateField, the internal output looks like the following. You can then format the date so that it uses the RFC3339 format.\\n\\nInput:\\n\\n```json\\n\\\"2023-07-03\\\"\\n```\\n```yaml\\ndate.format: null\\n\\n```\\nResult:\\n\\n```json\\n\\\"2023-07-02T22:00:00.000Z\\\"\\n```\\n\\n\\nThe remapper can also be used to format a date or timestamp using a custom format.\\n\\n```js\\n\\\"2023-07-02T22:00:00.000Z\\\"\\n```\\n\\nYou can then format the date with any supported pattern, please refer to https://date-fns.org/docs/format for the supported patterns.\\n\\n```yaml\\ndate.format: yyyy-MM-dd\\n```\\n\\nResult:\\n```js\\n2023-07-03\\n```\\n\"},\"date.now\":{\"enum\":[null],\"description\":\"Returns the current date as a JavaScript Date object.\\n\\n```yaml\\ndate.now: null\\n\\n```\\nResult:\\n\\n```json\\n\\\"Mon Jul 03 2023 11:47:18 GMT+0200 (Midden-Europese zomertijd)\\\"\\n```\\n\\n\"},\"date.parse\":{\"type\":\"string\",\"description\":\"Convert a string to a date using a given format.\\n\\nFor example:\\n\\n```yaml\\ndate.parse: MM/dd/yyyy\\n\\n```\\nResult:\\n\\n```json\\n\\\"Tue Feb 11 2014 00:00:00\\\"\\n```\\n\\n\\nSee [date-fns](https://date-fns.org/v2.29.3/docs/parse) for the supported formats.\\n\\nLeaving the format empty will try to parse the date using the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\\nFor example:\\n```yaml\\ndate.parse:\\n- static: 2014-02-11T11:30:30 # The date string to parse\\n- date.parse: '' # The given format to parse the date with\\n # => Tue Feb 11 2014 11:30:30\\n```\\n\"},\"from.history\":{\"type\":\"object\",\"required\":[\"index\",\"props\"],\"description\":\"Creates a new object based on the specified properties in the given history index. This can be very\\nuseful when you want to combine two sources of data together. It\\u2019s also cleaner than separately\\nusing `object.from` together with `history`.\\n\\nIn the following example, you can see why this might be handy. Let\\u2019s say you get the details about a\\nconcert from a source like an action or a block. You have this information and then you want to get\\nsome additional data like the attendees of the concert. With `from.history` you can combine the\\nolder data like the name and date, and add the new `attendees` data. The result will be an object\\nwith this combined data.\\n\\nHistory index 1:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Rolling stones at Amsterdam Arena\\\",\\n \\\"artist\\\": \\\"Rolling Stones\\\",\\n \\\"location\\\": \\\"Amsterdam Arena\\\",\\n \\\"date\\\": \\\"07-07-2022\\\",\\n \\\"price\\\": 120\\n}\\n```\\n\\nInput:\\n\\n```json\\n[ .. ]\\n```\\n\\n```yaml\\nobject.from:\\n concertDetails:\\n from.history:\\n index: 1\\n props:\\n name: { prop: name }\\n date: { prop: date }\\n attendees: { root: null }\\n```\\n\\nResult:\\n\\n```json\\n{\\n \\\"concertDetails\\\": {\\n \\\"attendees\\\": [ .. ],\\n \\\"date\\\": \\\"07-07-2022\\\",\\n \\\"name\\\": \\\"Rolling stones at Amsterdam Arena\\\"\\n }\\n}\\n```\\n\",\"additionalProperties\":false,\"properties\":{\"index\":{\"type\":\"integer\",\"description\":\"The index of the history stack item to assign.\\n\\n0 is the index of the first item in the history stack.\\n\"},\"props\":{\"description\":\"Predefined mapper keys to choose what properties to apply.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"}}}},\"assign.history\":{\"type\":\"object\",\"required\":[\"index\",\"props\"],\"description\":\"Assigns properties from the specified history stack index to an existing object.\\nSimilarly to the `from.history` remapper, this allows you to get a property from a place in the\\nhistory and give it to a new object. The only difference here is that you are not creating an\\nentirely new object, but you are taking an existing object and assigning new values to it.\\n\\nSo, we can take the example from `from.history` and flip it.\\n\\nHistory index 1:\\n\\n```json\\n{\\n \\\"peopleAmount\\\": 3000\\n}\\n```\\n\\nInput:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Rolling stones at Amsterdam Arena\\\",\\n \\\"artist\\\": \\\"Rolling Stones\\\",\\n \\\"location\\\": \\\"Amsterdam Arena\\\",\\n \\\"date\\\": \\\"07-07-2022\\\",\\n \\\"price\\\": 120\\n}\\n```\\n\\n```yaml\\nobject.from:\\n concertDetails:\\n assign.history:\\n index: 1\\n props:\\n attendees: { prop: peopleAmount }\\n```\\n\\nResult:\\n\\n```json\\n{\\n \\\"concertDetails\\\": {\\n \\\"name\\\": \\\"Rolling stones at Amsterdam Arena\\\",\\n \\\"artist\\\": \\\"Rolling Stones\\\",\\n \\\"location\\\": \\\"Amsterdam Arena\\\",\\n \\\"date\\\": \\\"07-07-2022\\\",\\n \\\"price\\\": 120,\\n \\\"attendees\\\": 3000\\n }\\n}\\n```\\n\",\"additionalProperties\":false,\"properties\":{\"index\":{\"type\":\"integer\",\"description\":\"The index of the history stack item to assign.\\n\\n0 is the index of the first item in the history stack.\\n\"},\"props\":{\"description\":\"Predefined mapper keys to choose what properties to assign.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"}}}},\"omit.history\":{\"type\":\"object\",\"required\":[\"index\",\"keys\"],\"description\":\"Assigns properties from the specified history stack index to the current value and excludes the\\ngiven properties.\\n\\nSimilarly to the other history remappers, this gives you the data from a certain point in the\\nhistory stack and allows you to modify it before adding to the current value. This one, however,\\nallows you to take the complete specified history data and omit certain values.\\n\\nThis remapper can be extremely helpful for re-using data you got before in the history stack while\\nfiltering certain properties.\\n\\nFor example, let\\u2019s say you have the information for a concert but don\\u2019t want normal users to see\\nsensitive data about it. Using `omit.history` you can take this concert data but exclude the\\nsensitive parts.\\n\\nHistory index 1:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Rolling stones at Amsterdam Arena\\\",\\n \\\"artist\\\": \\\"Rolling Stones\\\",\\n \\\"location\\\": \\\"Amsterdam Arena\\\",\\n \\\"date\\\": \\\"07-07-2022\\\",\\n \\\"bandPasswords\\\": [ .. ],\\n \\\"bankDetailsAttendees\\\": [ .. ]\\n}\\n```\\n\\nInput:\\n\\n```json\\n[ .. ]\\n```\\n\\n```yaml\\nobject.from:\\n concertDetails:\\n omit.history:\\n index: 1\\n keys:\\n - bandPasswords\\n - bankDetailsAttendees\\n```\\n\\nResult:\\n\\n```json\\n{\\n \\\"concertDetails\\\": {\\n \\\"name\\\": \\\"Rolling stones at Amsterdam Arena\\\",\\n \\\"artist\\\": \\\"Rolling Stones\\\",\\n \\\"location\\\": \\\"Amsterdam Arena\\\",\\n \\\"date\\\": \\\"07-07-2022\\\",\\n \\\"attendees\\\": [ .. ]\\n }\\n}\\n```\\n\",\"additionalProperties\":false,\"properties\":{\"index\":{\"type\":\"integer\",\"description\":\"The index of the history stack item to assign.\\n\\n0 is the index of the first item in the history stack.\\n\"},\"keys\":{\"description\":\"Exclude properties from the history stack item, based on the given object keys.\\n\\nNested properties can be excluded using arrays of keys.\\n\\nFor example:\\n```yaml\\nomit.history:\\n index: 0\\n keys:\\n - foo # Excludes the property foo\\n - - bar # Excludes the property baz inside of bar\\n - baz\\n```\\n\",\"type\":\"array\",\"items\":{\"minItems\":1,\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"string\"}}]}}}},\"number.parse\":{\"anyOf\":[{\"enum\":[null]},{\"type\":\"string\"},{\"$ref\":\"#/components/schemas/ArrayRemapperDefinition\"},{\"$ref\":\"#/components/schemas/ObjectRemapperDefinition\"}],\"description\":\"Convert a string into a number.\\n\\nIf there is no remapper passed and the input can be converted, this will return the converted input.\\n\\nIf there is no remapper passed and the input is null, this will return 0.\\n\\nIf there is no remapper passed and the input cannot be converted, this will return the input.\\n\\nIf there is a remapper passed and the remapped value can be converted, this will return the converted remapped value.\\n\\nIf there is a remapper passed and the remapped value is null, this will return 0.\\n\\nIf there is a remapper passed and the remapped value cannot be converted, this will return the remapped value.\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n\\\"42\\\"\\n```\\n```yaml\\nnumber.parse: null\\n\\n```\\nResult:\\n\\n```json\\n42\\n```\\n\\n\"},\"object.assign\":{\"additionalProperties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"\\n\\nLet\\u2019s say you have an existing object that you want to add an additional value on top of. For this\\nyou can use the `object.assign` remapper. The remapper takes an existing object and allows the user\\nto assign their own value on top of that.\\n\\nInput:\\n\\n```json\\n{\\\"title\\\":\\\"Weekly fishing 21\\\"}\\n```\\n```yaml\\nobject.assign:\\n author: John Doe\\n\\n```\\nResult:\\n\\n```json\\n{\\\"author\\\":\\\"John Doe\\\",\\\"title\\\":\\\"Weekly fishing 21\\\"}\\n```\\n\\n\\n\"},\"object.from\":{\"additionalProperties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"\\n\\nWith this remapper you can create an entirely new object based on input values and other remappers.\\n`object.from` itself accepts remapper functions as its input which allows you to chain multiple\\nremappers together to make complex objects.\\n\\nAs a base, the remapper looks like this:\\n\\n```yaml\\nobject.from:\\n email: [email protected]\\n username: Chris Taub\\n\\n```\\nResult:\\n\\n```json\\n{\\\"email\\\":\\\"[email protected]\\\",\\\"username\\\":\\\"Chris Taub\\\"}\\n```\\n\\n\\nMost of the time you won\\u2019t create an object just to store one value. Luckily, this is where the\\nchaining of remappers comes in. You can create an object that contains an `object.from` remapper\\nwhich then allows more inputs:\\n\\n```yaml\\nobject.from:\\n username: Chris Taub\\n email: [email protected]\\n addresses:\\n object.from:\\n work:\\n object.from:\\n city: Eindhoven\\n address: Nachtegaallaan 15\\n home:\\n object.from:\\n city: Amsterdam\\n address: Amstel 1\\n```\\n\\n```json\\n{\\n \\\"username\\\": \\\"Chris Taub\\\",\\n \\\"email\\\": \\\"[email protected]\\\",\\n \\\"addresses\\\": {\\n \\\"work\\\": {\\n \\\"city\\\": \\\"Eindhoven\\\",\\n \\\"address\\\": \\\"Nachtegaallaan 15\\\"\\n },\\n \\\"home\\\": {\\n \\\"city\\\": \\\"Amsterdam\\\",\\n \\\"address\\\": \\\"Amstel 1\\\"\\n }\\n }\\n}\\n```\\n\\n\"},\"object.omit\":{\"type\":\"array\",\"items\":{\"minItems\":1,\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"string\"}}]},\"description\":\"\\n\\nIn contrary to the previous remapper, what if you have an object from which you want to remove a\\nvalue? Then you can use `object.omit`. The remapper can remove properties from an existing object\\nbased on the given object keys. This includes nested properties.\\n\\nInput:\\n\\n```json\\n{\\n \\\"author\\\": \\\"John Doe\\\",\\n \\\"content\\\": {\\n \\\"interview\\\": \\\"...\\\",\\n \\\"introduction\\\": \\\"This is the introduction for the new weekly fishing issue\\\",\\n \\\"paragraph1\\\": \\\"...\\\"\\n },\\n \\\"title\\\": \\\"Weekly fishing 21\\\"\\n}\\n```\\n```yaml\\nobject.omit:\\n - author\\n - - content\\n - interview\\n\\n```\\nResult:\\n\\n```json\\n{\\n \\\"content\\\": {\\n \\\"introduction\\\": \\\"This is the introduction for the new weekly fishing issue\\\",\\n \\\"paragraph1\\\": \\\"...\\\"\\n },\\n \\\"title\\\": \\\"Weekly fishing 21\\\"\\n}\\n```\\n\\n\"},\"object.compare\":{\"type\":\"array\",\"items\":{\"minItems\":2,\"maxItems\":2,\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"description\":\"\\n\\nThis remapper allows you to compare two objects and get differences in their key-value pairs like in the following example:\\n\\nInput:\\n\\n```json\\n{\\n \\\"name\\\": \\\"Alice\\\"\\n}\\n```\\n```yaml\\nobject.compare:\\n - object.from:\\n name:\\n prop: name\\n age: 25\\n address:\\n object.from:\\n city: Paris\\n zip: 7500\\n favoriteColors:\\n array.from:\\n - blue\\n - green\\n - object.from:\\n name: Alice\\n age: 26\\n address:\\n object.from:\\n city: Lyon\\n country: France\\n favoriteColors:\\n array.from:\\n - red\\n - green\\n - blue\\n\\n```\\nResult:\\n\\n```json\\n[\\n {\\n \\\"path\\\": [\\n \\\"age\\\"\\n ],\\n \\\"type\\\": \\\"changed\\\",\\n \\\"from\\\": 25,\\n \\\"to\\\": 26\\n },\\n {\\n \\\"path\\\": [\\n \\\"favoriteColors\\\"\\n ],\\n \\\"type\\\": \\\"changed\\\",\\n \\\"from\\\": [\\n \\\"blue\\\",\\n \\\"green\\\"\\n ],\\n \\\"to\\\": [\\n \\\"red\\\",\\n \\\"green\\\",\\n \\\"blue\\\"\\n ]\\n },\\n {\\n \\\"path\\\": [\\n \\\"address\\\",\\n \\\"city\\\"\\n ],\\n \\\"type\\\": \\\"changed\\\",\\n \\\"from\\\": \\\"Paris\\\",\\n \\\"to\\\": \\\"Lyon\\\"\\n },\\n {\\n \\\"path\\\": [\\n \\\"address\\\",\\n \\\"zip\\\"\\n ],\\n \\\"type\\\": \\\"removed\\\",\\n \\\"value\\\": 7500\\n },\\n {\\n \\\"path\\\": [\\n \\\"address\\\",\\n \\\"country\\\"\\n ],\\n \\\"type\\\": \\\"added\\\",\\n \\\"value\\\": \\\"France\\\"\\n }\\n]\\n```\\n\\n\"},\"object.explode\":{\"type\":\"string\",\"description\":\"\\n\\nTakes an object with an array property and transforms it into an array of objects.\\n\\nEach object in the resulting array contains all the entries of the original object\\nplus all the entries of the corresponding array item from the array property.\\n\\nIf one of the items in the array contains a key, which exists in the original object\\nit will overwrite the original key.\\n\\nNested arrays or objects are not exploded.\\n\\nExample:\\nInput:\\n\\n```json\\n{\\n \\\"ownerName\\\": \\\"John\\\",\\n \\\"country\\\": \\\"USA\\\",\\n \\\"pets\\\": [\\n {\\n \\\"name\\\": \\\"Milka\\\"\\n },\\n {\\n \\\"name\\\": \\\"Sven\\\",\\n \\\"country\\\": \\\"Sweden\\\"\\n },\\n {\\n \\\"name\\\": \\\"Tom\\\",\\n \\\"likes\\\": [\\n \\\"mice\\\",\\n \\\"fish\\\"\\n ]\\n },\\n {\\n \\\"name\\\": \\\"Jerry\\\",\\n \\\"looks\\\": {\\n \\\"color\\\": \\\"brown\\\"\\n }\\n }\\n ]\\n}\\n```\\n```yaml\\nobject.explode: pets\\n\\n```\\nResult:\\n\\n```json\\n[\\n {\\n \\\"ownerName\\\": \\\"John\\\",\\n \\\"name\\\": \\\"Milka\\\",\\n \\\"country\\\": \\\"USA\\\"\\n },\\n {\\n \\\"ownerName\\\": \\\"John\\\",\\n \\\"name\\\": \\\"Sven\\\",\\n \\\"country\\\": \\\"Sweden\\\"\\n },\\n {\\n \\\"ownerName\\\": \\\"John\\\",\\n \\\"name\\\": \\\"Tom\\\",\\n \\\"country\\\": \\\"USA\\\",\\n \\\"likes\\\": [\\n \\\"mice\\\",\\n \\\"fish\\\"\\n ]\\n },\\n {\\n \\\"ownerName\\\": \\\"John\\\",\\n \\\"name\\\": \\\"Jerry\\\",\\n \\\"country\\\": \\\"USA\\\",\\n \\\"looks\\\": {\\n \\\"color\\\": \\\"brown\\\"\\n }\\n }\\n]\\n```\\n\\n\"},\"filter.from\":{\"additionalProperties\":{\"$ref\":\"#/components/schemas/FilterParametersDefinition\"},\"description\":\"\\n\\nWith this remapper you can generate an OData filter, ready to be passed to the `$filter` key in\\nresource queries.\\n\\nThe different comparator options are as follows:\\n\\n- eq - Equal to\\n- ne - Not equal to\\n- lt - Less than\\n- gt - Greater than\\n- le - Less than or equal to\\n- ge - Greater than or equal to\\n\\nThe most common types of values are `String`, `Number`, `Boolean` and `Date`. If you need a more specific\\ntype, please refer to [the OData spec](https://www.odata.org/documentation/odata-version-2-0/overview/).\\n\\nAs a base, the remapper looks like this:\\n\\nInput:\\n\\n```json\\n{\\\"exclude\\\":\\\"Peter\\\"}\\n```\\n```yaml\\nfilter.from:\\n name:\\n type: String\\n comparator: ne\\n value:\\n prop: exclude\\n age:\\n type: Number\\n comparator: lt\\n value: 10\\n height:\\n type: Number\\n comparator: le\\n value: 1.75\\n heightString:\\n type: Number\\n comparator: le\\n value: \\\"1.75\\\"\\n birthday:\\n type: Date\\n comparator: ge\\n value: 2000-01-01\\n friendsSince:\\n type: Date\\n comparator: ge\\n value: 2014-01-01T00:00:00Z\\n job:\\n type: String\\n comparator: eq\\n value: null\\n employed:\\n type: Boolean\\n comparator: eq\\n value: false\\n id:\\n type: Guid\\n comparator: eq\\n value: 03a0a47b-e3a2-e311-9402-00155d104c24\\n undefined:\\n type: String\\n comparator: eq\\n special:\\n type: String\\n comparator: eq\\n value: Special character's \\\"test\\\" \\\\%&+?^/\\n\\n```\\nResult:\\n\\n```json\\n\\\"name ne 'Peter' and age lt 10 and height le 1.75 and heightString le 1.75 and birthday ge 2000-01-01 and friendsSince ge 2014-01-01T00:00:00Z and job eq null and employed eq false and id eq 03a0a47b-e3a2-e311-9402-00155d104c24 and undefined eq null and special eq 'Special character''s \\\\\\\"test\\\\\\\" \\\\\\\\\\\\\\\\%&+?^/'\\\"\\n```\\n\\n\\nHere is an example of how you can use the remapper in an app definition:\\n\\n```yaml\\ntype: resource.query\\n resource: myResource\\n query:\\n object.from:\\n $filter:\\n filter.from:\\n name:\\n type: String\\n comparator: ne\\n value: { prop: exclude }\\n age:\\n type: Int64\\n comparator: lt\\n value: 10\\n birthday:\\n type: Date\\n comparator: ge\\n value: '2000-01-01'\\n job:\\n type: String\\n comparator: eq\\n value: null\\n employed:\\n type: Boolean\\n comparator: eq\\n value: false\\n special:\\n type: String\\n comparator: eq\\n value: \\\"Special character's test\\\"\\n```\\n\"},\"order.from\":{\"additionalProperties\":{\"enum\":[\"asc\",\"desc\"]},\"description\":\"\\n\\nWith this remapper you can generate an OData order, ready to be passed to the `$orderby` key in\\nresource queries.\\n\\nThe different order options are as follows:\\n\\n- asc - Ascending\\n- desc - Descending\\n\\n```yaml\\norder.from:\\n name: asc\\n age: desc\\n\\n```\\nResult:\\n\\n```json\\n\\\"name asc,age desc\\\"\\n```\\n\\n\\nHere is an example of how you can use the remapper in an app definition:\\n\\n```yaml\\ntype: resource.query\\n resource: myResource\\n query:\\n object.from:\\n $orderby:\\n order.from:\\n name: asc\\n age: desc\\n```\\n\"},\"random.choice\":{\"enum\":[null],\"description\":\"Pick and return a random entry from an array. If the input is not an array, the input is returned as-is.\\nFor example:\\n\\nIf you input the following array:\\n```json\\n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]\\n```\\n\\n```yaml\\nrandom.choice: null\\n```\\n\\nThe result could return any one of these numbers.\\n\\nYou can also combine different data types in this array and have it work in the same way. If mixed in\\nstrings, the result could be either one of the provided numbers or one of the provided strings.\\n\\n```json\\n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, \\\"Peter\\\", \\\"Patrick\\\", \\\"Michael\\\", \\\"Harry\\\"]\\n```\\n\"},\"random.integer\":{\"type\":\"array\",\"maxItems\":2,\"minItems\":2,\"items\":{\"type\":\"integer\"},\"description\":\"Pick and return a random integer between the provided lowest and highest values.\\nFor example:\\n```yaml\\nrandom.integer:\\n - 0\\n - 1000\\n```\\n\\nReturns a random integer between 0 and 1000.\\n\"},\"random.float\":{\"type\":\"array\",\"maxItems\":2,\"minItems\":2,\"items\":{\"type\":\"number\"},\"description\":\"Pick and return a random float value between the provided lowest and highest values.\\nFor example:\\n```yaml\\nrandom.float:\\n - 0\\n - 1\\n```\\n\\nReturns a random float value between 0 and 1.\\n\"},\"random.string\":{\"type\":\"object\",\"required\":[\"choice\",\"length\"],\"additionalProperties\":false,\"properties\":{\"choice\":{\"type\":\"string\",\"minLength\":1},\"length\":{\"type\":\"integer\",\"minimum\":1}},\"description\":\"Pick and return a random string from a given length using characters from a given input string defined in `choice`.\\nFor example:\\n```yaml\\nrandom.string:\\n choice: abcdefghijklmnopqrstuvwxyz0123456789\\n length: 6\\n```\\n\\nReturns a randomized string that is 6 characters long and consists of any characters in the `choice` field, like: `g8ajss9`.\\n\"},\"string.case\":{\"enum\":[\"lower\",\"upper\"],\"description\":\"Convert a string to upper or lower case.\\n\\nInput:\\n\\n```json\\n\\\"Patrick\\\"\\n```\\n```yaml\\nstring.case: upper\\n\\n```\\nResult:\\n\\n```json\\n\\\"PATRICK\\\"\\n```\\n\\n\"},\"string.startsWith\":{\"type\":\"string\",\"description\":\"Check if the initial characters of the string matches with the input string,\\nthis remapper is case-sensitive.\\nInput:\\n\\n```json\\n\\\"Random string here\\\"\\n```\\n```yaml\\nstring.startsWith: Random\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"string.endsWith\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"description\":\"Alternative way to define input to facilitate the case-insensitive matching\",\"required\":[\"substring\"],\"additionalProperties\":false,\"properties\":{\"substring\":{\"type\":\"string\"},\"strict\":{\"type\":\"boolean\"}}}],\"description\":\"Check if the last characters of the string matches with the input string,\\nthis remapper is case-sensitive unless specified explicitly,\\nTo make the remapper ignore casing of the input and passed string, use the following example\\nInput:\\n\\n```json\\n\\\"Random string here\\\"\\n```\\n```yaml\\nstring.endsWith:\\n substring: Here\\n strict: false\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"string.format\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"messageId\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The message id pointing to the template string to format.\"},\"template\":{\"type\":\"string\",\"description\":\"The template default string to format.\"},\"values\":{\"description\":\"A set of remappers to convert the input to usable values.\",\"additionalProperties\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"}}},\"description\":\"Format a string using remapped input variables.\\nUseful for replacing static text with generated values.\\n\\nInput:\\n\\n```json\\n{\\\"lotteryPrize\\\":\\\"5000\\\"}\\n```\\n```yaml\\nstring.format:\\n template: You have won \\u20ac{lotteryAmount} in the lottery!!\\n values:\\n lotteryAmount:\\n prop: lotteryPrize\\n\\n```\\nResult:\\n\\n```json\\n\\\"You have won \\u20ac5000 in the lottery!!\\\"\\n```\\n\\n\\n> **Tip:** Considering this can be inserted anywhere a remapper is accepted. You can also use this\\n> to choose specific URL\\u2019s more accurately.\\n\\n\"},\"string.replace\":{\"type\":\"object\",\"minProperties\":1,\"maxProperties\":1,\"additionalProperties\":{\"type\":\"string\"},\"description\":\"\\nUses RegEx to find a value in a string and replace it with a given value.\\n\\nInput:\\n\\n```json\\n\\\"Eindhoven is the best city in the Netherlands\\\"\\n```\\n```yaml\\nstring.replace:\\n (best*)\\\\w+: cleanest\\n\\n```\\nResult:\\n\\n```json\\n\\\"Eindhoven is the cleanest city in the Netherlands\\\"\\n```\\n\\n\"},\"string.contains\":{\"type\":\"string\",\"description\":\"\\nChecks if the provided string is a substring of the input string.\\nInput:\\n\\n```json\\n\\\"Input string\\\"\\n```\\n```yaml\\nstring.contains: string\\n\\n```\\nResult:\\n\\n```json\\ntrue\\n```\\n\\n\"},\"ics\":{\"type\":\"object\",\"description\":\"Create a calendar event. This event can be downloaded as an `.ics` file and\\nuploaded to your agenda using the [download](../reference/action#download) action.\\n\\nFor example, the following input:\\n```yaml\\nics:\\ncoordinates\\n object.from:\\n latitude: 38.897700545442646\\n longitude: -77.03655660152435\\ndescription: \\\"Sprint planning meeting\\\"\\nduration: 1d\\nend: 2023-07-19\\nlocation: The Oval Office.\\nstart: 2023-07-18\\ntitle: Important Meeting\\nurl: https://google.nl\\n```\\n\\nCreates the following ICS-formatted object:\\n```\\nBEGIN:VCALENDAR\\nVERSION:2.0\\nCALSCALE:GREGORIAN\\nPRODID:http://remappers.appsemble.localhost:9999\\nMETHOD:PUBLISH\\nX-PUBLISHED-TTL:PT1H\\nBEGIN:VEVENT\\nUID:b8TsbczhfpIxPM-3lNHQz\\nSUMMARY:Important Meeting\\nDTSTAMP:20230703T102029Z\\nDTSTART:20230717T220000Z\\nDTEND:20230718T220000Z\\nDESCRIPTION:Sprint planning meeting\\nURL:https://google.nl\\nGEO:38.897700545442646;-77.03655123710632\\nLOCATION:The Oval Office.\\nEND:VEVENT\\nEND:VCALENDAR\\n```\\n\",\"additionalProperties\":false,\"required\":[\"start\",\"title\"],\"properties\":{\"start\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The start of the icalendar event.\"},\"end\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The end of the icalendar event.\"},\"duration\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The duration of the event.\",\"example\":\"1w 3d 10h 30m\"},\"title\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The title of the event.\"},\"description\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"An optional description of the event.\"},\"url\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"An optional link to attach to the event.\"},\"location\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"An optional location description to attach to the event.\"},\"coordinates\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"An optional geolocation description to attach to the event.\\n\\n This must be an object with the properties `lat` or `latitude`, and `lon`, `lng` or `longitude`.\"}}},\"null.strip\":{\"description\":\"Strip all null, undefined, and empty array values from an object or array.\\nFor example, with the following input value:\\n```json\\n[0, 4, null, null, \\\"Peter\\\", 0.4234, null]\\n```\\n```yaml\\nnull.strip: null\\n```\\n\\nThe null values will be removed, leaving a dense array:\\n```json\\n[0, 4, \\\"Peter\\\", 0.4234]\\n```\\n\\nInstead of giving it `null` as option, you can also provide a `depth` property to specify how\\ndeep to recurse into the object or array to remove null values.\\n\\nFor example, with the following input:\\n```json\\n{\\n 0: [0, null, \\\"Peter\\\"],\\n 1: {\\n \\\"array1\\\": [4, null, 0.4234, null]\\n }\\n}\\n```\\n\\nYou can specify to which degree of depth you want the null values to be removed.\\nWith this remapper definition:\\n```yaml\\nnull.strip:\\n depth: 2\\n```\\n\\nIt will only check two objects in for any null values. That means only the first array within the\\nobject will be checked. The result looks like this:\\n```json\\n{\\n 0: [0, \\\"Peter\\\"],\\n 1: {\\n \\\"array1\\\": [4, null, 0.4234, null]\\n }\\n}\\n```\\n\",\"anyOf\":[{\"enum\":[null]},{\"type\":\"object\",\"required\":[\"depth\"],\"additionalProperties\":false,\"description\":\"Options for the null.strip remapper.\",\"properties\":{\"depth\":{\"type\":\"integer\",\"minimum\":1,\"description\":\"How deep to recurse into objects and arrays to remove null values.\"}}}]},\"type\":{\"enum\":[null],\"description\":\"Returns the type of the input object\\n\\nFor example, with the following input value:\\n```json\\n[0, 5, 7, 8]\\n```\\n```yaml\\ntype: null\\n```\\n\\nThe result will be:\\n```json\\n\\\"array\\\"\\n```\\n \"},\"log\":{\"enum\":[\"info\",\"warn\",\"error\"],\"description\":\"Logs in the browser's console and returns the incoming data and the remapper function's context.\\n\\nThe context contains relevant info about the app, like the URL and locale, but also contains the\\nremapper\\u2019s history.\\n\\nThe options represent the level of logging that will show in the console.\\n\\n- `input`: The input data going into this remapper,\\n- `context`:\\n - `root`: The input data going into this remapper,\\n - `appId`: ID of the application,\\n - `url`: Absolute URL of the page where the remapper was fired,\\n - `appUrl`: Base URL of the application,\\n - `pageData`: Current page data of a FlowPage (See [page remapper](./data#page)),\\n - `userInfo`: User's information if they are logged in (See [user remapper](./data#user)),\\n - `context`: Internal context\\n - `history`: Complete list of this remapper\\u2019s history (See [history remapper](./history))\\n - `locale`: The user\\u2019s locale,\\n - `stepRef`: In a loop page, gives the properties from the loop\\u2019s current data index (See [step remapper](./data#step))\\n\\nFor example:\\n\\n```json\\n{\\n \\\"input\\\": {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"age\\\": 49,\\n \\\"birthday\\\": \\\"07-08-2023\\\"\\n },\\n \\\"context\\\": {\\n \\\"root\\\": {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"age\\\": 49,\\n \\\"birthday\\\": \\\"07-08-2023\\\"\\n },\\n \\\"appId\\\": 49,\\n \\\"url\\\": \\\"http://remappers.appsemble.localhost:9999/en/other\\\",\\n \\\"appUrl\\\": \\\"http://remappers.appsemble.localhost:9999\\\",\\n \\\"pageData\\\": {\\n \\\"triedAppsemble\\\": false\\n },\\n \\\"userInfo\\\": {\\n \\\"email\\\": \\\"[email protected]\\\",\\n \\\"email_verified\\\": true,\\n \\\"name\\\": \\\"Example User 1\\\",\\n \\\"picture\\\": \\\"https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp\\\",\\n \\\"sub\\\": \\\"0000-0000-0000-0000\\\",\\n \\\"locale\\\": \\\"en\\\",\\n \\\"zoneinfo\\\": \\\"Europe/Amsterdam\\\"\\n },\\n \\\"context\\\": {},\\n \\\"history\\\": [\\n [\\n 0,\\n 4,\\n null,\\n null,\\n \\\"Peter\\\",\\n 0.4234,\\n null\\n ],\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"age\\\": 49\\n },\\n {\\n \\\"name\\\": \\\"Peter\\\",\\n \\\"age\\\": 49,\\n \\\"birthday\\\": \\\"07-08-2023\\\"\\n }\\n ],\\n \\\"locale\\\": \\\"en\\\",\\n \\\"stepRef\\\": {\\n \\\"current\\\": {\\n \\\"answerType\\\": \\\"multiple choice\\\",\\n \\\"question\\\": \\\"How much do you enjoy working here?\\\"\\n }\\n }\\n }\\n}\\n```\\n\"},\"xml.parse\":{\"description\":\"This can be used to parse an xml string into an object\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n{\\\"xml\\\":\\\"\\\\n<obj>\\\\n <foo>bar</foo>\\\\n <item foo=\\\\\\\"bar\\\\\\\">\\\\n <item foo=\\\\\\\"bar\\\\\\\">\\\\n <text>text</text>\\\\n </item>\\\\n </item>\\\\n <item bar=\\\\\\\"baz\\\\\\\">\\\\n <item bar=\\\\\\\"baz\\\\\\\">\\\\n <text>text 2</text>\\\\n </item>\\\\n </item>\\\\n <item>\\\\n <item foo=\\\\\\\"bar\\\\\\\">\\\\n <item foo=\\\\\\\"bar\\\\\\\">\\\\n <text>text</text>\\\\n </item>\\\\n </item>\\\\n <item bar=\\\\\\\"baz\\\\\\\">\\\\n <item bar=\\\\\\\"baz\\\\\\\">\\\\n <text>text 2</text>\\\\n </item>\\\\n </item>\\\\n </item>\\\\n</obj>\\\\n\\\"}\\n```\\n```yaml\\nxml.parse:\\n prop: xml\\n\\n```\\nResult:\\n\\n```json\\n{\\n \\\"obj\\\": {\\n \\\"foo\\\": \\\"bar\\\",\\n \\\"item\\\": [\\n {\\n \\\"foo\\\": \\\"bar\\\",\\n \\\"item\\\": {\\n \\\"foo\\\": \\\"bar\\\",\\n \\\"text\\\": \\\"text\\\"\\n }\\n },\\n {\\n \\\"bar\\\": \\\"baz\\\",\\n \\\"item\\\": {\\n \\\"bar\\\": \\\"baz\\\",\\n \\\"text\\\": \\\"text 2\\\"\\n }\\n },\\n {\\n \\\"item\\\": [\\n {\\n \\\"foo\\\": \\\"bar\\\",\\n \\\"item\\\": {\\n \\\"foo\\\": \\\"bar\\\",\\n \\\"text\\\": \\\"text\\\"\\n }\\n },\\n {\\n \\\"bar\\\": \\\"baz\\\",\\n \\\"item\\\": {\\n \\\"bar\\\": \\\"baz\\\",\\n \\\"text\\\": \\\"text 2\\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n}\\n```\\n\",\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"maths\":{\"description\":\"This can be used to perform a mathematical operation on two numbers\\n\\nFor example:\\n\\nInput:\\n\\n```json\\n{\\\"version\\\":0}\\n```\\n```yaml\\nmaths:\\n a:\\n prop: version\\n b:\\n static: 1\\n operation: add\\n\\n```\\nResult:\\n\\n```json\\n1\\n```\\n\",\"additionalProperties\":false,\"properties\":{\"a\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"b\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"operation\":{\"enum\":[\"add\",\"divide\",\"mod\",\"multiply\",\"subtract\"]}}}}},\"Organization\":{\"type\":\"object\",\"description\":\"An organization groups a set of users, apps, themes, and permissions together\",\"required\":[\"id\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"minLength\":1,\"maxLength\":30,\"description\":\"The unique identifier for the organization.\"},\"name\":{\"type\":\"string\",\"description\":\"The display name for the organization.\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the organization.\",\"maxLength\":160},\"email\":{\"type\":\"string\",\"description\":\"The email address of the organization.\"},\"website\":{\"type\":\"string\",\"description\":\"The website of the organization.\"},\"iconUrl\":{\"type\":\"string\",\"description\":\"The URL used to fetch the organization\\u2019s icon.\"}}},\"OrganizationMember\":{\"type\":\"object\",\"description\":\"A member of an organization.\",\"required\":[\"id\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"$ref\":\"#/components/schemas/User/properties/id\"},\"name\":{\"$ref\":\"#/components/schemas/User/properties/name\"},\"primaryEmail\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The primary email address of the user.\"},\"role\":{\"enum\":[\"Member\",\"AppTranslator\",\"AppContentsExplorer\",\"AppContentsManager\",\"AppMemberManager\",\"AppGroupManager\",\"AppGroupMembersManager\",\"AppManager\",\"AppCollectionManager\",\"BlockManager\",\"Maintainer\",\"Owner\"]},\"properties\":{\"type\":\"object\",\"description\":\"Additional custom properties that a user might have.\",\"additionalProperties\":{\"type\":\"string\"}}}},\"PageActionsDefinition\":{\"type\":\"object\",\"description\":\"Action fired on page events\",\"additionalProperties\":false,\"properties\":{\"onLoad\":{\"$ref\":\"#/components/schemas/ActionDefinition\",\"description\":\"This action is fired when a page loads, highly helpful in loading data for the page\"}}},\"PageDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"The list of blocks that are displayed on the page.\\n\\nEach page requires at least one block. Blocks are displayed in the order that they are defined in\\nthe list.\\n\",\"required\":[\"blocks\",\"name\"],\"properties\":{\"blocks\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The blocks that make up a page.\",\"items\":{\"$ref\":\"#/components/schemas/BlockDefinition\"}},\"actions\":{\"$ref\":\"#/components/schemas/PageActionsDefinition\"},\"name\":{\"type\":\"string\",\"maxLength\":50,\"description\":\"The name of an app.\\n\\nThis field is always required and must be unique within the app, meaning that it is not possible to\\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\\n\\n> **Note**: The URL used to navigate to pages is determined by this property.\\n\"},\"hideName\":{\"type\":\"boolean\",\"description\":\"Whether or not the page name should be displayed in the *app bar*.\"},\"navTitle\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the page when displayed in the navigation menu.\\n\\n Context property `name` can be used to access the name of the page.\\n \"},\"hideNavTitle\":{\"type\":\"boolean\",\"description\":\"Whether or not the page should be displayed in navigational menus.\\n\\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\\n page from menus.\\n \",\"default\":false},\"navigation\":{\"$ref\":\"#/components/schemas/AppLayoutDefinition/properties/navigation\",\"description\":\"The type of navigation displayed on the page.\\n\\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\\nApp navigation are not set.\\n\\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\\nmenu. Set to `hidden` to display no navigational menus at all.\\n\"},\"icon\":{\"type\":\"string\",\"description\":\"An optional icon from the fontawesome icon set\\n\\nThis will be displayed in the navigation menu.\\n\"},\"parameters\":{\"type\":\"array\",\"description\":\"Page parameters can be used for linking to a page that should display a single resource.\\n\\nThis defined as a list of strings representing the properties to pass through. More often than not\\npassing `id` through is sufficient, depending on the block.\\n\",\"items\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":30}},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this page.\\n\\nIf the user doesn\\u2019t have any of the roles in the list the page will be unavailable to them. An empty\\nlist can be used to specify that users need to log in but do not need a specific role.\\n\\nUsers trying to visit a page without having the correct roles will be redirected to the first page\\nthat they are allowed to view. If there aren\\u2019t any accessible pages, the user will be logged out and\\ninstructed to contact the app owner to get permissions.\\n\",\"items\":{\"type\":\"string\"}},\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"badgeCount\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A Remapper that resolves to a number to be visibile in the side-menu.\"}}},\"Rating\":{\"type\":\"object\",\"description\":\"A representation of an App rating.\",\"additionalProperties\":false,\"required\":[\"rating\"],\"properties\":{\"rating\":{\"type\":\"number\",\"minimum\":1,\"maximum\":5,\"description\":\"A value ranging from 1 to 5 stars rating of the App.\"},\"description\":{\"type\":\"string\",\"description\":\"An optional explanation of the given rating.\"},\"name\":{\"$ref\":\"#/components/schemas/User/properties/name\",\"readOnly\":true,\"description\":\"The name of the user who submitted the rating.\"}}},\"RemapperDefinition\":{\"anyOf\":[{\"type\":\"boolean\",\"description\":\"A boolean remapper is always returned directly.\"},{\"enum\":[null],\"description\":\"A null remapper is always returned directly.\"},{\"type\":\"number\",\"description\":\"A numeric remapper is always returned directly.\"},{\"type\":\"string\",\"description\":\"A string remapper is always returned directly.\"},{\"$ref\":\"#/components/schemas/ObjectRemapperDefinition\"},{\"$ref\":\"#/components/schemas/ArrayRemapperDefinition\"}]},\"RequestActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"url\"],\"properties\":{\"type\":{\"enum\":[\"request\"],\"description\":\"Performs an HTTP request.\\n\\nThis can be used to call the Appsemble API or an external API in order to fetch data or send data.\\nWhen sending `POST`, `PUT`, `DELETE` and `PATCH` calls the data that is currently available\\nin the block gets passed through.\\n\\nIf the content type of the request is `text/xml` or `application/xml`, the data will be\\nconverted to JSON.\\n\"},\"url\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in the URL to send the request to.\\n\\nCan be a relative URL (E.g. `/api/health`) for usage with the Appsemble API, or an absolute URL\\n(E.g. `https://example.com`) for usage with external sites.\"},\"method\":{\"enum\":[\"delete\",\"get\",\"patch\",\"post\",\"put\"],\"default\":\"get\",\"description\":\"The type of request to make.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"Resource\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"A resource can be anything defined as described in an app resource definition.\",\"properties\":{\"id\":{\"type\":\"number\",\"readOnly\":true},\"$clonable\":{\"type\":\"boolean\"},\"$ephemeral\":{\"type\":\"boolean\"},\"$expires\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"date-time\"},{\"type\":\"string\",\"pattern\":\"^(\\\\d+(y|yr|years))?\\\\s*(\\\\d+months)?\\\\s*(\\\\d+(w|wk|weeks))?\\\\s*(\\\\d+(d|days))?\\\\s*(\\\\d+(h|hr|hours))?\\\\s*(\\\\d+(m|min|minutes))?\\\\s*(\\\\d+(s|sec|seconds))?$\"}]}}},\"ResourceCountActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.count\"],\"description\":\"Count the number of resources a similar `resource.query` action would return.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to count.\"},\"own\":{\"type\":\"boolean\",\"description\":\"If only the resources created by the authenticated app member should be included\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceCreateActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.create\"],\"description\":\"Create a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to create.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"A definition of how this resource works.\",\"required\":[\"schema\"],\"properties\":{\"expires\":{\"type\":\"string\",\"description\":\"A time string representing when a resource should expire.\\n\\nExample: 1d 8h 30m\\n\",\"pattern\":\"^(\\\\d+(y|yr|years))?\\\\s*(\\\\d+months)?\\\\s*(\\\\d+(w|wk|weeks))?\\\\s*(\\\\d+(d|days))?\\\\s*(\\\\d+(h|hr|hours))?\\\\s*(\\\\d+(m|min|minutes))?\\\\s*(\\\\d+(s|sec|seconds))?$\"},\"clonable\":{\"type\":\"boolean\",\"description\":\"Whether the resource should be able to be transferred when cloning the app it belongs to\"},\"schema\":{\"$ref\":\"#/components/schemas/JSONSchemaRoot\",\"description\":\"JSON schema definitions that may be used by the app.\"},\"references\":{\"type\":\"object\",\"description\":\"References to other resources.\\n\\nThe key is the property that references the other resource. The value is an object describing the\\nname of the resource and how it should behave.\\n\",\"minProperties\":1,\"additionalProperties\":{\"type\":\"object\",\"description\":\"A reference to between two resource types.\",\"additionalProperties\":false,\"properties\":{\"resource\":{\"type\":\"string\"},\"create\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines what happens when the specified action is executed on the referenced resource.\",\"properties\":{\"triggers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines the type of trigger and the cascading strategy for it\",\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"create\",\"update\",\"delete\"]},\"cascade\":{\"description\":\"Defines the cascading strategy.\\n\\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\\n\\nIf 'delete' is specified, the referencing resource is deleted.\\n\\nIf not specified, the referenced resource cannot be deleted\\nwithout deleting the referencing resource first.\",\"enum\":[\"update\",\"delete\"]}}},\"minItems\":1,\"uniqueItems\":true}}},\"patch\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines what happens when the specified action is executed on the referenced resource.\",\"properties\":{\"triggers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines the type of trigger and the cascading strategy for it\",\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"create\",\"update\",\"delete\"]},\"cascade\":{\"description\":\"Defines the cascading strategy.\\n\\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\\n\\nIf 'delete' is specified, the referencing resource is deleted.\\n\\nIf not specified, the referenced resource cannot be deleted\\nwithout deleting the referencing resource first.\",\"enum\":[\"update\",\"delete\"]}}},\"minItems\":1,\"uniqueItems\":true}}},\"update\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines what happens when the specified action is executed on the referenced resource.\",\"properties\":{\"triggers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines the type of trigger and the cascading strategy for it\",\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"create\",\"update\",\"delete\"]},\"cascade\":{\"description\":\"Defines the cascading strategy.\\n\\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\\n\\nIf 'delete' is specified, the referencing resource is deleted.\\n\\nIf not specified, the referenced resource cannot be deleted\\nwithout deleting the referencing resource first.\",\"enum\":[\"update\",\"delete\"]}}},\"minItems\":1,\"uniqueItems\":true}}},\"delete\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines what happens when the specified action is executed on the referenced resource.\",\"properties\":{\"triggers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines the type of trigger and the cascading strategy for it\",\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"create\",\"update\",\"delete\"]},\"cascade\":{\"description\":\"Defines the cascading strategy.\\n\\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\\n\\nIf 'delete' is specified, the referencing resource is deleted.\\n\\nIf not specified, the referenced resource cannot be deleted\\nwithout deleting the referencing resource first.\",\"enum\":[\"update\",\"delete\"]}}},\"minItems\":1,\"uniqueItems\":true}}}}}},\"positioning\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Whether to enable position column for the instances of this resource. This is used for keeping an ordered list to enable custom sorting of the data using drag and drop features.\"},\"enforceOrderingGroupByFields\":{\"type\":\"array\",\"pattern\":\"^[a-zA-Z0-9]*$\",\"description\":\"Group resources by fields when handling resource positions\",\"items\":{\"type\":\"string\"},\"minItems\":1},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}\",\"description\":\"URL to use if not otherwise specified.\"},\"id\":{\"type\":\"string\",\"default\":\"id\",\"description\":\"Name of the field used when accessing singular entities.\"},\"history\":{\"description\":\"A definition of how versioning should happen for instances of this resource.\",\"default\":false,\"oneOf\":[{\"type\":\"boolean\",\"description\":\"Setting this to `true` is the same as using an object with the property `data` set to `true`.\"},{\"$ref\":\"#/components/schemas/ResourceHistoryDefinition\"}]},\"query\":{\"type\":\"object\",\"description\":\"Overrides for 'query' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"GET\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}\",\"description\":\"URL to use for this type of request.\"}}},\"get\":{\"type\":\"object\",\"description\":\"Overrides for 'get' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"GET\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}/{id}\",\"description\":\"URL to use for this type of request.\"}}},\"count\":{\"type\":\"object\",\"description\":\"Overrides for 'count' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"GET\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}/$count\",\"description\":\"URL to use for this type of request.\"}}},\"create\":{\"type\":\"object\",\"description\":\"Overrides for 'create' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"POST\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}/{id}\",\"description\":\"URL to use for this type of request.\"},\"hooks\":{\"$ref\":\"#/components/schemas/ResourceHooksDefinition\"}}},\"patch\":{\"type\":\"object\",\"description\":\"Overrides for 'patch' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"PATCH\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}/{id}\",\"description\":\"URL to use for this type of request.\"},\"hooks\":{\"$ref\":\"#/components/schemas/ResourceHooksDefinition\"}}},\"update\":{\"type\":\"object\",\"description\":\"Overrides for 'update' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"PUT\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}/{id}\",\"description\":\"URL to use for this type of request.\"},\"hooks\":{\"$ref\":\"#/components/schemas/ResourceHooksDefinition\"}}},\"delete\":{\"type\":\"object\",\"description\":\"Overrides for 'delete' requests.\",\"additionalProperties\":false,\"properties\":{\"query\":{\"type\":\"object\",\"description\":\"The query parameters to use in the request.\",\"additionalProperties\":{\"type\":\"string\"}},\"method\":{\"type\":\"string\",\"default\":\"DELETE\",\"description\":\"HTTP method to use for this type of request.\"},\"url\":{\"type\":\"string\",\"default\":\"/api/apps/{appId}/{resource}/{id}\",\"description\":\"URL to use for this type of request.\"},\"hooks\":{\"$ref\":\"#/components/schemas/ResourceHooksDefinition\"}}},\"views\":{\"$ref\":\"#/components/schemas/ResourceViewDefinition\"}}},\"ResourceDeleteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.delete\"],\"description\":\"Delete a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to delete.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceDeleteAllActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.delete.all\"],\"description\":\"Delete all instances of a resource.\\n> **Warning!**\\n>\\n> Use this action with caution to avoid losing precious data!\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to delete.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceDeleteBulkActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.delete.bulk\"],\"description\":\"Delete several instances of a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to delete.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceGetActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.get\"],\"description\":\"Get a single resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to get.\"},\"view\":{\"type\":\"string\",\"description\":\"The view to use for the resource.\"},\"id\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceHistoryDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"A definition of how versioning works for instances of this resource\",\"required\":[\"data\"],\"properties\":{\"data\":{\"type\":\"boolean\",\"default\":true,\"description\":\"If set to `false`, edits are still tracked, but exactly what changed is lost.\"}}},\"ResourceHistoryGetActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.history.get\"],\"description\":\"Get the complete history of a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to get.\"},\"method\":{\"enum\":[\"delete\",\"get\",\"patch\",\"post\",\"put\"],\"default\":\"get\",\"description\":\"The type of request to make.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceHooksDefinition\":{\"type\":\"object\",\"description\":\"Hooks that are triggered upon calling a resource action.\",\"additionalProperties\":false,\"minProperties\":1,\"properties\":{\"notification\":{\"$ref\":\"#/components/schemas/NotificationHookDefinition\"}}},\"ResourcePatchActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.patch\"],\"description\":\"Patch a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to patch.\"},\"id\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceQueryActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.query\"],\"description\":\"Query a list of resources.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to query.\"},\"view\":{\"type\":\"string\",\"description\":\"The view to use for the resource.\"},\"own\":{\"type\":\"boolean\",\"description\":\"If only the resources created by the authenticated app member should be included\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceSubscription\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"This describes how a user is subscribed to a resource.\",\"properties\":{\"create\":{\"type\":\"boolean\",\"description\":\"If true, the user is subscribed to any create actions for the resource type\"},\"update\":{\"type\":\"boolean\",\"description\":\"If true, the user is subscribed to any update actions for the resource type\"},\"delete\":{\"type\":\"boolean\",\"description\":\"If true, the user is subscribed to any delete actions for the resource type\"},\"subscriptions\":{\"type\":\"object\",\"description\":\"A mapping of resource IDs to individual resource subscriptions\",\"additionalProperties\":{\"type\":\"object\",\"description\":\"The subscription status of a user for a single resource.\",\"additionalProperties\":false,\"properties\":{\"update\":{\"type\":\"boolean\",\"description\":\"If true, the user is subscribed to update actions on this particular resource.\"},\"delete\":{\"type\":\"boolean\",\"description\":\"If true, the user will be notified when this particular resource is deleted.\"}}}}}},\"ResourceSubscriptionStatusActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.subscription.status\"],\"description\":\"Get the status of whether or not the user is subscriped to notifications for resource modifications.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to get the subscription state for.\"},\"action\":{\"enum\":[\"create\",\"delete\",\"update\"],\"description\":\"The resource action type to get the subscription state for.\",\"default\":\"update\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceSubscriptionSubscribeActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.subscription.subscribe\"],\"description\":\"Subscribe to notifications on resource modifications.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to subscribe to.\"},\"action\":{\"enum\":[\"create\",\"delete\",\"update\"],\"description\":\"The resource action type to subscribe to.\",\"default\":\"update\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceSubscriptionToggleActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.subscription.toggle\"],\"description\":\"Toggle whether or not to receive notifications on resource modifications.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to toggle the subscription state for.\"},\"action\":{\"enum\":[\"create\",\"delete\",\"update\"],\"description\":\"The resource action type to toggle the subscription state for.\",\"default\":\"update\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceSubscriptionUnsubscribeActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.subscription.unsubscribe\"],\"description\":\"Unsubscribe from notifications on resource modifications.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to unsubscribe from.\"},\"action\":{\"enum\":[\"create\",\"delete\",\"update\"],\"description\":\"The resource action type to unsubscribe from.\",\"default\":\"update\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceUpdateActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.update\"],\"description\":\"Update a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to update.\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceUpdatePositionsActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"resource\"],\"properties\":{\"type\":{\"enum\":[\"resource.update.positions\"],\"description\":\"Update the position of a resource.\"},\"resource\":{\"type\":\"string\",\"description\":\"The type of the resource to update.\"},\"id\":{\"$ref\":\"#/components/schemas/RemapperDefinition\"},\"query\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is.\"},\"body\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"remapper that results in the request body to send.\\n\\nIf not specified, the raw input data is used.\\n\"},\"proxy\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default requests will be proxied through the Appsemble API.\\n\\nThis allows to protect user data and ensures\\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\\ndisabled by setting this to `false`\\n\"},\"schema\":{\"description\":\"The name of the schema to validate against before submitting data.\",\"$ref\":\"#/components/schemas/JSONSchema\"},\"headers\":{\"type\":\"object\",\"description\":\"The headers to be set for the outgoing request\",\"additionalProperties\":false,\"properties\":{\"Content-Type\":{\"description\":\"Content type for the outgoing request\",\"enum\":[\"application/xml\",\"text/plain\",\"application/x-www-form-urlencoded\",\"multipart/form-data\"]}}},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"ResourceViewDefinition\":{\"type\":\"object\",\"minProperties\":1,\"description\":\"Alternative views of a resource that are modified using remappers and support different sets of roles.\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"A custom view for a resource.\",\"properties\":{\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to use this view.\",\"items\":{\"type\":\"string\"}},\"remap\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The modified view.\"}}}},\"SSLSecret\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"The SSL secret of an app.\",\"properties\":{\"certificate\":{\"type\":\"string\",\"description\":\"The public SSL certificate chain in PEM format.\"},\"key\":{\"type\":\"string\",\"description\":\"The SSL private key in PEM format.\"}}},\"SSOConfiguration\":{\"type\":\"object\",\"description\":\"A single sign on configuration which is exposed to users.\",\"additionalProperties\":false,\"properties\":{\"url\":{\"type\":\"string\",\"format\":\"url\",\"description\":\"The URL users will be redirected to in the login process.\"},\"name\":{\"type\":\"string\",\"description\":\"A user readable name for the configuration.\"},\"icon\":{\"type\":\"string\",\"description\":\"A Font Awesome icon.\"}}},\"ScimPatchOp\":{\"type\":\"object\",\"description\":\"A SCIM patch operation\",\"required\":[\"schemas\",\"operations\"],\"additionalProperties\":true,\"properties\":{\"schemas\":{\"type\":\"array\",\"maxItems\":1,\"minItems\":1,\"items\":{\"enum\":[\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"]}},\"operations\":{\"type\":\"array\",\"description\":\"Patch operations to apply to the resource\",\"items\":{\"anyOf\":[{\"type\":\"object\",\"description\":\"A SCIM patch single replace operation\",\"additionalProperties\":false,\"required\":[\"op\",\"path\",\"value\"],\"properties\":{\"op\":{\"enum\":[\"add\",\"replace\"]},\"name\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"value\":{}}},{\"type\":\"object\",\"description\":\"A SCIM patch bulk replace operation\",\"additionalProperties\":false,\"required\":[\"op\",\"path\"],\"properties\":{\"op\":{\"enum\":[\"remove\"]},\"path\":{\"type\":\"string\"}}}]}}}},\"ScimSecret\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"An app\\u2019s SCIM configuration.\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Whether or not SCIM is enabled for the app.\"},\"token\":{\"type\":\"string\",\"description\":\"The secret SCIM token\"}}},\"ScimUser\":{\"type\":\"object\",\"additionalProperties\":true,\"description\":\"The definition of a user according to the SCIM documentation.\",\"required\":[\"emails\",\"schemas\",\"userName\"],\"properties\":{\"schemas\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"userName\":{\"type\":\"string\",\"description\":\"A unique identifier for the user (generally maps to the Azure AD user principal name)\"},\"active\":{\"type\":\"boolean\"},\"meta\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Read-only metadata maintained by the service provider\",\"properties\":{\"resourceType\":{\"type\":\"string\"},\"created\":{\"type\":\"string\"},\"lastModified\":{\"type\":\"string\"},\"location\":{\"type\":\"string\"}}},\"emails\":{\"type\":\"array\",\"minLength\":1,\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"A user's email. By default, one of these should be of type 'work' and have 'primary' set to true. Value contains actual address\",\"required\":[\"primary\",\"type\",\"value\"],\"properties\":{\"primary\":{\"type\":\"boolean\"},\"type\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}}}}}},\"SecurityCronDefinition\":{\"type\":\"object\",\"description\":\"This describes the permissions that unauthenticated users have.\",\"additionalProperties\":false,\"properties\":{\"inherits\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The name of the role to inherit from.\\n\\nNote that this role must exist.\\n\",\"items\":{\"type\":\"string\"}},\"permissions\":{\"type\":\"array\",\"description\":\"Specific permissions within the app, which unauthenticated users should have\",\"items\":{\"type\":\"string\"}}}},\"SecurityDefaultDefinition\":{\"type\":\"object\",\"required\":[\"role\"],\"description\":\"The default role to apply to members.\",\"additionalProperties\":false,\"properties\":{\"policy\":{\"enum\":[\"everyone\",\"organization\",\"invite\"],\"default\":\"everyone\",\"description\":\"How the `default` role gets applied to users.\\n\\nThe following values are allowed:\\n- `everyone`: Every authenticated user gets the default role.\\n- `organization`: Every authenticated user gets the default role if they are in the same organization as the app.\\n- `invite`: The app member has to be invited to the app with a specific role.\\n\\n> **Important**: When [OAuth2](../guides/oauth2) or [SAML2.0](../guides/saml) is used in the\\n> app, you must set the policy to `everyone`. This will specifically allow every configured\\n> authentication method on the secrets page to be used as login method. If you do not want other\\n> Appsemble user accounts to be able to log in, you must `disable` the `appsemble login` options\\n> (including the Appsemble OAuth2 option) in the secrets page. If this option is enabled, any\\n> Appsemble user account is able to log in to the app and will receive the default role.\\n\"},\"role\":{\"type\":\"string\",\"description\":\"The default role to apply to members.\\n\\nThis must match with one of the roles defined within the security definition.\\n\"}}},\"SecurityDefinition\":{\"type\":\"object\",\"description\":\"This describes how the app is secured.\",\"additionalProperties\":false,\"properties\":{\"default\":{\"$ref\":\"#/components/schemas/SecurityDefaultDefinition\"},\"guest\":{\"$ref\":\"#/components/schemas/SecurityGuestDefinition\"},\"cron\":{\"$ref\":\"#/components/schemas/SecurityCronDefinition\"},\"roles\":{\"type\":\"object\",\"description\":\"This property defines the app roles that are available within the app.\",\"minProperties\":1,\"additionalProperties\":{\"$ref\":\"#/components/schemas/SecurityRoleDefinition\"}}}},\"SecurityGuestDefinition\":{\"type\":\"object\",\"description\":\"This describes the permissions that unauthenticated users have.\",\"additionalProperties\":false,\"properties\":{\"inherits\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The name of the role to inherit from.\\n\\nNote that this role must exist.\\n\",\"items\":{\"type\":\"string\"}},\"permissions\":{\"type\":\"array\",\"description\":\"Specific permissions within the app, which unauthenticated users should have\",\"items\":{\"type\":\"string\"}}}},\"SecurityRoleDefinition\":{\"type\":\"object\",\"description\":\"This describes a security role.\",\"additionalProperties\":false,\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"The description of the role.\"},\"defaultPage\":{\"type\":\"string\",\"description\":\"The default page to redirect users with this role to.\"},\"inherits\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The name of the role to inherit from.\\n\\nNote that this role must exist and can not inherit itself via this field or the `inherits` field\\nof the referenced role.\\n\",\"items\":{\"type\":\"string\"}},\"permissions\":{\"type\":\"array\",\"description\":\"Specific permissions within the app, which this role should have\",\"items\":{\"type\":\"string\"}}}},\"ShareActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"share\"],\"description\":\"The `share` action can be used to display a prompt that allows the user to share something with others, primarily via social media.\\n\\nDepending on whether the user\\u2019s browser supports a native share function it will either display a\\nnative dialog for sharing links, or display a more limited fallback in a dialog.\\n\"},\"url\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The url that is being shared.\"},\"title\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The title that should be shared.\"},\"text\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The main body that should be shared.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StaticActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"value\"],\"properties\":{\"type\":{\"enum\":[\"static\"],\"description\":\"The `static` action returns static data defined in the action definition.\\n\\nThis is useful for example for stubbing data.\\n\"},\"value\":{\"description\":\"The static value to return.\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StorageAppendActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"key\",\"value\"],\"properties\":{\"type\":{\"enum\":[\"storage.append\"],\"description\":\"Append data to an existing array in storage.\\n If the storage entry is a single object, it turns it into an array to append the data on.\\n\\nFor example:\\n```yaml\\ntype: storage.append\\nkey: temp\\nvalue: { root }\\nstorage: localStorage\\nremapBefore:\\n object.from:\\n text:\\n This is a new data item\\n value:\\n 1\\n```\\n\"},\"key\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the storage entry.\"},\"value\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The data to write on top of the storage entry.\"},\"storage\":{\"enum\":[\"indexedDB\",\"localStorage\",\"sessionStorage\",\"appStorage\"],\"description\":\"The mechanism used to store the data.\",\"default\":\"indexedDB\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StorageDeleteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"key\"],\"properties\":{\"type\":{\"enum\":[\"storage.delete\"],\"description\":\"Delete the item that is stored at the specified key.\\n\\nFor example:\\n```yaml\\ntype: storage.delete\\nkey: temp\\nstorage: localStorage\\n```\\n \"},\"key\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the storage entry to remove.\"},\"storage\":{\"enum\":[\"indexedDB\",\"localStorage\",\"sessionStorage\",\"appStorage\"],\"description\":\"The mechanism used to remove the data from.\",\"default\":\"indexedDB\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StorageReadActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"key\"],\"properties\":{\"type\":{\"enum\":[\"storage.read\"],\"description\":\"Read data from the app\\u2019s local storage.\\n\\nFor example:\\n```yaml\\ntype: storage.read\\nkey: temp\\nstorage: localStorage\\n```\\n\\n \"},\"key\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the storage entry.\"},\"storage\":{\"enum\":[\"indexedDB\",\"localStorage\",\"sessionStorage\",\"appStorage\"],\"description\":\"The mechanism used to read the data from.\",\"default\":\"indexedDB\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StorageSubtractActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"key\"],\"properties\":{\"type\":{\"enum\":[\"storage.subtract\"],\"description\":\"Subtract last item from a storage entry.\\n\\nIf the entry consists of only one item, turns it into a singular object.\\n\\nIf the entry is a single item, the entry is removed entirely.\\n\\nFor example:\\n```yaml\\ntype: storage.subtract\\nkey: temp\\nstorage: localStorage\\n```\\n \"},\"key\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the storage entry.\"},\"storage\":{\"enum\":[\"indexedDB\",\"localStorage\",\"sessionStorage\",\"appStorage\"],\"description\":\"The mechanism used to read the data from.\",\"default\":\"indexedDB\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StorageUpdateActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"key\",\"value\"],\"properties\":{\"type\":{\"enum\":[\"storage.update\"],\"description\":\"Update an existing item in storage, or update an item inside a stored array.\\n\\nFor example:\\n```yaml\\ntype: storage.update\\nkey: temp\\nitem: 1\\nvalue: { root }\\nstorage: localStorage\\nremapBefore:\\n object.from:\\n text: { prop: text }\\n value: { prop: value }\\n newField: \\\"New field\\\"\\n```\\n \"},\"key\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the storage entry.\"},\"item\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the item in an array to update.\"},\"value\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The data to update the specified item with.\"},\"storage\":{\"enum\":[\"indexedDB\",\"localStorage\",\"sessionStorage\",\"appStorage\"],\"description\":\"The mechanism used to store the data.\",\"default\":\"indexedDB\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"StorageWriteActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"key\",\"value\"],\"properties\":{\"type\":{\"enum\":[\"storage.write\"],\"description\":\"Write data to the app\\u2019s local storage.\\n\\nFor example:\\n```yaml\\ntype: storage.write\\nkey: temp\\nvalue: { root }\\nstorage: localStorage\\nremapBefore:\\n object.from:\\n data:\\n cool data\\n value:\\n 1\\n```\\n \"},\"key\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The key of the storage entry.\"},\"value\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The data to write to the storage entry.\"},\"expiry\":{\"enum\":[\"1d\",\"3d\",\"7d\",\"12h\"],\"description\":\"Set an expiry for your data, only works with the localStorage\"},\"storage\":{\"enum\":[\"indexedDB\",\"localStorage\",\"sessionStorage\",\"appStorage\"],\"description\":\"The mechanism used to store the data.\",\"default\":\"indexedDB\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"SubPage\":{\"type\":\"object\",\"description\":\"This describes what a sub page will look like in the app.\",\"required\":[\"blocks\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the sub page.\"},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this page.\\n\\nIf the user doesn\\u2019t have any of the roles in the list the page will be unavailable to them. An empty\\nlist can be used to specify that users need to log in but do not need a specific role.\\n\\nUsers trying to visit a page without having the correct roles will be redirected to the first page\\nthat they are allowed to view. If there aren\\u2019t any accessible pages, the user will be logged out and\\ninstructed to contact the app owner to get permissions.\\n\",\"items\":{\"type\":\"string\"}},\"blocks\":{\"type\":\"array\",\"minItems\":1,\"description\":\"The blocks that make up a page.\",\"items\":{\"$ref\":\"#/components/schemas/BlockDefinition\"}}}},\"TabsPageDefinition\":{\"type\":\"object\",\"description\":\"Shows a set of subpages as tabs at the top of the page.\",\"oneOf\":[{\"required\":[\"type\",\"tabs\"]},{\"required\":[\"type\",\"definition\"]}],\"additionalProperties\":true,\"properties\":{\"type\":{\"enum\":[\"tabs\"]},\"tabs\":{\"type\":\"array\",\"minItems\":1,\"description\":\"Each of the available tabs for the tabs page.\",\"items\":{\"$ref\":\"#/components/schemas/SubPage\"}},\"definition\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Generate tabs dynamically\",\"required\":[\"events\",\"foreach\"],\"properties\":{\"events\":{\"$ref\":\"#/components/schemas/EventsDefinition\"},\"foreach\":{\"$ref\":\"#/components/schemas/SubPage\"}}},\"actions\":{\"$ref\":\"#/components/schemas/PageActionsDefinition\"},\"name\":{\"type\":\"string\",\"maxLength\":50,\"description\":\"The name of an app.\\n\\nThis field is always required and must be unique within the app, meaning that it is not possible to\\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\\n\\n> **Note**: The URL used to navigate to pages is determined by this property.\\n\"},\"hideName\":{\"type\":\"boolean\",\"description\":\"Whether or not the page name should be displayed in the *app bar*.\"},\"navTitle\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"The name of the page when displayed in the navigation menu.\\n\\n Context property `name` can be used to access the name of the page.\\n \"},\"hideNavTitle\":{\"type\":\"boolean\",\"description\":\"Whether or not the page should be displayed in navigational menus.\\n\\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\\n page from menus.\\n \",\"default\":false},\"navigation\":{\"$ref\":\"#/components/schemas/AppLayoutDefinition/properties/navigation\",\"description\":\"The type of navigation displayed on the page.\\n\\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\\nApp navigation are not set.\\n\\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\\nmenu. Set to `hidden` to display no navigational menus at all.\\n\"},\"icon\":{\"type\":\"string\",\"description\":\"An optional icon from the fontawesome icon set\\n\\nThis will be displayed in the navigation menu.\\n\"},\"parameters\":{\"type\":\"array\",\"description\":\"Page parameters can be used for linking to a page that should display a single resource.\\n\\nThis defined as a list of strings representing the properties to pass through. More often than not\\npassing `id` through is sufficient, depending on the block.\\n\",\"items\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":30}},\"roles\":{\"type\":\"array\",\"description\":\"The list of roles that are allowed to view this page.\\n\\nIf the user doesn\\u2019t have any of the roles in the list the page will be unavailable to them. An empty\\nlist can be used to specify that users need to log in but do not need a specific role.\\n\\nUsers trying to visit a page without having the correct roles will be redirected to the first page\\nthat they are allowed to view. If there aren\\u2019t any accessible pages, the user will be logged out and\\ninstructed to contact the app owner to get permissions.\\n\",\"items\":{\"type\":\"string\"}},\"theme\":{\"$ref\":\"#/components/schemas/Theme\"},\"badgeCount\":{\"$ref\":\"#/components/schemas/RemapperDefinition\",\"description\":\"A Remapper that resolves to a number to be visibile in the side-menu.\"}},\"required\":[\"name\"]},\"Theme\":{\"type\":\"object\",\"description\":\"A generic theme definition.\",\"additionalProperties\":false,\"minProperties\":1,\"properties\":{\"themeColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#ffffff\",\"description\":\"The generic theme color of the app.\\n\\nThis is used for example in the URL bar on Android.\\n\"},\"splashColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#ffffff\",\"description\":\"The background color of the PWA splash screen.\\n\\nThis defaults to the theme color.\\n\"},\"primaryColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#5393ff\",\"description\":\"The primary color used within the app.\\n\\nThis is used in various elements like the navbar.\\n\"},\"linkColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#0440ad\",\"description\":\"The color used for links.\"},\"infoColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#a7d0ff\",\"description\":\"The color used for informational messages.\"},\"successColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#1fd25b\",\"description\":\"The color used for successful actions.\"},\"warningColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#fed719\",\"description\":\"The color used for warning messages.\"},\"dangerColor\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"default\":\"#ff2800\",\"description\":\"The color used for error messages.\"},\"tileLayer\":{\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png\",\"description\":\"The tileLayer to use for Leaflet maps.\"},\"font\":{\"description\":\"The font to use in the app.\",\"anyOf\":[{\"$ref\":\"#/components/schemas/CustomFontDefinition\"},{\"$ref\":\"#/components/schemas/GoogleFontDefinition\"}]}}},\"ThrowActionDefinition\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"type\":{\"enum\":[\"throw\"],\"description\":\"This action throws a new exception based on the data that is passed through.\\n\\nThis can be used to create a custom error that ends up in the error action handler.\\n\"},\"remapBefore\":{},\"remapAfter\":{},\"onSuccess\":{},\"onError\":{}}},\"Training\":{\"type\":\"object\",\"description\":\"Object representation of a training\",\"additionalProperties\":false,\"required\":[\"id\"],\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Id of the training\"}}},\"TrainingCompleted\":{\"type\":\"object\",\"description\":\"Object which stores that a user has completed a certain training\",\"additionalProperties\":false,\"properties\":{\"trainingId\":{\"type\":\"string\",\"description\":\"The training that the user has completed.\",\"readOnly\":true},\"userId\":{\"type\":\"string\",\"description\":\"The user who completed the training\"}}},\"User\":{\"type\":\"object\",\"description\":\"An object representing a user\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The id of the user.\"}}},\"UserEmail\":{\"type\":\"object\",\"description\":\"\\n An email address that is linked to a user.\\n\\n Users may use any of their email addresses to login.\\n \",\"required\":[\"email\"],\"additionalProperties\":false,\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The email address that is registered\"},\"verified\":{\"type\":\"boolean\",\"readOnly\":true,\"description\":\"Wether or not the email address has been verified by the user.\"}}},\"UserInfo\":{\"type\":\"object\",\"description\":\"An object representing the OAuth2 info of a user\",\"additionalProperties\":false,\"properties\":{\"sub\":{\"type\":\"string\",\"readOnly\":true,\"description\":\"The id of the user.\"},\"name\":{\"type\":\"string\",\"description\":\"The full name of the user.\"},\"email\":{\"type\":\"string\",\"description\":\"The email of the user.\"},\"email_verified\":{\"type\":\"boolean\",\"description\":\"Whether this email address has been verified.\"},\"picture\":{\"type\":\"string\",\"format\":\"url\",\"description\":\"The URL of the profile picture of the user.\"},\"locale\":{\"type\":\"string\",\"description\":\"The locale of the user.\"},\"timezone\":{\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/La_Rioja\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Ciudad_Juarez\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Fort_Nelson\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Monticello\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Ojinaga\",\"America/Panama\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Colombo\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Hebron\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Ulyanovsk\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\"],\"description\":\"The time zone of the user.\"},\"subscribed\":{\"type\":\"boolean\",\"description\":\"If the user is subscribed to the newsletter.\"}}},\"WebhookDefinition\":{\"type\":\"object\",\"required\":[\"schema\",\"action\"],\"description\":\"A webhook definition defines app specific callable endpoints that Appsemble can handle.\",\"additionalProperties\":false,\"properties\":{\"schema\":{\"$ref\":\"#/components/schemas/JSONSchemaRoot\",\"description\":\"JSON schema definition of the payload.\"},\"action\":{\"description\":\"The action to run when the webhook is triggered.\",\"$ref\":\"#/components/schemas/ActionDefinition\"}}}},\"securitySchemes\":{\"app\":{\"type\":\"oauth2\",\"description\":\"\\n OAuth2 login for apps.\\n\\n The authorization code flow is recommended. The password flow exists for legacy apps and will be\\n removed in the future.\\n \",\"flows\":{\"authorizationCode\":{\"authorizationUrl\":\"/connect/authorize\",\"tokenUrl\":\"/apps/{appId}/auth/oauth2/token\",\"refreshUrl\":\"/apps/{appId}/auth/oauth2/token\",\"scopes\":{\"email\":\"Read the user email address.\",\"openid\":\"Login the user to the requesting app using OpenID.\",\"profile\":\"Read the user profile, including the display name and profile picture.\",\"resources:manage\":\"Manage app resources on behalf of a user.\",\"groups:read\":\"Read the groups the user is a part of.\",\"groups:write\":\"Add new members to a group.\"}},\"password\":{\"tokenUrl\":\"/apps/{appId}/auth/oauth2/token\",\"refreshUrl\":\"/apps/{appId}/auth/oauth2/token\",\"scopes\":{\"email\":\"Read the user email address.\",\"openid\":\"Login the user to the requesting app using OpenID.\",\"profile\":\"Read the user profile, including the display name and profile picture.\",\"resources:manage\":\"Manage app resources on behalf of a user.\",\"groups:read\":\"Read the groups the user is a part of.\",\"groups:write\":\"Add new members to a group.\"}}}},\"basic\":{\"type\":\"http\",\"scheme\":\"basic\",\"description\":\"Used for logging in to the web interface\"},\"cli\":{\"type\":\"oauth2\",\"description\":\"\\n OAuth2 login for client credentials.\\n\\n For example the Appsemble CLI uses this.\\n \",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"/auth/oauth2/token\",\"scopes\":{\"apps:export\":\"Export apps as zip files\",\"apps:write\":\"Create and update apps\",\"apps:delete\":\"Delete apps\",\"blocks:write\":\"Register and update blocks, and publish new block versions.\",\"blocks:delete\":\"Delete specific block versions.\",\"organizations:write\":\"Create and manage organizations.\",\"resources:read\":\"Read app resources on behalf of a user.\",\"resources:write\":\"Modify app resources on behalf of a user.\",\"assets:write\":\"Create app assets on behalf of a user.\",\"groups:read\":\"Read information about the user\\u2019s groups.\",\"groups:write\":\"Read information about the user\\u2019s groups.\"}}}},\"scim\":{\"type\":\"http\",\"scheme\":\"bearer\",\"description\":\"Used SCIM clients\"},\"studio\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"jwt\",\"description\":\"Used for authenticating requests made using Appsemble studio interface.\"},\"webhook\":{\"type\":\"http\",\"scheme\":\"bearer\",\"description\":\"Used for webhook calls\"}}},\"externalDocs\":{\"description\":\"Appsemble developer documentation\",\"url\":\"https://appsemble.app:9999/docs\"},\"info\":{\"title\":\"Appsemble\",\"description\":\"Welcome to the Appsemble API.\\n\\nThe app studio can be found on\\n> https://appsemble.app:9999\\n\\nThe OpenAPI explorer can be found on\\n> https://appsemble.app:9999/api-explorer\\n\",\"license\":{\"name\":\"LGPL\",\"url\":\"https://gitlab.com/appsemble/appsemble/blob/main/LICENSE.md\"},\"version\":\"0.33.5\"},\"paths\":{\"/api/app-collections/{appCollectionId}/apps/{appId}/pinned\":{\"post\":{\"tags\":[\"main\",\"app-collection\",\"app\"],\"description\":\"Pin an app to an app collection\",\"operationId\":\"pinAppToAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection to pin the app to\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}},{\"name\":\"appId\",\"in\":\"path\",\"description\":\"The id of the app to pin\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/App/properties/id\"}}],\"responses\":{\"200\":{\"description\":\"The app was pinned to the app collection\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"pinned\":{\"type\":\"string\",\"format\":\"date-time\"}}}}}}},\"security\":[{\"studio\":[]}]},\"delete\":{\"tags\":[\"main\",\"app-collection\",\"app\"],\"description\":\"Unpin an app from an app collection\",\"operationId\":\"unpinAppFromAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection to unpin the app from\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}},{\"name\":\"appId\",\"in\":\"path\",\"description\":\"The id of the app to unpin\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/App/properties/id\"}}],\"responses\":{\"204\":{\"description\":\"The app was unpinned from the app collection\"}},\"security\":[{\"studio\":[]}]}},\"/api/app-collections/{appCollectionId}/apps/{appId}\":{\"delete\":{\"tags\":[\"main\",\"app-collection\",\"app\"],\"description\":\"Remove an app from an app collection\",\"operationId\":\"removeAppFromAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}},{\"name\":\"appId\",\"in\":\"path\",\"description\":\"The id of the app\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"responses\":{\"204\":{\"description\":\"The app was removed from the app collection\"}},\"security\":[{\"studio\":[]}]}},\"/api/app-collections/{appCollectionId}/apps\":{\"get\":{\"tags\":[\"main\",\"app-collection\",\"app\"],\"description\":\"Get a list of apps in an app collection\",\"operationId\":\"queryAppCollectionApps\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}},{\"name\":\"language\",\"in\":\"query\",\"description\":\"The language to include the translations of, if available\",\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A list of apps\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/components/schemas/App\"},{\"type\":\"object\",\"properties\":{\"pinned\":{\"type\":\"string\",\"format\":\"date-time\",\"nullable\":true}}}]}}}}}},\"security\":[{\"studio\":[]},{}]},\"post\":{\"tags\":[\"main\",\"app-collection\",\"app\"],\"description\":\"Add an app to an app collection\",\"operationId\":\"addAppToAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"requestBody\":{\"description\":\"The app to add to the app collection\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"AppId\":{\"$ref\":\"#/components/schemas/App/properties/id\"}}}}}},\"responses\":{\"204\":{\"description\":\"The app was added to the app collection\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/app-collections/{appCollectionId}/expert/profile-image\":{\"get\":{\"tags\":[\"main\",\"app-collection\"],\"description\":\"Get an app collection\\u2019s expert\\u2019s profile image\",\"operationId\":\"getAppCollectionExpertProfileImage\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"responses\":{\"200\":{\"description\":\"The app collection\\u2019s expert\\u2019s profile image\",\"content\":{\"image/png\":{},\"image/jpeg\":{},\"image/tiff\":{},\"image/webp\":{}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/app-collections/{appCollectionId}/header-image\":{\"get\":{\"tags\":[\"main\",\"app-collection\"],\"description\":\"Get an app collection\\u2019s header image\",\"operationId\":\"getAppCollectionHeaderImage\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"responses\":{\"200\":{\"description\":\"The app collection\\u2019s header image\",\"content\":{\"image/png\":{},\"image/jpeg\":{},\"image/tiff\":{},\"image/webp\":{}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/app-collections/{appCollectionId}\":{\"get\":{\"tags\":[\"main\",\"app-collection\"],\"description\":\"Get an app collection\",\"operationId\":\"getAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"responses\":{\"200\":{\"description\":\"An app collection\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppCollection\"}}}}},\"security\":[{\"studio\":[]},{}]},\"patch\":{\"tags\":[\"main\",\"app-collection\"],\"description\":\"Update an app collection\",\"operationId\":\"updateAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"requestBody\":{\"description\":\"The app collection to update\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"$ref\":\"#/components/schemas/AppCollectionDefinition\"},\"encoding\":{\"expertProfileImage\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"},\"headerImage\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"200\":{\"description\":\"The updated app collection\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppCollection\"}}}}},\"security\":[{\"studio\":[]}]},\"delete\":{\"tags\":[\"main\",\"app-collection\"],\"description\":\"Delete an app collection\",\"operationId\":\"deleteAppCollection\",\"parameters\":[{\"name\":\"appCollectionId\",\"in\":\"path\",\"description\":\"The id of the app collection\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppCollection/properties/id\"}}],\"responses\":{\"204\":{\"description\":\"The app collection was deleted\"}},\"security\":[{\"studio\":[]}]}},\"/api/app-collections\":{\"get\":{\"tags\":[\"main\",\"app-collection\"],\"description\":\"Get a list of app collections\",\"operationId\":\"queryAppCollections\",\"responses\":{\"200\":{\"description\":\"A list of app collections\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppCollection\"}}}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/app-invites/{token}/respond\":{\"parameters\":[{\"name\":\"token\",\"in\":\"path\",\"description\":\"The token of the invite.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"app-invite\"],\"description\":\"Respond to a given invitation.\",\"operationId\":\"respondAppInvite\",\"requestBody\":{\"description\":\"The response of the invitation.\\n\\n If response is true, user will join the app. If response is false, the user declines the invite and the invite is removed.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"response\"],\"properties\":{\"response\":{\"type\":\"boolean\"},\"password\":{\"type\":\"string\",\"minLength\":8},\"timezone\":{\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/La_Rioja\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Ciudad_Juarez\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Fort_Nelson\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Monticello\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Ojinaga\",\"America/Panama\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Colombo\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Hebron\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Ulyanovsk\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\"]},\"locale\":{\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The response has been processed.\"}}}},\"/api/app-invites/{token}\":{\"parameters\":[{\"name\":\"token\",\"in\":\"path\",\"description\":\"The token of the invite.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"app-invite\"],\"description\":\"Fetch information about an invite.\",\"operationId\":\"getAppInvite\",\"responses\":{\"200\":{\"description\":\"An invite response\",\"$ref\":\"#/components/responses/invite\"}}}},\"/api/app-members/{appMemberId}/picture\":{\"parameters\":[{\"name\":\"appMemberId\",\"in\":\"path\",\"description\":\"The id of the member on which to perform the operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppMember/properties/id\"}}],\"get\":{\"tags\":[\"common\",\"app-member\"],\"description\":\"Get an app member\\u2019s profile picture.\\n\\n This will return a 404 if the user has not uploaded one.\",\"operationId\":\"getAppMemberPicture\",\"responses\":{\"200\":{\"description\":\"The profile picture of the app member.\",\"content\":{\"image/png\":{},\"image/jpeg\":{},\"image/tiff\":{},\"image/webp\":{}}}}}},\"/api/app-members/{appMemberId}/properties\":{\"parameters\":[{\"name\":\"appMemberId\",\"in\":\"path\",\"description\":\"The id of the app member on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppMember/properties/id\"}}],\"patch\":{\"tags\":[\"common\",\"app-member\"],\"description\":\"Patch the properties of an app member.\",\"operationId\":\"patchAppMemberProperties\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"properties\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"description\":\"The member\\u2019s custom properties.\"}}}}}},\"responses\":{\"200\":{\"description\":\"The updated app member\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMember\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[]}]}},\"/api/app-members/{appMemberId}/role\":{\"parameters\":[{\"name\":\"appMemberId\",\"in\":\"path\",\"description\":\"The id of the app member on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppMember/properties/id\"}}],\"put\":{\"tags\":[\"common\",\"app\",\"member\"],\"description\":\"Patch an app member.\",\"operationId\":\"updateAppMemberRole\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"role\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"The updated app member\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMember\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[]}]}},\"/api/app-members/{appMemberId}\":{\"parameters\":[{\"name\":\"appMemberId\",\"in\":\"path\",\"description\":\"The id of the app member on which to perform an operation\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/AppMember/properties/id\"}}],\"delete\":{\"tags\":[\"common\",\"app-member\"],\"description\":\"Delete an app member.\",\"operationId\":\"deleteAppMember\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"responses\":{\"204\":{\"description\":\"The app member was deleted successfully.\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{}]}},\"/api/apps/{appId}/actions/{path}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"in\":\"path\",\"name\":\"path\",\"description\":\"The path to the action to execute.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"app\",\"action\"],\"description\":\"Proxy a GET request action\",\"operationId\":\"proxyGet\",\"responses\":{\"default\":{\"description\":\"The proxied response\"}},\"security\":[{\"app\":[\"email\",\"profile\"]},{}],\"parameters\":[{\"in\":\"query\",\"name\":\"data\",\"description\":\"The data that was passed to the action\",\"required\":true,\"schema\":{\"type\":\"string\"}}]},\"delete\":{\"tags\":[\"app\",\"action\"],\"description\":\"Proxy a DELETE request action\",\"operationId\":\"proxyDelete\",\"responses\":{\"default\":{\"description\":\"The proxied response\"}},\"security\":[{\"app\":[\"email\",\"profile\"]},{}],\"parameters\":[{\"in\":\"query\",\"name\":\"data\",\"description\":\"The data that was passed to the action\",\"required\":true,\"schema\":{\"type\":\"string\"}}]},\"patch\":{\"tags\":[\"app\",\"action\"],\"description\":\"Proxy a PATCH request action\",\"operationId\":\"proxyPatch\",\"responses\":{\"default\":{\"description\":\"The proxied response\"}},\"security\":[{\"app\":[\"email\",\"profile\"]},{}],\"requestBody\":{\"description\":\"The data that was passed to the action\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"description\":\"A `multipart/form-data` representation of a resource.\",\"additionalProperties\":true,\"properties\":{\"resource\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}},\"assets\":{\"type\":\"array\",\"description\":\"A list of assets that should be linked to the resource.\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}}}}},\"*/*\":{}}}},\"post\":{\"tags\":[\"app\",\"action\"],\"description\":\"Proxy a POST request action\",\"operationId\":\"proxyPost\",\"responses\":{\"default\":{\"description\":\"The proxied response\"}},\"security\":[{\"app\":[\"email\",\"profile\"]},{}],\"requestBody\":{\"description\":\"The data that was passed to the action\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"description\":\"A `multipart/form-data` representation of a resource.\",\"additionalProperties\":true,\"properties\":{\"resource\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}},\"assets\":{\"type\":\"array\",\"description\":\"A list of assets that should be linked to the resource.\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}}}}},\"*/*\":{}}}},\"put\":{\"tags\":[\"app\",\"action\"],\"description\":\"Proxy a PUT request action\",\"operationId\":\"proxyPut\",\"responses\":{\"default\":{\"description\":\"The proxied response\"}},\"security\":[{\"app\":[\"email\",\"profile\"]},{}],\"requestBody\":{\"description\":\"The data that was passed to the action\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"description\":\"A `multipart/form-data` representation of a resource.\",\"additionalProperties\":true,\"properties\":{\"resource\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}},\"assets\":{\"type\":\"array\",\"description\":\"A list of assets that should be linked to the resource.\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}}}}},\"*/*\":{}}}}},\"/api/apps/{appId}/assets/\\\\$count\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Get the number of assets in the app.\",\"operationId\":\"countAppAssets\",\"responses\":{\"200\":{\"description\":\"The number of assets in the app.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"number\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:read\"]},{}]}},\"/api/apps/{appId}/assets/{assetId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/assetId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Get a single asset\",\"operationId\":\"getAppAssetById\",\"responses\":{\"200\":{\"description\":\"The asset that matches the given id.\"}}},\"head\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Get the headers for a single asset\",\"operationId\":\"getAppAssetHeadersById\",\"responses\":{\"200\":{\"description\":\"The headers of the asset that matches the given id.\"}}},\"delete\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Remove an existing asset\",\"operationId\":\"deleteAppAsset\",\"responses\":{\"204\":{\"description\":\"The asset was successfully deleted.\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]}]}},\"/api/apps/{appId}/assets\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Get all of the app\\u2019s assets.\",\"operationId\":\"queryAppAssets\",\"parameters\":[{\"$ref\":\"#/components/parameters/$skip\"},{\"$ref\":\"#/components/parameters/$top\"},{\"$ref\":\"#/components/parameters/seed\"}],\"responses\":{\"200\":{\"description\":\"The assets associated with the app.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Asset\"}}}}},\"security\":[{\"studio\":[]},{}]},\"post\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Upload a new asset.\",\"operationId\":\"createAppAsset\",\"parameters\":[{\"$ref\":\"#/components/parameters/seed\"}],\"requestBody\":{\"description\":\"The asset to upload.\",\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"description\":\"The request body for creating an asset.\",\"additionalProperties\":false,\"required\":[\"file\"],\"properties\":{\"file\":{\"type\":\"string\",\"format\":\"binary\",\"writeOnly\":true,\"description\":\"The binary data of the asset. This may include a filename.\"},\"name\":{\"type\":\"string\",\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"description\":\"The given name of the asset. Assets may be referenced by their name or ID in the API.\"},\"clonable\":{\"type\":\"boolean\",\"description\":\"Whether the asset should be transferable when cloning the app they are in.\"}}}}}},\"responses\":{\"201\":{\"description\":\"The asset that was created.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Asset\"}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"assets:write\"]},{}]},\"delete\":{\"tags\":[\"common\",\"app\",\"asset\"],\"description\":\"Delete multiple app assets.\",\"operationId\":\"deleteAppAssets\",\"parameters\":[{\"$ref\":\"#/components/parameters/seed\"}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"description\":\"An array of asset IDs to remove.\",\"items\":{\"$ref\":\"#/components/schemas/Asset/properties/id\"}}}}},\"responses\":{\"204\":{\"description\":\"The app assets have been deleted successfully.\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"assets:write\"]},{}]}},\"/api/apps/{appId}/broadcast\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\"],\"description\":\"Broadcast a push notification to every subscriber of the app.\",\"operationId\":\"sendAppNotifications\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"description\":\"The data to include in the notification\",\"required\":[\"body\"],\"properties\":{\"title\":{\"description\":\"The title of the notification. This defaults to the name of the app if not otherwise specified.\",\"type\":\"string\"},\"body\":{\"description\":\"The content of the notification\",\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The notification has been successfully broadcasted.\"}},\"security\":[{\"studio\":[]}]}},\"/api/apps/{appId}/demo-groups\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"demo-group\"],\"description\":\"Get a list of app groups.\",\"operationId\":\"getAppDemoGroups\",\"responses\":{\"200\":{\"description\":\"The list of all groups.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"description\":\"An app demo group\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"}}}}}}}}}},\"/api/apps/{appId}/demo-members\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/roles\"}],\"get\":{\"tags\":[\"common\",\"app\",\"demo-member\"],\"description\":\"Fetch all demo members of an app.\",\"operationId\":\"queryAppDemoMembers\",\"responses\":{\"200\":{\"description\":\"The list of app demo members.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppMemberInfo\"}}}}}}}},\"/api/apps/{appId}/email\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\"],\"description\":\"Get the app\\u2019s email settings.\",\"operationId\":\"getAppEmailSettings\",\"responses\":{\"200\":{\"description\":\"The current app email settings\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"emailName\":{\"type\":\"string\",\"description\":\"The name used for emails.\"},\"emailHost\":{\"type\":\"string\",\"description\":\"The hostname of the SMTP server.\"},\"emailPassword\":{\"type\":\"boolean\",\"description\":\"Whether a password is set.\"},\"emailUser\":{\"type\":\"string\",\"description\":\"The username used to authenticate against the SMTP server.\"},\"emailPort\":{\"type\":\"string\",\"description\":\"The port used for the SMTP server.\"},\"emailSecure\":{\"type\":\"boolean\",\"description\":\"Whether TLS is being used.\"}}}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/export\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\"],\"description\":\"Export an app as a zip file\",\"operationId\":\"exportApp\",\"parameters\":[{\"name\":\"resources\",\"schema\":{\"type\":\"boolean\"},\"description\":\"Whether to include resources for an app.\",\"in\":\"query\"},{\"name\":\"assets\",\"schema\":{\"type\":\"boolean\"},\"description\":\"Whether to include assets in the export file\",\"in\":\"query\"},{\"name\":\"screenshots\",\"schema\":{\"type\":\"boolean\"},\"description\":\"Whether to include screenshots in the export file\",\"in\":\"query\"},{\"name\":\"readmes\",\"schema\":{\"type\":\"boolean\"},\"description\":\"Whether to include readmes in the export file\",\"in\":\"query\"}],\"responses\":{\"200\":{\"description\":\"App exported successfully.\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:export\"]}]}},\"/api/apps/{appId}/groups\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"group\"],\"description\":\"Get a list of app groups.\",\"operationId\":\"getAppGroups\",\"responses\":{\"200\":{\"description\":\"The list of all groups.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"description\":\"An app group\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"}}}}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"groups:read\"]},{}]},\"post\":{\"tags\":[\"common\",\"app\",\"group\"],\"description\":\"Create a new group.\",\"operationId\":\"createAppGroup\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"requestBody\":{\"description\":\"The group to create.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"annotations\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}}}}}},\"responses\":{\"201\":{\"description\":\"The created group\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"},\"role\":{\"type\":\"string\",\"description\":\"The role of the user who created the group\",\"enum\":[\"member\"]}}}}}}},\"security\":[{\"app\":[\"groups:write\"]},{\"studio\":[]},{\"cli\":[\"groups:write\"]}]}},\"/api/apps/{appId}/icon\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\"],\"description\":\"Get the current app icon.\",\"operationId\":\"getAppIcon\",\"responses\":{\"200\":{\"description\":\"The icon of the app that matches the given id.\",\"content\":{\"image/png\":{},\"image/jpeg\":{},\"image/tiff\":{},\"image/webp\":{}}}}},\"delete\":{\"tags\":[\"main\",\"app\"],\"description\":\"Delete the current app icon.\",\"operationId\":\"deleteAppIcon\",\"responses\":{\"204\":{\"description\":\"The icon has been successfully removed\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/invites/resend\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\"],\"description\":\"Request to resend an invitation.\",\"operationId\":\"resendAppInvite\",\"requestBody\":{\"description\":\"The email of the person to resend the invitation to.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The invite has been sent.\"}},\"security\":[{\"studio\":[]}]}},\"/api/apps/{appId}/invites\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"app\",\"invite\"],\"description\":\"Get a list of invited app members.\",\"operationId\":\"getAppInvites\",\"responses\":{\"200\":{\"description\":\"The list of all invites.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"},\"role\":{\"type\":\"string\"}}}}}}}},\"security\":[{\"studio\":[]}]},\"post\":{\"tags\":[\"app\",\"invite\"],\"description\":\"Invite a new app member to an app.\",\"operationId\":\"createAppInvites\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"requestBody\":{\"description\":\"The invite to create.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"email\",\"role\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The email address of the user to invite.\"},\"role\":{\"type\":\"string\",\"description\":\"The role to invite the user as.\"}}}}}}},\"responses\":{\"200\":{\"description\":\"The invited member\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMember\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"app:write\"]}]},\"delete\":{\"tags\":[\"app\",\"invite\"],\"description\":\"Revoke an app member invitation.\",\"operationId\":\"deleteAppInvite\",\"requestBody\":{\"description\":\"The email address to revoke the invite of.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The invitation has been successfully revoked.\"}},\"security\":[{\"studio\":[]}]}},\"/api/apps/{appId}/lock\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\"],\"description\":\"Update the locked property an app.\",\"operationId\":\"setAppLock\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"locked\"],\"properties\":{\"locked\":{\"$ref\":\"#/components/schemas/App/properties/locked\",\"description\":\"Whether the app should be locked.\"}}}}}},\"responses\":{\"204\":{\"description\":\"Lock status successfully changed\",\"content\":{\"application/zip\":{}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/maskable-icon\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"delete\":{\"tags\":[\"main\",\"app\"],\"description\":\"Delete the current app\\u2019s maskable icon.\",\"operationId\":\"deleteAppMaskableIcon\",\"responses\":{\"204\":{\"description\":\"The icon has been successfully removed\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/members/current/groups\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"app\",\"member\",\"current-member\"],\"description\":\"Get a list of groups that the app member is a member of.\",\"operationId\":\"getCurrentAppMemberGroups\",\"responses\":{\"200\":{\"description\":\"The list of groups of the app member.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"},\"role\":{\"type\":\"string\"}}}}}}}},\"security\":[{\"app\":[]}]}},\"/api/apps/{appId}/members/current/link\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\",\"member\",\"current-member\"],\"description\":\"Link the app member to an unlinked authorization.\",\"operationId\":\"linkCurrentAppMember\",\"security\":[{\"app\":[]}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"externalId\":{\"type\":\"string\",\"description\":\"The external id of the of the external user.\\n\\nThe `externalId` maps to the following ids of the external login methods.\\n- Appsemble OAuth2 login: `UserId`\\n- App OAuth2 login: `sub`\\n- App SAML login: `nameId`\\n\"},\"secret\":{\"type\":\"string\",\"description\":\"The secret that was used to get the external id.\"}}}}}},\"responses\":{\"200\":{\"description\":\"\",\"content\":{}}}}},\"/api/apps/{appId}/members/current\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"app\",\"member\",\"current-member\"],\"description\":\"\\n Get the app member information formatted as OpenID user info.\\n\\n See https://connect2id.com/products/server/docs/api/userinfo\\n \",\"operationId\":\"getCurrentAppMember\",\"security\":[{\"app\":[\"openid\"]}],\"responses\":{\"200\":{\"description\":\"OpenID compatible app member information\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"sub\":{\"type\":\"string\",\"description\":\"The subject (end-user) identifier. \"},\"name\":{\"type\":\"string\",\"description\":\"The full name of the end-user\"},\"picture\":{\"type\":\"string\",\"format\":\"url\",\"description\":\"The URL of the profile page for the end-user.\"},\"profile\":{\"type\":\"string\",\"format\":\"url\",\"description\":\"The URL to the app member profile.\"},\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The end-user\\u2019s preferred email address.\"},\"email_verified\":{\"type\":\"boolean\",\"description\":\"True if the end-user\\u2019s email address has been verified, else false.\"},\"properties\":{\"type\":\"object\",\"description\":\"Custom app member properties.\"}}}}}}}},\"patch\":{\"description\":\"Update the data of the currently logged in app member\",\"tags\":[\"app\",\"member\"],\"operationId\":\"patchCurrentAppMember\",\"security\":[{\"studio\":[]},{\"app\":[]}],\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"picture\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The member\\u2019s profile picture.\"},\"properties\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"description\":\"The member\\u2019s custom properties.\"},\"locale\":{\"type\":\"string\",\"description\":\"The preferred locale of the user.\"}}},\"encoding\":{\"picture\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"200\":{\"description\":\"The patched app member\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMember\"}}}}}}},\"/api/apps/{appId}/members\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/roles\"},{\"$ref\":\"#/components/parameters/selectedGroupId\"},{\"$ref\":\"#/components/parameters/$filter\"}],\"get\":{\"tags\":[\"common\",\"app\",\"member\"],\"description\":\"Fetch all members of an app.\",\"operationId\":\"queryAppMembers\",\"security\":[{\"studio\":[]},{\"app\":[\"openid\"]},{}],\"responses\":{\"200\":{\"description\":\"The list of app members.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppMemberInfo\"}}}}}}}},\"/api/apps/{appId}/messages/{language}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/language\"},{\"in\":\"query\",\"name\":\"merge\",\"description\":\"Whether the language\\u2019s messages should be merged with its base language.\",\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"override\",\"description\":\"Whether the app\\u2019s language overrides should be included and merged.\",\"schema\":{\"type\":\"string\",\"default\":\"true\"}}],\"delete\":{\"tags\":[\"main\",\"apps\",\"language\"],\"description\":\"Delete the app\\u2019s messages for this language.\",\"operationId\":\"deleteAppMessages\",\"responses\":{\"204\":{\"description\":\"The messages have successfully been deleted.\"}},\"security\":[{\"studio\":[]}]},\"get\":{\"tags\":[\"common\",\"apps\",\"language\"],\"description\":\"Get the app\\u2019s messages for this language.\",\"operationId\":\"getAppMessages\",\"responses\":{\"200\":{\"description\":\"The app messages for the selected language.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMessages\"}}}}}}},\"/api/apps/{appId}/messages\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"name\":\"merge\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}},{\"name\":\"includeMessages\",\"in\":\"query\",\"schema\":{\"type\":\"boolean\"}}],\"get\":{\"tags\":[\"common\",\"apps\",\"language\"],\"description\":\"Get a list of all languages with messages.\",\"operationId\":\"getAppLanguages\",\"responses\":{\"200\":{\"description\":\"The list of supported languages\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"$ref\":\"#/components/schemas/AppMessages\"}]}}}}}}},\"post\":{\"tags\":[\"main\",\"apps\",\"language\"],\"description\":\"Upload messages for the given language.\",\"operationId\":\"createAppMessages\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/AppMessages\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppMessages\"}}]}}}},\"responses\":{\"201\":{\"description\":\"The translation was created.\",\"content\":{\"application/json\":{\"schema\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/AppMessages\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppMessages\"}}]}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/quotas/email\":{\"get\":{\"tags\":[\"main\",\"app\",\"quota\",\"email\"],\"operationId\":\"getAppEmailQuota\",\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"security\":[{\"studio\":[]},{}],\"responses\":{\"200\":{\"description\":\"Email quota for an app\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"used\":{\"type\":\"number\",\"description\":\"Number of emails sent today\"},\"limit\":{\"type\":\"number\",\"description\":\"Maximum number of emails that can be sent today\"},\"reset\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when the quota resets\"}}}}}}}}},\"/api/apps/{appId}/ratings\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"rating\"],\"description\":\"Fetch all ratings of an app.\",\"operationId\":\"getAppRatings\",\"responses\":{\"200\":{\"description\":\"The list of apps ratings.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Rating\"}}}}}}},\"post\":{\"tags\":[\"main\",\"app\",\"rating\"],\"description\":\"Submit an app rating.\",\"operationId\":\"createAppRating\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"rating\"],\"properties\":{\"rating\":{\"$ref\":\"#/components/schemas/Rating/properties/rating\"},\"description\":{\"$ref\":\"#/components/schemas/Rating/properties/description\"}}}}}},\"responses\":{\"200\":{\"description\":\"The submitted app rating.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Asset/properties/id\"}}}}},\"security\":[{\"studio\":[]}]}},\"/api/apps/{appId}/readmes/{readmeId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/readmeId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"readme\"],\"description\":\"Get a readme of an app.\",\"operationId\":\"getAppReadme\",\"responses\":{\"200\":{\"description\":\"The app readme\"}}}},\"/api/apps/{appId}/reseed\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\"],\"operationId\":\"reseedDemoApp\",\"responses\":{\"200\":{\"description\":\"The app has successfully been reseeded.\"}},\"security\":[{\"studio\":[\"apps:write\"]}]}},\"/api/apps/{appId}/resources/{resourceType}/\\\\$count\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Get a count of all resources of this app.\",\"operationId\":\"countAppResources\",\"parameters\":[{\"$ref\":\"#/components/parameters/$filter\"},{\"$ref\":\"#/components/parameters/$own\"}],\"responses\":{\"200\":{\"description\":\"The count of all this app\\u2019s resources of this type.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"number\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:read\"]},{}]}},\"/api/apps/{appId}/resources/{resourceType}/{resourceId}/subscriptions\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/resourceId\"},{\"$ref\":\"#/components/parameters/endpoint\"}],\"get\":{\"tags\":[\"common\",\"app\",\"resource\",\"subscription\"],\"description\":\"Get the subscription status of a resource.\",\"operationId\":\"getAppResourceSubscription\",\"responses\":{\"200\":{\"description\":\"The subscription status of the resource that matches the given id.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"update\":{\"type\":\"boolean\"},\"delete\":{\"type\":\"boolean\"}}}}}}}}},\"/api/apps/{appId}/resources/{resourceType}/{resourceId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/resourceId\"},{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"resource\"],\"parameters\":[{\"$ref\":\"#/components/parameters/view\"},{\"name\":\"$own\",\"schema\":{\"type\":\"boolean\"},\"description\":\"If the resources created by the authenticated app member should be included\",\"in\":\"query\"}],\"description\":\"Get a single app resource.\",\"operationId\":\"getAppResourceById\",\"responses\":{\"200\":{\"description\":\"The resource that matches the given id.\",\"$ref\":\"#/components/responses/resource\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:read\"]},{}]},\"put\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Update an existing app resource.\",\"operationId\":\"updateAppResource\",\"requestBody\":{\"required\":true,\"$ref\":\"#/components/requestBodies/resource\"},\"responses\":{\"200\":{\"description\":\"The updated resource.\",\"$ref\":\"#/components/responses/resource\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:write\"]},{}]},\"patch\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Patch an existing app resource.\",\"operationId\":\"patchAppResource\",\"requestBody\":{\"required\":true,\"$ref\":\"#/components/requestBodies/resource\"},\"responses\":{\"200\":{\"description\":\"The patched resource.\",\"$ref\":\"#/components/responses/resource\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:write\"]},{}]},\"delete\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Delete an existing app resource.\",\"operationId\":\"deleteAppResource\",\"responses\":{\"204\":{\"description\":\"The app resource has been deleted successfully.\",\"$ref\":\"#/components/responses/resource\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:write\"]},{}]}},\"/api/apps/{appId}/resources/{resourceType}/subscriptions\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/endpoint\"}],\"get\":{\"tags\":[\"common\",\"app\",\"resource\",\"subscription\"],\"description\":\"Get the current subscription status of this resource.\",\"operationId\":\"getAppResourceTypeSubscription\",\"responses\":{\"200\":{\"description\":\"The subscription status for this resource.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ResourceSubscription\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"openid\"]},{}]}},\"/api/apps/{appId}/resources/{resourceType}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Get all resources of this app.\",\"operationId\":\"queryAppResources\",\"parameters\":[{\"$ref\":\"#/components/parameters/view\"},{\"$ref\":\"#/components/parameters/$filter\"},{\"$ref\":\"#/components/parameters/$orderby\"},{\"$ref\":\"#/components/parameters/$select\"},{\"$ref\":\"#/components/parameters/$skip\"},{\"$ref\":\"#/components/parameters/$top\"},{\"$ref\":\"#/components/parameters/$own\"},{\"$ref\":\"#/components/parameters/delimiter\"}],\"responses\":{\"200\":{\"description\":\"The list of all this app\\u2019s resources of this type.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}}},\"text/csv\":{\"schema\":{\"type\":\"string\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:read\"]},{}]},\"post\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Create a new resource for this app.\",\"operationId\":\"createAppResource\",\"requestBody\":{\"required\":true,\"description\":\"The resource to create\",\"content\":{\"application/json\":{\"schema\":{\"anyOf\":[{\"$ref\":\"#/components/schemas/Resource\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}}]}},\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"required\":[\"resource\"],\"description\":\"A `multipart/form-data` representation of a resource.\",\"additionalProperties\":false,\"properties\":{\"resource\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}},\"assets\":{\"type\":\"array\",\"description\":\"A list of assets that should be linked to the resource.\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}}}}},\"text/csv\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}}}}},\"responses\":{\"201\":{\"description\":\"The resource that was created.\",\"$ref\":\"#/components/responses/resource\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:write\"]},{}]},\"put\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Update existing app resources.\",\"operationId\":\"updateAppResources\",\"requestBody\":{\"required\":true,\"description\":\"The resources to update\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}}},\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"required\":[\"resource\"],\"description\":\"A `multipart/form-data` representation of a resource.\",\"additionalProperties\":false,\"properties\":{\"resource\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Resource\"}},\"assets\":{\"type\":\"array\",\"description\":\"A list of assets that should be linked to the resources.\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}}}}},\"text/csv\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"The updated resources.\",\"$ref\":\"#/components/responses/resource\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:write\"]},{}]},\"delete\":{\"tags\":[\"common\",\"app\",\"resource\"],\"description\":\"Delete multiple app resources.\",\"operationId\":\"deleteAppResources\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"description\":\"An array of resource IDs to remove.\",\"items\":{\"$ref\":\"#/components/schemas/Resource/properties/id\"}}}}},\"responses\":{\"204\":{\"description\":\"The app resources have been deleted successfully.\"}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]},{\"cli\":[\"resources:write\"]},{}]}},\"/api/apps/{appId}/resources/{resourceType}/{resourceId}/versions\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/resourceId\"},{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"resource\",\"version\"],\"description\":\"Get the known history of a resource\",\"operationId\":\"getAppResourceVersions\",\"responses\":{\"200\":{\"description\":\"The resource that matches the given id.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/responses/resource\"}}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"resources:manage\"]}]}},\"/api/apps/{appId}/resources/{resourceType}/{resourceId}/positions\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/resourceType\"},{\"$ref\":\"#/components/parameters/resourceId\"},{\"$ref\":\"#/components/parameters/selectedGroupId\"},{\"$ref\":\"#/components/parameters/$filter\"}],\"put\":{\"tags\":[\"app\",\"resource\",\"positioning\",\"custom-sort\"],\"description\":\"Update the current position of the resource in the order.\",\"operationId\":\"updateAppResourcePosition\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"description\":\"\",\"required\":[\"prevResourcePosition\",\"nextResourcePosition\"],\"properties\":{\"prevResourcePosition\":{\"oneOf\":[{\"type\":\"number\",\"minimum\":0},{\"enum\":[null]}]},\"nextResourcePosition\":{\"oneOf\":[{\"type\":\"number\",\"minimum\":0},{\"enum\":[null]}]}}}}}},\"responses\":{\"200\":{\"description\":\"The subscription status of the resource that matches the given id.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"number\",\"description\":\"The updated position\"}}}}},\"security\":[{\"app\":[\"resources:manage\"]},{}]}},\"/api/apps/{appId}/resources\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"delete\":{\"tags\":[\"main\",\"app\",\"resource\"],\"description\":\"Delete all app seed resources.\",\"operationId\":\"deleteAppSeedResources\",\"responses\":{\"204\":{\"description\":\"The app resources have been deleted successfully.\"}},\"security\":[{\"cli\":[\"resources:write\"]},{}]}},\"/api/apps/{appId}/saml/{appSamlSecretId}/acs\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appSamlSecretId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"saml\"],\"operationId\":\"assertAppSamlConsumerService\",\"security\":[{\"studio\":[]},{}],\"requestBody\":{\"content\":{\"application/x-www-form-urlencoded\":{\"schema\":{\"type\":\"object\",\"properties\":{\"RelayState\":{\"type\":\"string\"},\"SAMLResponse\":{\"type\":\"string\"}}}}}},\"responses\":{\"302\":{\"description\":\"A list of the SAML secrets for the app.\",\"content\":{\"application/json\":{\"schema\":{}}}}}}},\"/api/apps/{appId}/saml/{appSamlSecretId}/authn\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appSamlSecretId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"saml\"],\"operationId\":\"createAppSamlAuthnRequest\",\"security\":[{\"studio\":[]},{}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"redirectUri\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\"},\"state\":{\"type\":\"string\"},\"timezone\":{\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/La_Rioja\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Ciudad_Juarez\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Fort_Nelson\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Monticello\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Ojinaga\",\"America/Panama\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Colombo\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Hebron\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Ulyanovsk\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\"]}}}}}},\"responses\":{\"201\":{\"description\":\"A list of the SAML secrets for the app.\",\"content\":{\"application/json\":{\"schema\":{}}}}}}},\"/api/apps/{appId}/saml/{appSamlSecretId}/metadata.xml\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appSamlSecretId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"saml\"],\"operationId\":\"getAppSamlEntityId\",\"responses\":{\"200\":{\"description\":\"Get the SAML entity ID metadata\",\"content\":{\"application/xml\":{\"schema\":{}}}}}}},\"/api/apps/{appId}/scim/resource-types/{resourceTypeId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"name\":\"resourceTypeId\",\"in\":\"path\",\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimResourceType\",\"responses\":{\"200\":{\"description\":\"SCIM user\",\"content\":{\"application/scim+json\":{\"schema\":{}}}}}}},\"/api/apps/{appId}/scim/resource-types\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimResourceTypes\",\"responses\":{\"200\":{\"description\":\"SCIM user\",\"content\":{\"application/scim+json\":{\"schema\":{}}}}}}},\"/api/apps/{appId}/scim/schemas/{schemaId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"name\":\"schemaId\",\"in\":\"path\",\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimSchema\",\"responses\":{\"200\":{\"description\":\"The SCIM Schema\",\"content\":{\"application/scim+json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimUser\"}}}}}}},\"/api/apps/{appId}/scim/schemas\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimSchemas\",\"responses\":{\"200\":{\"description\":\"The SCIM Schema\",\"content\":{\"application/scim+json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimUser\"}}}}}}},\"/api/apps/{appId}/scim/service-provider-config\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimServiceProviderConfig\",\"responses\":{\"200\":{\"description\":\"SCIM user\",\"content\":{\"application/scim+json\":{\"schema\":{}}}}}}},\"/api/apps/{appId}/scim/users/{userId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"name\":\"userId\",\"in\":\"path\",\"description\":\"The ID of the member to perform the operation on\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/User/properties/id\"}}],\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimUser\",\"responses\":{\"200\":{\"description\":\"SCIM user\",\"content\":{\"application/scim+json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimUser\"}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"deleteAppScimUser\",\"responses\":{\"204\":{\"description\":\"SCIM user\"}}},\"put\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"updateAppScimUser\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}},\"application/scim+json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}}}},\"responses\":{\"200\":{\"description\":\"SCIM user\"}}},\"patch\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"patchAppScimUser\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}},\"application/scim+json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}}}},\"responses\":{\"200\":{\"description\":\"SCIM user\"}}}},\"/api/apps/{appId}/scim/users\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"createAppScimUser\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}},\"application/scim+json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}}}},\"responses\":{\"201\":{\"description\":\"Integrated SCIM user schema\",\"content\":{\"application/scim+json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimUser\"}}}}}},\"get\":{\"tags\":[\"main\",\"app\",\"scim\"],\"security\":[{\"scim\":[]}],\"operationId\":\"getAppScimUsers\",\"parameters\":[{\"name\":\"count\",\"in\":\"query\",\"schema\":{\"type\":\"number\"}},{\"name\":\"startIndex\",\"in\":\"query\",\"schema\":{\"type\":\"number\"}}],\"responses\":{\"200\":{\"description\":\"SCIM user\",\"content\":{\"application/scim+json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimUser\"}}}}}}},\"/api/apps/{appId}/screenshots/{screenshotId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/screenshotId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"screenshot\"],\"description\":\"Get a screenshot of an app.\",\"operationId\":\"getAppScreenshot\",\"responses\":{\"200\":{\"description\":\"The app screenshot\"}}},\"delete\":{\"tags\":[\"main\",\"app\",\"screenshot\"],\"description\":\"Delete an existing screenshot.\",\"operationId\":\"deleteAppScreenshot\",\"responses\":{\"200\":{\"description\":\"The screenshot has been successfully deleted.\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/screenshots\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"screenshot\"],\"description\":\"Add one or multiple screenshots of an app.\",\"operationId\":\"createAppScreenshot\",\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"properties\":{\"screenshots\":{\"type\":\"array\",\"description\":\"Screenshots to showcase in the store\",\"minItems\":1,\"items\":{\"type\":\"string\",\"format\":\"binary\"}},\"language\":{\"type\":\"string\",\"description\":\"The language for which the screenshots will be uploaded\"}}},\"encoding\":{\"screenshots\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"201\":{\"description\":\"The screenshots have been successfully created.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"integer\",\"description\":\"The ID of the newly created screenshot.\"}}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}/verify\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appOAuth2SecretId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"verifyAppOAuth2SecretCode\",\"security\":[{\"studio\":[]},{}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"code\",\"scope\",\"redirectUri\",\"timezone\"],\"properties\":{\"code\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\"},\"redirectUri\":{\"type\":\"string\"},\"timezone\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"\\n Get a partial app OAuth2 secret\\n\\n Only public facing values are output on this endpoint.\\n \",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\"}}}}}}}}},\"/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appOAuth2SecretId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"getAppOAuth2Secret\",\"responses\":{\"200\":{\"description\":\"\\n Get a partial app OAuth2 secret\\n\\n Only public facing values are output on this endpoint.\\n \",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret\"}}}}}}},\"put\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"updateAppOAuth2Secret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret\"}}}},\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The updated OAuth2 secret.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret\"}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"deleteAppOAuth2Secret\",\"security\":[{\"studio\":[]}],\"responses\":{\"204\":{\"description\":\"The deleted OAuth2 secret.\"}}}},\"/api/apps/{appId}/secrets/oauth2\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"createAppOAuth2Secret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret\"}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"201\":{\"description\":\"A list of the OAuth2 secrets for the app.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret\"}}}}}},\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"getAppOAuth2Secrets\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"A list of the OAuth2 secrets for the app.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppOAuth2Secret\"}}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"oauth2\"],\"operationId\":\"deleteAppOAuth2Secrets\",\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"204\":{\"description\":\"The deleted app OAuth2 secrets.\"}}}},\"/api/apps/{appId}/secrets/saml/{appSamlSecretId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appSamlSecretId\"}],\"put\":{\"tags\":[\"main\",\"app\",\"secret\",\"saml\"],\"operationId\":\"updateAppSamlSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{}}}},\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The updated SAML secret.\",\"content\":{\"application/json\":{\"schema\":{}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"saml\"],\"operationId\":\"deleteAppSamlSecret\",\"security\":[{\"studio\":[]}],\"responses\":{\"204\":{\"description\":\"The deleted SAML secret.\"}}}},\"/api/apps/{appId}/secrets/saml\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"secret\",\"saml\"],\"operationId\":\"createAppSamlSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"201\":{\"description\":\"A list of the SAML secrets for the app.\",\"content\":{\"application/json\":{\"schema\":{}}}}}},\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"saml\"],\"operationId\":\"getAppSamlSecrets\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"A list of the SAML secrets for the app.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{}}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"saml\"],\"operationId\":\"deleteAppSamlSecrets\",\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"204\":{\"description\":\"The deleted app saml secrets.\"}}}},\"/api/apps/{appId}/secrets/scim\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"scim\"],\"operationId\":\"getAppScimSecret\",\"description\":\"Get app SCIM secret configuration\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The app SCIM configuration\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimSecret\"}}}}}},\"patch\":{\"tags\":[\"main\",\"app\",\"secret\",\"scim\"],\"operationId\":\"updateAppScimSecret\",\"description\":\"Update app SCIM secret configuration\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimSecret\"}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"200\":{\"description\":\"The app SCIM configuration\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ScimSecret\"}}}}}}},\"/api/apps/{appId}/secrets/service/{serviceSecretId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/serviceSecretId\"}],\"put\":{\"tags\":[\"main\",\"app\",\"secret\",\"service\"],\"operationId\":\"updateAppServiceSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppServiceSecret\"}}}},\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The updated app service secret.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppServiceSecret\"}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"service\"],\"operationId\":\"deleteAppServiceSecret\",\"security\":[{\"studio\":[]}],\"responses\":{\"204\":{\"description\":\"The deleted app service secret.\"}}}},\"/api/apps/{appId}/secrets/service\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"secret\",\"service\"],\"operationId\":\"createAppServiceSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppServiceSecret\"}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"201\":{\"description\":\"The created app service secret.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppServiceSecret\"}}}}}},\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"service\"],\"operationId\":\"getAppServiceSecrets\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The list of app service secrets.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppServiceSecret\"}}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"service\"],\"operationId\":\"deleteAppServiceSecrets\",\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"204\":{\"description\":\"The deleted app service secrets.\"}}}},\"/api/apps/{appId}/secrets/ssl\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"ssl\"],\"description\":\"Get the SSL certificate of an app\",\"operationId\":\"getAppSslSecret\",\"responses\":{\"200\":{\"description\":\"The SSL secret of the app.\",\"$ref\":\"#/components/schemas/SSLSecret\"}},\"security\":[{\"studio\":[]}]},\"put\":{\"tags\":[\"main\",\"app\",\"secret\",\"ssl\"],\"description\":\"Update the app\\u2019s SSL secret\",\"operationId\":\"updateAppSslSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SSLSecret\"}}}},\"responses\":{\"200\":{\"description\":\"The updated SSL secret.\",\"$ref\":\"#/components/schemas/SSLSecret\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/secrets/webhook/{webhookSecretId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/webhookSecretId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"webhook\"],\"operationId\":\"getAppWebhookSecret\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The requested webhook secret.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"secret\":{\"type\":\"string\"}}}}}}}},\"put\":{\"tags\":[\"main\",\"app\",\"secret\",\"webhook\"],\"operationId\":\"updateAppWebhookSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppWebhookSecret\"}}}},\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The updated app webhook secret.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppWebhookSecret\"}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"secret\",\"webhook\"],\"operationId\":\"deleteAppWebhookSecret\",\"security\":[{\"studio\":[]}],\"responses\":{\"204\":{\"description\":\"The deleted app webhook secret.\"}}}},\"/api/apps/{appId}/secrets/webhook\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"main\",\"app\",\"secret\",\"webhook\"],\"operationId\":\"createAppWebhookSecret\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppWebhookSecret\"}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"201\":{\"description\":\"The created app webhook secret.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppWebhookSecret\"}}}}}},\"get\":{\"tags\":[\"main\",\"app\",\"secret\",\"webhook\"],\"operationId\":\"getAppWebhookSecrets\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The list of app webhook secrets.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppWebhookSecret\"}}}}}}}},\"/api/apps/{appId}/snapshots/{snapshotId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"name\":\"snapshotId\",\"in\":\"path\",\"description\":\"The ID of the snapshot\",\"required\":true,\"schema\":{\"type\":\"number\",\"description\":\"The ID of the snapshot.\"}}],\"get\":{\"tags\":[\"main\",\"app\",\"snapshot\"],\"description\":\"Get a single snapshot made of the app.\",\"operationId\":\"getAppSnapshot\",\"responses\":{\"200\":{\"description\":\"The snapshot\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"integer\",\"description\":\"The ID of the snapshot.\"},\"yaml\":{\"type\":\"string\",\"description\":\"The app definition.\"},\"$created\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The creation date of the snapshot.\"},\"$author\":{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/components/schemas/User/properties/id\"},\"name\":{\"$ref\":\"#/components/schemas/User/properties/name\"}}}}}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/snapshots\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"snapshot\"],\"description\":\"Get a list of snapshots made of the app.\",\"operationId\":\"getAppSnapshots\",\"responses\":{\"200\":{\"description\":\"The available snapshots\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\",\"description\":\"The ID of the snapshot.\"},\"$created\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The creation date of the snapshot.\"},\"$author\":{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/components/schemas/User/properties/id\"},\"name\":{\"$ref\":\"#/components/schemas/User/properties/name\"}}}}}}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/style/block/@{organizationId}/{blockId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"}],\"get\":{\"tags\":[\"common\",\"app\"],\"description\":\"Get the app style for a block.\",\"operationId\":\"getAppBlockStyle\",\"responses\":{\"200\":{\"description\":\"The stylesheet associated with this block for this app.\",\"content\":{\"text/css\":{}}}}},\"post\":{\"tags\":[\"main\",\"app\",\"block\"],\"description\":\"Upload a block stylesheet for this app.\",\"operationId\":\"setAppBlockStyle\",\"requestBody\":{\"description\":\"The new app block stylesheet.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"style\"],\"properties\":{\"style\":{\"type\":\"string\"},\"force\":{\"type\":\"boolean\",\"writeOnly\":true,\"description\":\"If this is true, the app lock is ignored.\"}}}}}},\"responses\":{\"204\":{\"description\":\"The block style has been updated successfully.\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/apps/{appId}/style/core\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\"],\"description\":\"Get the core style for this app.\",\"operationId\":\"getAppCoreStyle\",\"responses\":{\"200\":{\"description\":\"The core stylesheet associated with this app.\",\"content\":{\"text/css\":{}}}}}},\"/api/apps/{appId}/style/shared\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\"],\"description\":\"Get the shared style for this app.\",\"operationId\":\"getAppSharedStyle\",\"responses\":{\"200\":{\"description\":\"The shared stylesheet associated with this app.\",\"content\":{\"text/css\":{}}}}}},\"/api/apps/{appId}/subscriptions\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\",\"subscription\"],\"parameters\":[{\"$ref\":\"#/components/parameters/endpoint\"}],\"description\":\"Fetch all subscription settings of an app.\",\"operationId\":\"getAppSubscription\",\"responses\":{\"200\":{\"description\":\"The subscription settings.\",\"$ref\":\"#/components/responses/subscriptions\"}}},\"post\":{\"tags\":[\"main\",\"app\",\"subscription\"],\"description\":\"Subscribe to an app\\u2019s push notifications\",\"operationId\":\"createAppSubscription\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"description\":\"A serialized PushSubscription object\",\"required\":[\"endpoint\",\"keys\"],\"properties\":{\"endpoint\":{\"type\":\"string\"},\"keys\":{\"type\":\"object\",\"required\":[\"p256dh\",\"auth\"],\"properties\":{\"p256dh\":{\"type\":\"string\"},\"auth\":{\"type\":\"string\"}}}}}}}},\"responses\":{\"204\":{\"description\":\"The subscription has successfully been registered.\"}},\"security\":[{\"studio\":[]},{\"app\":[\"openid\"]},{}]},\"patch\":{\"tags\":[\"main\",\"app\",\"subscription\"],\"description\":\"Subscribe to an app\\u2019s push notifications. If value isn\\u2019t set it will toggle between subscribing and unsubscribing.\",\"operationId\":\"updateAppSubscription\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"endpoint\",\"resource\",\"action\"],\"properties\":{\"endpoint\":{\"type\":\"string\",\"format\":\"uri\"},\"resource\":{\"type\":\"string\"},\"action\":{\"type\":\"string\",\"enum\":[\"create\",\"update\",\"delete\"]},\"value\":{\"type\":\"boolean\"},\"resourceId\":{\"type\":\"number\"}}}}}},\"responses\":{\"204\":{\"description\":\"The subscription has successfully been updated.\"}},\"security\":[{\"studio\":[]},{\"app\":[\"openid\"]},{}]}},\"/api/apps/{appId}/variables/{appVariableId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/appVariableId\"}],\"put\":{\"tags\":[\"main\",\"app\",\"variable\"],\"operationId\":\"updateAppVariable\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppVariable\"}}}},\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"The updated app variable.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppVariable\"}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"variable\"],\"operationId\":\"deleteAppVariable\",\"security\":[{\"studio\":[]}],\"responses\":{\"204\":{\"description\":\"The deleted app variable.\"}}}},\"/api/apps/{appId}/variables\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"common\",\"app\",\"variable\"],\"operationId\":\"getAppVariables\",\"responses\":{\"200\":{\"description\":\"The list of app variables.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppVariable\"}}}}}}},\"post\":{\"tags\":[\"main\",\"app\",\"variable\"],\"operationId\":\"createAppVariable\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppVariable\"}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"201\":{\"description\":\"The created app variable.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppVariable\"}}}}}},\"delete\":{\"tags\":[\"main\",\"app\",\"variable\"],\"operationId\":\"deleteAppVariables\",\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}],\"responses\":{\"204\":{\"description\":\"The deleted app variables.\"}}}},\"/api/apps/{appId}/webhooks/{webhookName}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"},{\"$ref\":\"#/components/parameters/webhookName\"}],\"post\":{\"tags\":[\"main\",\"app\",\"webhook\"],\"description\":\"Call a webhook defined in the app\",\"operationId\":\"callAppWebhook\",\"responses\":{\"200\":{\"description\":\"The webhook was called successfully.\"}},\"requestBody\":{\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}},\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":true}}}},\"security\":[{\"webhook\":[]}]}},\"/api/apps/{appId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"tags\":[\"main\",\"app\"],\"parameters\":[{\"name\":\"language\",\"schema\":{\"type\":\"string\"},\"description\":\"The language to include the translations of, if available\",\"in\":\"query\"}],\"description\":\"Get a single app\",\"operationId\":\"getAppById\",\"responses\":{\"200\":{\"description\":\"The app that matches the given id.\",\"$ref\":\"#/components/responses/app\"}},\"security\":[{\"studio\":[]},{}]},\"patch\":{\"tags\":[\"main\",\"app\"],\"description\":\"Update parts of an existing app\",\"operationId\":\"patchApp\",\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"properties\":{\"domain\":{\"$ref\":\"#/components/schemas/App/properties/domain\"},\"path\":{\"$ref\":\"#/components/schemas/App/properties/path\"},\"visibility\":{\"$ref\":\"#/components/schemas/App/properties/visibility\"},\"template\":{\"$ref\":\"#/components/schemas/App/properties/template\"},\"demoMode\":{\"$ref\":\"#/components/schemas/App/properties/demoMode\"},\"force\":{\"type\":\"boolean\",\"description\":\"Whether the locked property should be ignored.\"},\"yaml\":{\"type\":\"string\",\"description\":\"The original YAML definition used to define the app.\"},\"icon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The app icon.\"},\"maskableIcon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The app icon.\"},\"iconBackground\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\"},\"coreStyle\":{\"type\":\"string\",\"description\":\"The custom style to apply to the core app.\"},\"sharedStyle\":{\"type\":\"string\",\"description\":\"The custom style to apply to all parts of app.\"},\"screenshots\":{\"type\":\"array\",\"description\":\"Screenshots to showcase in the store\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}},\"readmes\":{\"type\":\"array\",\"description\":\"Readmes to showcase in the store\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}},\"controllerCode\":{\"type\":\"string\",\"description\":\"Custom app logic as a JavaScript string\"},\"controllerImplementations\":{\"type\":\"string\",\"description\":\"Appsemble SDK interfaces implementations\"},\"showAppsembleLogin\":{\"type\":\"boolean\",\"description\":\"Whether the Appsemble login method should be shown.\"},\"showAppsembleOAuth2Login\":{\"type\":\"boolean\",\"description\":\"Whether the Appsemble OAuth2 login method should be shown.\"},\"enableSelfRegistration\":{\"type\":\"boolean\",\"description\":\"Whether new users should be able to register themselves.\"},\"displayAppMemberName\":{\"$ref\":\"#/components/schemas/App/properties/displayAppMemberName\"},\"displayInstallationPrompt\":{\"$ref\":\"#/components/schemas/App/properties/displayInstallationPrompt\"},\"emailName\":{\"type\":\"string\",\"description\":\"The name used for emails.\"},\"emailHost\":{\"type\":\"string\",\"description\":\"The hostname of the SMTP server.\"},\"emailPassword\":{\"type\":\"string\",\"description\":\"The password to use for SMTP authentication. This gets encrypted when stored.\"},\"emailUser\":{\"type\":\"string\",\"description\":\"The username used to authenticate against the SMTP server.\"},\"emailPort\":{\"type\":\"string\",\"description\":\"The port used for the SMTP server.\"},\"emailSecure\":{\"type\":\"boolean\",\"description\":\"Whether TLS is being used.\"},\"containers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ContainerDefinition\"}}}},\"encoding\":{\"coreStyle\":{\"contentType\":\"text/css\"},\"sharedStyle\":{\"contentType\":\"text/css\"},\"icon\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"200\":{\"description\":\"The updated app.\",\"$ref\":\"#/components/responses/app\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]},\"delete\":{\"tags\":[\"main\",\"app\"],\"description\":\"Delete an existing app\",\"operationId\":\"deleteApp\",\"responses\":{\"204\":{\"description\":\"The app was successfully deleted.\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:delete\"]}]}},\"/api/apps/{appId}/auth/email/login\":{\"post\":{\"tags\":[\"app\",\"auth\",\"email\"],\"description\":\"Login using the Appsemble studio.\",\"operationId\":\"loginAppMemberWithEmail\",\"responses\":{\"200\":{\"description\":\"Logged in successfully.\"}},\"security\":[{\"basic\":[]}]}},\"/api/apps/{appId}/auth/email/register\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\",\"auth\",\"email\"],\"description\":\"Register a new app account using an email address and a password.\",\"operationId\":\"registerAppMemberWithEmail\",\"requestBody\":{\"description\":\"The user account to register.\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\",\"password\",\"timezone\"],\"properties\":{\"name\":{\"type\":\"string\"},\"email\":{\"type\":\"string\",\"format\":\"email\"},\"password\":{\"type\":\"string\",\"minLength\":8},\"picture\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The account\\u2019s profile picture.\"},\"properties\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"description\":\"The member\\u2019s custom properties.\"},\"timezone\":{\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/La_Rioja\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Ciudad_Juarez\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Fort_Nelson\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Monticello\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Ojinaga\",\"America/Panama\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Colombo\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Hebron\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Ulyanovsk\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\"]}}}}}},\"responses\":{\"201\":{\"description\":\"The account that was created.\"}}}},\"/api/apps/{appId}/auth/email/resend-verification\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\",\"auth\",\"email\"],\"description\":\"Resend the verification code for a registered email.\",\"operationId\":\"resendAppMemberEmailVerification\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The verification email was sent if an account was found in the database.\"}},\"security\":[{\"app\":[\"email\"]}]}},\"/api/apps/{appId}/auth/email/request-password-reset\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\",\"auth\",\"email\"],\"description\":\"Request a reset token for resetting passwords.\",\"operationId\":\"requestAppMemberPasswordReset\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The request has been received and an email was sent if it exists.\"}}}},\"/api/apps/{appId}/auth/email/reset-password\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\",\"auth\",\"email\"],\"description\":\"Reset a password using a password reset token.\",\"operationId\":\"resetAppMemberPassword\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"password\",\"token\"],\"properties\":{\"password\":{\"type\":\"string\",\"minLength\":8},\"token\":{\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The password has been reset.\"}}}},\"/api/apps/{appId}/auth/email/verify\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"post\":{\"tags\":[\"app\",\"auth\",\"email\"],\"description\":\"Verify the email address of a registered user.\",\"operationId\":\"verifyAppMemberEmail\",\"requestBody\":{\"description\":\"The user account to register.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"token\"],\"properties\":{\"token\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"The account was successfully verified.\"}}}},\"/api/apps\":{\"post\":{\"tags\":[\"main\",\"app\"],\"description\":\"Create a new app\",\"operationId\":\"createApp\",\"parameters\":[{\"in\":\"query\",\"name\":\"dryRun\",\"description\":\"Validate whether an app could be created without actually creating one. Must be set to \\u2018true\\u2019.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"required\":[\"OrganizationId\",\"yaml\"],\"properties\":{\"domain\":{\"$ref\":\"#/components/schemas/App/properties/domain\"},\"path\":{\"$ref\":\"#/components/schemas/App/properties/path\"},\"visibility\":{\"$ref\":\"#/components/schemas/App/properties/visibility\"},\"template\":{\"$ref\":\"#/components/schemas/App/properties/template\"},\"demoMode\":{\"$ref\":\"#/components/schemas/App/properties/demoMode\"},\"yaml\":{\"type\":\"string\",\"description\":\"The original YAML definition used to define the app.\"},\"OrganizationId\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"},\"icon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The app icon.\"},\"maskableIcon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The app icon.\"},\"iconBackground\":{\"type\":\"string\",\"pattern\":\"^#[\\\\dA-Fa-f]{6}$\",\"description\":\"The background color to use for the maskable icon.\"},\"coreStyle\":{\"type\":\"string\",\"description\":\"The custom style to apply to the core app.\"},\"sharedStyle\":{\"type\":\"string\",\"description\":\"The custom style to apply to all parts of app.\"},\"screenshots\":{\"type\":\"array\",\"description\":\"Screenshots to showcase in the store\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}},\"readmes\":{\"type\":\"array\",\"description\":\"Readmes to showcase in the store\",\"items\":{\"type\":\"string\",\"format\":\"binary\"}},\"controllerCode\":{\"type\":\"string\",\"description\":\"Custom app logic as a JavaScript string\"},\"controllerImplementations\":{\"type\":\"string\",\"description\":\"Appsemble SDK interfaces implementations\"}}},\"encoding\":{\"coreStyle\":{\"contentType\":\"text/css\"},\"sharedStyle\":{\"contentType\":\"text/css\"},\"icon\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"},\"screenshots\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"201\":{\"description\":\"The app that was created.\",\"$ref\":\"#/components/responses/app\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]},\"get\":{\"tags\":[\"main\",\"app\"],\"parameters\":[{\"name\":\"language\",\"schema\":{\"type\":\"string\"},\"description\":\"The language to include the translations of, if available\",\"in\":\"query\"}],\"description\":\"Get all publically available apps.\",\"operationId\":\"queryApps\",\"responses\":{\"200\":{\"description\":\"The list of all public apps.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/App\"}}}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/app-templates\":{\"get\":{\"tags\":[\"main\",\"app\",\"template\"],\"description\":\"Fetch a list of all available templates.\",\"operationId\":\"getAppTemplates\",\"responses\":{\"200\":{\"description\":\"The list of all available templates.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"template\":{\"type\":\"string\",\"description\":\"The name of the template.\"},\"description\":{\"type\":\"string\",\"description\":\"The description of the template.\"},\"resources\":{\"type\":\"boolean\",\"description\":\"Whether this template supports pre-made resources\"}}}}}}}},\"security\":[{\"studio\":[]}]},\"post\":{\"tags\":[\"main\",\"app\",\"template\"],\"description\":\"Register a new app using a template.\",\"operationId\":\"createAppFromTemplate\",\"requestBody\":{\"description\":\"The template to use for app creation.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"templateId\",\"organizationId\"],\"properties\":{\"templateId\":{\"type\":\"number\",\"description\":\"The ID of the template.\"},\"name\":{\"$ref\":\"#/components/schemas/AppDefinition/properties/name\"},\"description\":{\"$ref\":\"#/components/schemas/AppDefinition/properties/description\"},\"organizationId\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"},\"resources\":{\"type\":\"boolean\",\"description\":\"Include example resources.\"},\"assets\":{\"type\":\"boolean\",\"description\":\"Include example assets.\"},\"variables\":{\"type\":\"boolean\",\"description\":\"Include example variables.\"},\"secrets\":{\"type\":\"boolean\",\"description\":\"Include example secrets.\"},\"visibility\":{\"$ref\":\"#/components/schemas/App/properties/visibility\"}}}}}},\"responses\":{\"201\":{\"$ref\":\"#/components/responses/app\"}},\"security\":[{\"studio\":[]}]}},\"/api/auth/email/login\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Login using the Appsemble studio.\",\"operationId\":\"loginUserWithEmail\",\"responses\":{\"200\":{\"description\":\"Logged in successfully.\"}},\"security\":[{\"basic\":[]}]}},\"/api/auth/email/register\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Register a new studio account using an email address and a password.\",\"operationId\":\"registerUserWithEmail\",\"requestBody\":{\"description\":\"The user account to register.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\",\"password\"],\"properties\":{\"name\":{\"type\":\"string\"},\"email\":{\"type\":\"string\",\"format\":\"email\"},\"password\":{\"type\":\"string\",\"minLength\":8},\"timezone\":{\"enum\":[\"Africa/Abidjan\",\"Africa/Accra\",\"Africa/Addis_Ababa\",\"Africa/Algiers\",\"Africa/Asmera\",\"Africa/Bamako\",\"Africa/Bangui\",\"Africa/Banjul\",\"Africa/Bissau\",\"Africa/Blantyre\",\"Africa/Brazzaville\",\"Africa/Bujumbura\",\"Africa/Cairo\",\"Africa/Casablanca\",\"Africa/Ceuta\",\"Africa/Conakry\",\"Africa/Dakar\",\"Africa/Dar_es_Salaam\",\"Africa/Djibouti\",\"Africa/Douala\",\"Africa/El_Aaiun\",\"Africa/Freetown\",\"Africa/Gaborone\",\"Africa/Harare\",\"Africa/Johannesburg\",\"Africa/Juba\",\"Africa/Kampala\",\"Africa/Khartoum\",\"Africa/Kigali\",\"Africa/Kinshasa\",\"Africa/Lagos\",\"Africa/Libreville\",\"Africa/Lome\",\"Africa/Luanda\",\"Africa/Lubumbashi\",\"Africa/Lusaka\",\"Africa/Malabo\",\"Africa/Maputo\",\"Africa/Maseru\",\"Africa/Mbabane\",\"Africa/Mogadishu\",\"Africa/Monrovia\",\"Africa/Nairobi\",\"Africa/Ndjamena\",\"Africa/Niamey\",\"Africa/Nouakchott\",\"Africa/Ouagadougou\",\"Africa/Porto-Novo\",\"Africa/Sao_Tome\",\"Africa/Tripoli\",\"Africa/Tunis\",\"Africa/Windhoek\",\"America/Adak\",\"America/Anchorage\",\"America/Anguilla\",\"America/Antigua\",\"America/Araguaina\",\"America/Argentina/La_Rioja\",\"America/Argentina/Rio_Gallegos\",\"America/Argentina/Salta\",\"America/Argentina/San_Juan\",\"America/Argentina/San_Luis\",\"America/Argentina/Tucuman\",\"America/Argentina/Ushuaia\",\"America/Aruba\",\"America/Asuncion\",\"America/Bahia\",\"America/Bahia_Banderas\",\"America/Barbados\",\"America/Belem\",\"America/Belize\",\"America/Blanc-Sablon\",\"America/Boa_Vista\",\"America/Bogota\",\"America/Boise\",\"America/Buenos_Aires\",\"America/Cambridge_Bay\",\"America/Campo_Grande\",\"America/Cancun\",\"America/Caracas\",\"America/Catamarca\",\"America/Cayenne\",\"America/Cayman\",\"America/Chicago\",\"America/Chihuahua\",\"America/Ciudad_Juarez\",\"America/Coral_Harbour\",\"America/Cordoba\",\"America/Costa_Rica\",\"America/Creston\",\"America/Cuiaba\",\"America/Curacao\",\"America/Danmarkshavn\",\"America/Dawson\",\"America/Dawson_Creek\",\"America/Denver\",\"America/Detroit\",\"America/Dominica\",\"America/Edmonton\",\"America/Eirunepe\",\"America/El_Salvador\",\"America/Fort_Nelson\",\"America/Fortaleza\",\"America/Glace_Bay\",\"America/Godthab\",\"America/Goose_Bay\",\"America/Grand_Turk\",\"America/Grenada\",\"America/Guadeloupe\",\"America/Guatemala\",\"America/Guayaquil\",\"America/Guyana\",\"America/Halifax\",\"America/Havana\",\"America/Hermosillo\",\"America/Indiana/Knox\",\"America/Indiana/Marengo\",\"America/Indiana/Petersburg\",\"America/Indiana/Tell_City\",\"America/Indiana/Vevay\",\"America/Indiana/Vincennes\",\"America/Indiana/Winamac\",\"America/Indianapolis\",\"America/Inuvik\",\"America/Iqaluit\",\"America/Jamaica\",\"America/Jujuy\",\"America/Juneau\",\"America/Kentucky/Monticello\",\"America/Kralendijk\",\"America/La_Paz\",\"America/Lima\",\"America/Los_Angeles\",\"America/Louisville\",\"America/Lower_Princes\",\"America/Maceio\",\"America/Managua\",\"America/Manaus\",\"America/Marigot\",\"America/Martinique\",\"America/Matamoros\",\"America/Mazatlan\",\"America/Mendoza\",\"America/Menominee\",\"America/Merida\",\"America/Metlakatla\",\"America/Mexico_City\",\"America/Miquelon\",\"America/Moncton\",\"America/Monterrey\",\"America/Montevideo\",\"America/Montserrat\",\"America/Nassau\",\"America/New_York\",\"America/Nome\",\"America/Noronha\",\"America/North_Dakota/Beulah\",\"America/North_Dakota/Center\",\"America/North_Dakota/New_Salem\",\"America/Ojinaga\",\"America/Panama\",\"America/Paramaribo\",\"America/Phoenix\",\"America/Port-au-Prince\",\"America/Port_of_Spain\",\"America/Porto_Velho\",\"America/Puerto_Rico\",\"America/Punta_Arenas\",\"America/Rankin_Inlet\",\"America/Recife\",\"America/Regina\",\"America/Resolute\",\"America/Rio_Branco\",\"America/Santarem\",\"America/Santiago\",\"America/Santo_Domingo\",\"America/Sao_Paulo\",\"America/Scoresbysund\",\"America/Sitka\",\"America/St_Barthelemy\",\"America/St_Johns\",\"America/St_Kitts\",\"America/St_Lucia\",\"America/St_Thomas\",\"America/St_Vincent\",\"America/Swift_Current\",\"America/Tegucigalpa\",\"America/Thule\",\"America/Tijuana\",\"America/Toronto\",\"America/Tortola\",\"America/Vancouver\",\"America/Whitehorse\",\"America/Winnipeg\",\"America/Yakutat\",\"Antarctica/Casey\",\"Antarctica/Davis\",\"Antarctica/DumontDUrville\",\"Antarctica/Macquarie\",\"Antarctica/Mawson\",\"Antarctica/McMurdo\",\"Antarctica/Palmer\",\"Antarctica/Rothera\",\"Antarctica/Syowa\",\"Antarctica/Troll\",\"Antarctica/Vostok\",\"Arctic/Longyearbyen\",\"Asia/Aden\",\"Asia/Almaty\",\"Asia/Amman\",\"Asia/Anadyr\",\"Asia/Aqtau\",\"Asia/Aqtobe\",\"Asia/Ashgabat\",\"Asia/Atyrau\",\"Asia/Baghdad\",\"Asia/Bahrain\",\"Asia/Baku\",\"Asia/Bangkok\",\"Asia/Barnaul\",\"Asia/Beirut\",\"Asia/Bishkek\",\"Asia/Brunei\",\"Asia/Calcutta\",\"Asia/Chita\",\"Asia/Colombo\",\"Asia/Damascus\",\"Asia/Dhaka\",\"Asia/Dili\",\"Asia/Dubai\",\"Asia/Dushanbe\",\"Asia/Famagusta\",\"Asia/Gaza\",\"Asia/Hebron\",\"Asia/Hong_Kong\",\"Asia/Hovd\",\"Asia/Irkutsk\",\"Asia/Jakarta\",\"Asia/Jayapura\",\"Asia/Jerusalem\",\"Asia/Kabul\",\"Asia/Kamchatka\",\"Asia/Karachi\",\"Asia/Katmandu\",\"Asia/Khandyga\",\"Asia/Krasnoyarsk\",\"Asia/Kuala_Lumpur\",\"Asia/Kuching\",\"Asia/Kuwait\",\"Asia/Macau\",\"Asia/Magadan\",\"Asia/Makassar\",\"Asia/Manila\",\"Asia/Muscat\",\"Asia/Nicosia\",\"Asia/Novokuznetsk\",\"Asia/Novosibirsk\",\"Asia/Omsk\",\"Asia/Oral\",\"Asia/Phnom_Penh\",\"Asia/Pontianak\",\"Asia/Pyongyang\",\"Asia/Qatar\",\"Asia/Qostanay\",\"Asia/Qyzylorda\",\"Asia/Rangoon\",\"Asia/Riyadh\",\"Asia/Saigon\",\"Asia/Sakhalin\",\"Asia/Samarkand\",\"Asia/Seoul\",\"Asia/Shanghai\",\"Asia/Singapore\",\"Asia/Srednekolymsk\",\"Asia/Taipei\",\"Asia/Tashkent\",\"Asia/Tbilisi\",\"Asia/Tehran\",\"Asia/Thimphu\",\"Asia/Tokyo\",\"Asia/Tomsk\",\"Asia/Ulaanbaatar\",\"Asia/Urumqi\",\"Asia/Ust-Nera\",\"Asia/Vientiane\",\"Asia/Vladivostok\",\"Asia/Yakutsk\",\"Asia/Yekaterinburg\",\"Asia/Yerevan\",\"Atlantic/Azores\",\"Atlantic/Bermuda\",\"Atlantic/Canary\",\"Atlantic/Cape_Verde\",\"Atlantic/Faeroe\",\"Atlantic/Madeira\",\"Atlantic/Reykjavik\",\"Atlantic/South_Georgia\",\"Atlantic/St_Helena\",\"Atlantic/Stanley\",\"Australia/Adelaide\",\"Australia/Brisbane\",\"Australia/Broken_Hill\",\"Australia/Darwin\",\"Australia/Eucla\",\"Australia/Hobart\",\"Australia/Lindeman\",\"Australia/Lord_Howe\",\"Australia/Melbourne\",\"Australia/Perth\",\"Australia/Sydney\",\"Europe/Amsterdam\",\"Europe/Andorra\",\"Europe/Astrakhan\",\"Europe/Athens\",\"Europe/Belgrade\",\"Europe/Berlin\",\"Europe/Bratislava\",\"Europe/Brussels\",\"Europe/Bucharest\",\"Europe/Budapest\",\"Europe/Busingen\",\"Europe/Chisinau\",\"Europe/Copenhagen\",\"Europe/Dublin\",\"Europe/Gibraltar\",\"Europe/Guernsey\",\"Europe/Helsinki\",\"Europe/Isle_of_Man\",\"Europe/Istanbul\",\"Europe/Jersey\",\"Europe/Kaliningrad\",\"Europe/Kiev\",\"Europe/Kirov\",\"Europe/Lisbon\",\"Europe/Ljubljana\",\"Europe/London\",\"Europe/Luxembourg\",\"Europe/Madrid\",\"Europe/Malta\",\"Europe/Mariehamn\",\"Europe/Minsk\",\"Europe/Monaco\",\"Europe/Moscow\",\"Europe/Oslo\",\"Europe/Paris\",\"Europe/Podgorica\",\"Europe/Prague\",\"Europe/Riga\",\"Europe/Rome\",\"Europe/Samara\",\"Europe/San_Marino\",\"Europe/Sarajevo\",\"Europe/Saratov\",\"Europe/Simferopol\",\"Europe/Skopje\",\"Europe/Sofia\",\"Europe/Stockholm\",\"Europe/Tallinn\",\"Europe/Tirane\",\"Europe/Ulyanovsk\",\"Europe/Vaduz\",\"Europe/Vatican\",\"Europe/Vienna\",\"Europe/Vilnius\",\"Europe/Volgograd\",\"Europe/Warsaw\",\"Europe/Zagreb\",\"Europe/Zurich\",\"Indian/Antananarivo\",\"Indian/Chagos\",\"Indian/Christmas\",\"Indian/Cocos\",\"Indian/Comoro\",\"Indian/Kerguelen\",\"Indian/Mahe\",\"Indian/Maldives\",\"Indian/Mauritius\",\"Indian/Mayotte\",\"Indian/Reunion\",\"Pacific/Apia\",\"Pacific/Auckland\",\"Pacific/Bougainville\",\"Pacific/Chatham\",\"Pacific/Easter\",\"Pacific/Efate\",\"Pacific/Enderbury\",\"Pacific/Fakaofo\",\"Pacific/Fiji\",\"Pacific/Funafuti\",\"Pacific/Galapagos\",\"Pacific/Gambier\",\"Pacific/Guadalcanal\",\"Pacific/Guam\",\"Pacific/Honolulu\",\"Pacific/Kiritimati\",\"Pacific/Kosrae\",\"Pacific/Kwajalein\",\"Pacific/Majuro\",\"Pacific/Marquesas\",\"Pacific/Midway\",\"Pacific/Nauru\",\"Pacific/Niue\",\"Pacific/Norfolk\",\"Pacific/Noumea\",\"Pacific/Pago_Pago\",\"Pacific/Palau\",\"Pacific/Pitcairn\",\"Pacific/Ponape\",\"Pacific/Port_Moresby\",\"Pacific/Rarotonga\",\"Pacific/Saipan\",\"Pacific/Tahiti\",\"Pacific/Tarawa\",\"Pacific/Tongatapu\",\"Pacific/Truk\",\"Pacific/Wake\",\"Pacific/Wallis\"]},\"subscribed\":{\"type\":\"boolean\",\"default\":false}}}}}},\"responses\":{\"201\":{\"description\":\"The account that was created.\"}}}},\"/api/auth/email/reset-password\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Reset a password using a password reset token.\",\"operationId\":\"resetUserPassword\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"password\",\"token\"],\"properties\":{\"password\":{\"type\":\"string\",\"minLength\":8},\"token\":{\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The password has been reset.\"}}}},\"/api/auth/email/patch-password\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Update password\",\"operationId\":\"patchPassword\",\"responses\":{\"200\":{\"description\":\"Password changed.\"}},\"security\":[{\"studio\":[]}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"newPassword\",\"currentPassword\"],\"properties\":{\"newPassword\":{\"type\":\"string\",\"minLength\":8},\"currentPassword\":{\"type\":\"string\"}}}}}}}},\"/api/auth/email/resend-verification\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Resend the verification code for a registered email.\",\"operationId\":\"resendUserEmailVerification\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The verification email was sent if an account was found in the database.\"}},\"security\":[{\"studio\":[]}]}},\"/api/auth/email/request-password-reset\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Request a reset token for resetting passwords.\",\"operationId\":\"requestUserPasswordReset\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The request has been received and an email was sent if it exists.\"}}}},\"/api/auth/email/verify\":{\"post\":{\"tags\":[\"main\",\"auth\",\"email\"],\"description\":\"Verify the email address of a registered user.\",\"operationId\":\"verifyUserEmail\",\"requestBody\":{\"description\":\"The user account to register.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"token\"],\"properties\":{\"token\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"The account was successfully verified.\"}}}},\"/api/auth/oauth2/authorizations/connect\":{\"post\":{\"description\":\"Create an account using an OAuth2 authorization.\",\"tags\":[\"main\",\"auth\",\"oauth2\",\"authorization\"],\"operationId\":\"connectOAuth2Authorization\",\"requestBody\":{\"description\":\"The OAuth2 client credentials\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"code\",\"authorizationUrl\",\"timezone\"],\"properties\":{\"code\":{\"type\":\"string\"},\"authorizationUrl\":{\"type\":\"string\"},\"timezone\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"An access token response.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\"}}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/auth/oauth2/authorizations/register\":{\"post\":{\"tags\":[\"main\",\"auth\",\"oauth2\",\"authorization\"],\"operationId\":\"registerOAuth2Authorization\",\"description\":\"asd\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"authorizationUrl\",\"code\"],\"properties\":{\"authorizationUrl\":{\"type\":\"string\"},\"code\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"\"}}}},\"/api/auth/refresh-token\":{\"post\":{\"tags\":[\"main\",\"auth\"],\"description\":\"Refresh an access token using the Appsemble studio\",\"operationId\":\"refreshToken\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"refresh_token\"],\"properties\":{\"refresh_token\":{\"type\":\"string\",\"description\":\"The refresh token to use for refreshing the session.\"}}}}}},\"responses\":{\"200\":{\"description\":\"The token has been refreshed successfully.\"}}}},\"/api/blocks/@{organizationId}/{blockId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"}],\"get\":{\"tags\":[\"common\",\"block\"],\"description\":\"Get a single block\",\"operationId\":\"getBlock\",\"responses\":{\"200\":{\"description\":\"The latest version of the block that matches the given id.\",\"$ref\":\"#/components/responses/blockVersion\"}}}},\"/api/blocks/@{organizationId}/{blockId}/versions\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"}],\"get\":{\"tags\":[\"common\",\"block\",\"version\"],\"description\":\"Retrieves all available versions of a block.\",\"operationId\":\"getBlockVersions\",\"responses\":{\"200\":{\"description\":\"A list of versions of a block.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/BlockVersion\"}}}}}}}},\"/api/blocks/@{organizationId}/{blockId}/versions/list\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"}],\"get\":{\"tags\":[\"main\",\"block\",\"version\"],\"description\":\"Retrieve a string list of all versions of a block.\",\"operationId\":\"getBlockVersionsList\",\"responses\":{\"200\":{\"description\":\"String list of all versions of a block.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}},\"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"},{\"$ref\":\"#/components/parameters/blockVersion\"}],\"get\":{\"tags\":[\"common\",\"block\",\"version\"],\"description\":\"Retrieve a single block version.\",\"operationId\":\"getBlockVersion\",\"responses\":{\"200\":{\"$ref\":\"#/components/responses/blockVersion\"}}},\"delete\":{\"tags\":[\"main\",\"block\",\"version\"],\"description\":\"Delete a single block version.\",\"operationId\":\"deleteBlockVersion\",\"responses\":{\"204\":{\"description\":\"Block version has successfully been deleted\"}},\"security\":[{\"cli\":[\"blocks:delete\"]}]}},\"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/icon\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"},{\"$ref\":\"#/components/parameters/blockVersion\"}],\"get\":{\"tags\":[\"common\",\"block\",\"version\"],\"description\":\"Get the icon of a block version.\",\"operationId\":\"getBlockVersionIcon\",\"responses\":{\"200\":{\"description\":\"The icon that represents the block.\"}}}},\"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/messages/{language}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"},{\"$ref\":\"#/components/parameters/blockVersion\"},{\"in\":\"path\",\"name\":\"language\",\"schema\":{\"type\":\"string\"},\"description\":\"The language to get messages for.\",\"required\":true}],\"get\":{\"tags\":[\"common\",\"block\",\"version\",\"translation\"],\"description\":\"Get internationalized messages for a block.\",\"operationId\":\"getBlockVersionMessages\",\"responses\":{\"200\":{\"description\":\"A key/value mapping of block messages.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"description\":\"A key/value mapping of block messages.\",\"additionalProperties\":{\"type\":\"string\",\"description\":\"A translated block message.\"}}}}}}}},\"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/asset\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"$ref\":\"#/components/parameters/blockId\"},{\"$ref\":\"#/components/parameters/blockVersion\"},{\"name\":\"filename\",\"in\":\"query\",\"description\":\"The file name of the block asset to download\",\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"common\",\"block\",\"version\",\"asset\"],\"description\":\"Download a single block asset\",\"operationId\":\"getBlockVersionAsset\",\"responses\":{\"200\":{\"description\":\"The asset that has been requested.\"}}}},\"/api/blocks\":{\"post\":{\"tags\":[\"main\",\"block\"],\"description\":\"Publish a block.\",\"operationId\":\"createBlock\",\"requestBody\":{\"description\":\"The new block version to publish.\",\"content\":{\"multipart/form-data\":{\"schema\":{\"$ref\":\"#/components/schemas/BlockVersion\"}}}},\"responses\":{\"201\":{\"$ref\":\"#/components/responses/blockVersion\"}},\"security\":[{\"cli\":[\"blocks:write\"]}]},\"get\":{\"tags\":[\"common\",\"block\"],\"description\":\"Get all block\\u2019s latest definitions.\",\"operationId\":\"queryBlocks\",\"responses\":{\"200\":{\"description\":\"The list of all latest block versions.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/BlockVersion\"}}}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/containers/{appId}/logs/{container}\":{\"get\":{\"tags\":[\"container\"],\"description\":\"Retrieve the logs related to a companion container\",\"operationId\":\"getContainerLogs\",\"parameters\":[{\"name\":\"appId\",\"schema\":{\"type\":\"number\"},\"description\":\"Id of the app which defines the companion container\",\"in\":\"path\"},{\"name\":\"container\",\"schema\":{\"type\":\"string\"},\"description\":\"Name of the companion container to fetch the logs for\",\"in\":\"path\"}],\"responses\":{\"200\":{\"description\":\"Logs of the container running in a specific app\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{}}}}}},\"security\":[{\"studio\":[]}]}},\"/api/health\":{\"get\":{\"tags\":[\"main\"],\"description\":\"Check whether or not the API is healthy\",\"operationId\":\"checkHealth\",\"responses\":{\"200\":{\"description\":\"An indication the server is healthy.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Health\"}}}}}}},\"/api/messages/{language}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/language\"}],\"get\":{\"tags\":[\"main\",\"translation\"],\"description\":\"Get the Appsemble messages for this language.\",\"operationId\":\"getStudioMessages\",\"responses\":{\"200\":{\"description\":\"The app messages for the selected language.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMessages\"}}}}}}},\"/api/messages\":{\"parameters\":[{\"name\":\"context\",\"in\":\"query\",\"schema\":{\"type\":\"string\",\"enum\":[\"studio\",\"app\"]}}],\"get\":{\"tags\":[\"common\",\"translation\"],\"description\":\"Get a list of all languages with messages.\",\"operationId\":\"getAppsembleLanguages\",\"responses\":{\"200\":{\"description\":\"The list of supported languages\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}},\"/api/organization-invites/{token}/respond\":{\"parameters\":[{\"name\":\"token\",\"in\":\"path\",\"description\":\"The token of the invite.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"main\",\"organization\",\"invite\"],\"description\":\"Respond to a given invitation.\",\"operationId\":\"respondOrganizationInvite\",\"requestBody\":{\"description\":\"The response of the invitation.\\n\\n If response is true, user will join the organization. If response is false, the user declines the invite and the invite is removed.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"response\"],\"properties\":{\"response\":{\"type\":\"boolean\"}}}}}},\"responses\":{\"204\":{\"description\":\"The response has been processed.\"}},\"security\":[{\"studio\":[]}]}},\"/api/organization-invites/{token}\":{\"parameters\":[{\"name\":\"token\",\"in\":\"path\",\"description\":\"The token of the invite.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"main\",\"organization\",\"invite\"],\"description\":\"Fetch information about an invite.\",\"operationId\":\"getOrganizationInvite\",\"responses\":{\"200\":{\"description\":\"An invite response\",\"$ref\":\"#/components/responses/invite\"}}}},\"/api/organizations/{organizationId}/app-collections\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"main\",\"organization\",\"app-collection\"],\"description\":\"Get a list of app collections for an organization\",\"operationId\":\"queryOrganizationAppCollections\",\"parameters\":[{\"name\":\"organizationId\",\"in\":\"path\",\"description\":\"The id of the organization\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"}}],\"responses\":{\"200\":{\"description\":\"A list of app collections\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppCollection\"}}}}}},\"security\":[{\"studio\":[]},{}]},\"post\":{\"tags\":[\"main\",\"organization\",\"app-collection\"],\"description\":\"Create an app collection\",\"operationId\":\"createOrganizationAppCollection\",\"requestBody\":{\"description\":\"The app collection to create\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"allOf\":[{\"$ref\":\"#/components/schemas/AppCollectionDefinition\"},{\"required\":[\"name\",\"expertName\",\"expertProfileImage\",\"headerImage\"]}]},\"encoding\":{\"expertProfileImage\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"},\"headerImage\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"201\":{\"description\":\"The created app collection\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppCollection\"}}}}},\"security\":[{\"studio\":[]}]}},\"/api/organizations/{organizationId}/apps/import\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"post\":{\"tags\":[\"main\",\"app\"],\"description\":\"Import an app from a zip file\",\"operationId\":\"importApp\",\"requestBody\":{\"content\":{\"application/zip\":{\"schema\":{\"type\":\"string\",\"format\":\"binary\"}}}},\"responses\":{\"200\":{\"description\":\"App imported successfully\",\"$ref\":\"#/components/responses/app\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"apps:write\"]}]}},\"/api/organizations/{organizationId}/apps\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"main\",\"organization\",\"app\"],\"parameters\":[{\"name\":\"language\",\"schema\":{\"type\":\"string\"},\"description\":\"The language to include the translations of, if available\",\"in\":\"query\"}],\"description\":\"Get a list of an organization\\u2019s apps. Private apps are excluded unless the user is in the organization.\",\"operationId\":\"getOrganizationApps\",\"responses\":{\"200\":{\"description\":\"The list of this organization\\u2019s apps.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/App\"}}}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/organizations/{organizationId}/blocks\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"main\",\"organization\",\"block\"],\"description\":\"Get a list of an organization\\u2019s blocks.\",\"operationId\":\"getOrganizationBlocks\",\"responses\":{\"200\":{\"description\":\"The list of this organization\\u2019s blocks.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/BlockVersion\"}}}}}},\"security\":[{\"studio\":[]},{}]}},\"/api/organizations/{organizationId}/icon\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"organization\"],\"description\":\"Get the organization icon.\",\"operationId\":\"getOrganizationIcon\",\"responses\":{\"200\":{\"description\":\"The icon that represents the organization.\"}}}},\"/api/organizations/{organizationId}/invites/resend\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"post\":{\"tags\":[\"organization\"],\"description\":\"Request to resend an invitation.\",\"operationId\":\"resendOrganizationInvite\",\"requestBody\":{\"description\":\"The email of the person to resend the invitation to.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The invite has been sent.\"}},\"security\":[{\"studio\":[]}]}},\"/api/organizations/{organizationId}/invites\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"main\",\"organization\",\"invite\"],\"description\":\"Get a list of invited organization members.\",\"operationId\":\"getOrganizationInvites\",\"responses\":{\"200\":{\"description\":\"The list of all invites.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"},\"role\":{\"type\":\"string\",\"enum\":[\"Member\",\"AppTranslator\",\"AppContentsExplorer\",\"AppContentsManager\",\"AppMemberManager\",\"AppGroupManager\",\"AppGroupMembersManager\",\"AppManager\",\"AppCollectionManager\",\"BlockManager\",\"Maintainer\",\"Owner\"]}}}}}}}},\"security\":[{\"studio\":[]}]},\"post\":{\"tags\":[\"main\",\"organization\",\"invite\"],\"description\":\"Invite a new member to the organization that matches the given id.\",\"operationId\":\"createOrganizationInvites\",\"requestBody\":{\"description\":\"The member to invite.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"email\",\"role\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"},\"role\":{\"type\":\"string\",\"enum\":[\"Member\",\"AppTranslator\",\"AppContentsExplorer\",\"AppContentsManager\",\"AppMemberManager\",\"AppGroupManager\",\"AppGroupMembersManager\",\"AppManager\",\"AppCollectionManager\",\"BlockManager\",\"Maintainer\",\"Owner\"]}}}}}}},\"responses\":{\"201\":{\"description\":\"The newly invited member.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/User\"}}}}},\"security\":[{\"studio\":[]}]},\"delete\":{\"tags\":[\"main\",\"organization\",\"invite\"],\"description\":\"Revoke a member invitation.\",\"operationId\":\"deleteOrganizationInvite\",\"requestBody\":{\"description\":\"The email address to revoke the invite of.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The invitation has been successfully revoked.\"}},\"security\":[{\"studio\":[]}]}},\"/api/organizations/{organizationId}/members/{organizationMemberId}/role\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"name\":\"organizationMemberId\",\"in\":\"path\",\"description\":\"The ID of the member\",\"required\":true,\"schema\":{\"$ref\":\"#/components/schemas/User/properties/id\"}}],\"put\":{\"tags\":[\"main\",\"organization\",\"member\"],\"description\":\"Set the role of the member within the organization.\",\"operationId\":\"updateOrganizationMemberRole\",\"requestBody\":{\"description\":\"The role to set.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"role\"],\"properties\":{\"role\":{\"type\":\"string\",\"enum\":[\"Member\",\"AppTranslator\",\"AppContentsExplorer\",\"AppContentsManager\",\"AppMemberManager\",\"AppGroupManager\",\"AppGroupMembersManager\",\"AppManager\",\"AppCollectionManager\",\"BlockManager\",\"Maintainer\",\"Owner\"]}}}}}},\"responses\":{\"200\":{\"description\":\"The member\\u2019s role has been successfully updated.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/OrganizationMember\"}}}}},\"security\":[{\"studio\":[]}]}},\"/api/organizations/{organizationId}/members/{organizationMemberId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"},{\"name\":\"organizationMemberId\",\"in\":\"path\",\"description\":\"The ID of the member to remove\",\"required\":true,\"$ref\":\"#/components/schemas/User/properties/id\",\"schema\":{\"$ref\":\"#/components/schemas/User/properties/id\"}}],\"delete\":{\"tags\":[\"main\",\"organization\",\"member\"],\"description\":\"Remove a member from the organization that matches the given id, or leave the organization if the member id matches the user\\u2019s member id\",\"operationId\":\"removeOrganizationMember\",\"responses\":{\"204\":{\"description\":\"The member has been successfully removed.\"}},\"security\":[{\"studio\":[]}]}},\"/api/organizations/{organizationId}/members\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"main\",\"organization\",\"member\"],\"description\":\"Get a list of organization members.\",\"operationId\":\"getOrganizationMembers\",\"responses\":{\"200\":{\"description\":\"The list of all members.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/OrganizationMember\"}}}}}},\"security\":[{\"studio\":[]}]}},\"/api/organizations/{organizationId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/organizationId\"}],\"get\":{\"tags\":[\"main\",\"organization\"],\"description\":\"Get a single organization.\",\"operationId\":\"getOrganization\",\"responses\":{\"200\":{\"$ref\":\"#/components/responses/organization\"}}},\"patch\":{\"tags\":[\"main\",\"organization\"],\"description\":\"Update an organization\",\"operationId\":\"patchOrganization\",\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/components/schemas/Organization/properties/name\"},\"description\":{\"$ref\":\"#/components/schemas/Organization/properties/description\"},\"email\":{\"$ref\":\"#/components/schemas/Organization/properties/email\"},\"website\":{\"$ref\":\"#/components/schemas/Organization/properties/website\"},\"icon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The organization icon.\"}}},\"encoding\":{\"icon\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"200\":{\"$ref\":\"#/components/responses/organization\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"organizations:write\"]}]},\"delete\":{\"tags\":[\"main\",\"organization\"],\"description\":\"Delete an organization.\",\"operationId\":\"deleteOrganization\",\"responses\":{\"200\":{\"description\":\"successfully deleted organization\"}},\"security\":[{\"studio\":[]},{}]}},\"/api/organizations\":{\"get\":{\"tags\":[\"main\",\"organization\"],\"description\":\"Fetch the list of organizations.\",\"operationId\":\"getOrganizations\",\"responses\":{\"200\":{\"description\":\"The list of of organizations\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Organization\"}}}}}}},\"post\":{\"tags\":[\"main\",\"organization\"],\"description\":\"Create a new organization.\",\"operationId\":\"createOrganization\",\"requestBody\":{\"description\":\"The organization to create\",\"required\":true,\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"},\"name\":{\"$ref\":\"#/components/schemas/Organization/properties/name\"},\"description\":{\"$ref\":\"#/components/schemas/Organization/properties/description\"},\"email\":{\"$ref\":\"#/components/schemas/Organization/properties/email\"},\"website\":{\"$ref\":\"#/components/schemas/Organization/properties/website\"},\"icon\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The organization icon.\"}}},\"encoding\":{\"icon\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"201\":{\"$ref\":\"#/components/responses/organization\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"organizations:write\"]}]}},\"/api/ssl\":{\"get\":{\"tags\":[\"main\"],\"description\":\"Check the SSL certificate status for the given domain names.\",\"operationId\":\"getSslStatus\",\"parameters\":[{\"in\":\"query\",\"name\":\"domains\",\"required\":true,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"hostname\"}}}],\"responses\":{\"200\":{\"description\":\"A mapping of domain name to their SSL status\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":{\"enum\":[\"error\",\"missing\",\"pending\",\"ready\",\"unknown\"]}}}}}}}},\"/api/group-invites/{token}/respond\":{\"parameters\":[{\"name\":\"token\",\"in\":\"path\",\"description\":\"The token of the invite.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"post\":{\"tags\":[\"group-invite\"],\"description\":\"Respond to a given invitation.\",\"operationId\":\"respondGroupInvite\",\"requestBody\":{\"description\":\"The response of the invitation.\\n\\n If response is true, user will join the app. If response is false, the user declines the invite and the invite is removed.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"response\"],\"properties\":{\"response\":{\"type\":\"boolean\"}}}}}},\"responses\":{\"204\":{\"description\":\"The response has been processed.\"}},\"security\":[{\"app\":[]}]}},\"/api/group-invites/{token}\":{\"parameters\":[{\"name\":\"token\",\"in\":\"path\",\"description\":\"The token of the invite.\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"get\":{\"tags\":[\"group-invite\"],\"description\":\"Fetch information about an invite.\",\"operationId\":\"getGroupInvite\",\"responses\":{\"200\":{\"description\":\"An invite response\",\"$ref\":\"#/components/responses/invite\"}}}},\"/api/group-members/{groupMemberId}/role\":{\"parameters\":[{\"$ref\":\"#/components/parameters/groupMemberId\"}],\"put\":{\"tags\":[\"common\",\"group-member\"],\"description\":\"Set the role of a member within a group.\",\"operationId\":\"updateGroupMemberRole\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"requestBody\":{\"description\":\"The role to set.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"role\"],\"properties\":{\"role\":{\"type\":\"string\"}}}}}},\"responses\":{\"200\":{\"description\":\"The member\\u2019s role has been successfully updated.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GroupMember\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[]},{\"cli\":[\"groups:write\"]}]}},\"/api/group-members/{groupMemberId}\":{\"parameters\":[{\"$ref\":\"#/components/parameters/groupMemberId\"}],\"get\":{\"tags\":[\"common\",\"group-member\"],\"description\":\"Get a certain group member from a group\",\"operationId\":\"getGroupMember\",\"responses\":{\"200\":{\"description\":\"The specified group member\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/GroupMember\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[]}]},\"delete\":{\"tags\":[\"common\",\"group-member\"],\"description\":\"Remove a member from a group.\",\"operationId\":\"deleteGroupMember\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"responses\":{\"204\":{\"description\":\"The group member has been removed successfully.\"}},\"security\":[{\"studio\":[]},{\"app\":[]},{\"cli\":[\"groups:write\"]}]}},\"/api/groups/{groupId}/invites/resend\":{\"parameters\":[{\"$ref\":\"#/components/parameters/groupId\"}],\"post\":{\"tags\":[\"group\"],\"description\":\"Request to resend an invitation.\",\"operationId\":\"resendGroupInvite\",\"requestBody\":{\"description\":\"The email of the person to resend the invitation to.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\"}}}}}},\"responses\":{\"204\":{\"description\":\"The invite has been sent.\"}},\"security\":[{\"studio\":[]}]}},\"/api/groups/{groupId}/invites\":{\"parameters\":[{\"name\":\"groupId\",\"in\":\"path\",\"description\":\"The ID of the group\",\"required\":true,\"schema\":{\"type\":\"number\",\"readOnly\":true}}],\"get\":{\"tags\":[\"group\",\"invite\"],\"description\":\"Get a list of invited group members.\",\"operationId\":\"getGroupInvites\",\"responses\":{\"200\":{\"description\":\"The list of all invites.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"},\"role\":{\"type\":\"string\"}}}}}}}},\"security\":[{\"studio\":[]}]},\"post\":{\"tags\":[\"group\",\"invite\"],\"description\":\"Invite a new user to a group.\",\"operationId\":\"createGroupInvites\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"requestBody\":{\"description\":\"The group invite to create.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"email\",\"role\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\",\"description\":\"The email address of the user to invite.\"},\"role\":{\"type\":\"string\",\"description\":\"The role to invite the user as.\"}}}}}}},\"responses\":{\"200\":{\"description\":\"The invited member\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppMember\"}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"groups:write\"]},{\"cli\":[\"groups:write\"]}]},\"delete\":{\"tags\":[\"group\",\"invite\"],\"description\":\"Revoke a group member invitation.\",\"operationId\":\"deleteGroupInvite\",\"requestBody\":{\"description\":\"The email address to revoke the invite of.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}},\"responses\":{\"204\":{\"description\":\"The invitation has been successfully revoked.\"}},\"security\":[{\"studio\":[]}]}},\"/api/groups/{groupId}/members\":{\"parameters\":[{\"name\":\"groupId\",\"in\":\"path\",\"description\":\"The ID of the group\",\"required\":true,\"schema\":{\"type\":\"number\",\"readOnly\":true}}],\"get\":{\"tags\":[\"common\",\"app\",\"group\",\"members\"],\"description\":\"Fetch the members of a group and their roles within the group.\",\"operationId\":\"getGroupMembers\",\"parameters\":[{\"$ref\":\"#/components/parameters/selectedGroupId\"}],\"responses\":{\"200\":{\"description\":\"The list of all members.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/OrganizationMember\"}}}}}},\"security\":[{\"studio\":[]},{\"app\":[\"groups:read\"]}]}},\"/api/groups/{groupId}\":{\"parameters\":[{\"name\":\"groupId\",\"in\":\"path\",\"description\":\"The ID of the group\",\"required\":true,\"schema\":{\"type\":\"number\",\"readOnly\":true}}],\"get\":{\"tags\":[\"common\",\"group\"],\"description\":\"Fetch an existing group.\",\"operationId\":\"getGroup\",\"responses\":{\"200\":{\"description\":\"The requested group\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"}}}}}}},\"security\":[{\"studio\":[]}]},\"patch\":{\"tags\":[\"common\",\"group\"],\"description\":\"Update an existing group.\",\"operationId\":\"patchGroup\",\"requestBody\":{\"description\":\"The group to update.\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"},\"annotations\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}}}}}},\"responses\":{\"200\":{\"description\":\"The updated group\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"}}}}}}},\"security\":[{\"studio\":[]},{\"cli\":[\"groups:write\"]}]},\"delete\":{\"tags\":[\"common\",\"group\"],\"description\":\"Delete an existing group.\",\"operationId\":\"deleteGroup\",\"responses\":{\"204\":{\"description\":\"The group has successfully been deleted.\"}},\"security\":[{\"studio\":[]},{\"cli\":[\"groups:write\"]}]}},\"/api/timezones\":{\"get\":{\"tags\":[\"main\"],\"description\":\"Get a list of timezones supported by the API\",\"operationId\":\"getTimezones\",\"responses\":{\"200\":{\"description\":\"A list of timezones supported by the API\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}},\"/api/trainings/completed\":{\"get\":{\"description\":\"Fetch all completed trainings\",\"operationId\":\"getCompletedTrainings\",\"responses\":{\"200\":{\"description\":\"An array of training IDs that the user has completed\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"security\":[{\"studio\":[]}]},\"delete\":{\"description\":\"Delete all completed trainings from user\",\"operationId\":\"resetTrainingProgress\",\"responses\":{\"204\":{\"description\":\"Trainings successfully reset \"}},\"security\":[{\"studio\":[]}]}},\"/api/trainings/completed/{trainingId}\":{\"post\":{\"description\":\"Sets the status of this training to \\\"completed\\\" for this user\",\"operationId\":\"completeTraining\",\"parameters\":[{\"in\":\"path\",\"name\":\"trainingId\",\"schema\":{\"type\":\"string\"},\"required\":true,\"description\":\"The ID of the training to complete\"}],\"responses\":{\"201\":{\"description\":\"Training successfully set to \\\"completed\\\"\"}},\"security\":[{\"studio\":[]}]}},\"/api/trainings\":{\"get\":{\"description\":\"Fetch all training ids stored on the server\",\"operationId\":\"getTrainingIds\",\"responses\":{\"200\":{\"description\":\"An array of all training Id's\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}},\"/api/users/current/apps/accounts\":{\"get\":{\"description\":\"Get the accounts that have been linked to an app and the user\",\"tags\":[\"main\",\"user\",\"current-user\",\"app\",\"account\"],\"operationId\":\"getCurrentUserAppAccounts\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"A list of linked accounts\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AppAccount\"}}}}}}}},\"/api/users/current/apps/{appId}/account\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"get\":{\"description\":\"Get the account that have been linked to the app and the user\",\"tags\":[\"main\",\"user\",\"current-user\",\"app\",\"account\"],\"operationId\":\"getCurrentUserAppAccount\",\"security\":[{\"studio\":[]}],\"responses\":{\"200\":{\"description\":\"A linked account\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppAccount\"}}}}}},\"patch\":{\"description\":\"Get the account that have been linked to the app and the user\",\"tags\":[\"main\",\"user\",\"current-user\",\"app\",\"account\"],\"operationId\":\"patchCurrentUserAppAccount\",\"security\":[{\"studio\":[]}],\"requestBody\":{\"content\":{\"multipart/form-data\":{\"schema\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"picture\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"The member\\u2019s profile picture.\"}}},\"encoding\":{\"picture\":{\"contentType\":\"image/png,image/jpeg,image/tiff,image/webp\"}}}}},\"responses\":{\"200\":{\"description\":\"A linked account\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AppAccount\"}}}}}}},\"/api/users/current/apps\":{\"get\":{\"tags\":[\"main\",\"user\",\"current-user\",\"app\"],\"parameters\":[{\"name\":\"language\",\"schema\":{\"type\":\"string\"},\"description\":\"The language to include the translations of, if available\",\"in\":\"query\"}],\"description\":\"Get all apps from organizations that the user is in.\",\"operationId\":\"queryCurrentUserApps\",\"responses\":{\"200\":{\"description\":\"The list of all apps the user is in.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/App\"}}}}}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/auth/oauth2/apps/{appId}/consent/agree\":{\"post\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"description\":\"Create a new OAuth2 consent.\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\"],\"operationId\":\"agreeCurrentUserOAuth2AppConsent\",\"requestBody\":{\"$ref\":\"#/components/requestBodies/oauth2Consent\"},\"responses\":{\"201\":{\"$ref\":\"#/components/responses/oauth2AuthorizationCode\"}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/auth/oauth2/apps/{appId}/consent/verify\":{\"post\":{\"parameters\":[{\"$ref\":\"#/components/parameters/appId\"}],\"description\":\"Verify if the user has previously agreed to the requested OAuth2 consent.\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\"],\"operationId\":\"verifyCurrentUserOAuth2AppConsent\",\"requestBody\":{\"$ref\":\"#/components/requestBodies/oauth2Consent\"},\"responses\":{\"200\":{\"$ref\":\"#/components/responses/oauth2AuthorizationCode\"}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/auth/oauth2/authorizations\":{\"get\":{\"description\":\"Get a list of the current user\\u2019s OAuth2 authorizations.\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\",\"authorization\"],\"operationId\":\"getCurrentUserOAuth2Authorizations\",\"responses\":{\"200\":{\"description\":\"An access token response.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"authorizationUrl\":{\"type\":\"string\"}}}}}}}},\"security\":[{\"studio\":[]}]},\"delete\":{\"description\":\"Unlink a linked account from the logged in user.\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\",\"authorization\"],\"operationId\":\"deleteCurrentUserOAuth2Authorization\",\"parameters\":[{\"in\":\"query\",\"name\":\"authorizationUrl\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"201\":{\"description\":\"The account was unlinked successfully.\"}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/auth/oauth2/client-credentials/{clientId}\":{\"parameters\":[{\"name\":\"clientId\",\"in\":\"path\",\"description\":\"The client id of the OAuth2 client credentials on which to perform an operation\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"delete\":{\"description\":\"Revoke the client credentials\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\",\"client-credentials\"],\"operationId\":\"deleteCurrentUserOAuth2ClientCredentials\",\"responses\":{\"204\":{\"description\":\"The client credentials have been revoked successfully.\"}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/auth/oauth2/client-credentials\":{\"post\":{\"description\":\"Register new OAuth2 client credentials for the authenticated user.\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\",\"client-credentials\"],\"operationId\":\"registerCurrentUserOAuth2ClientCredentials\",\"requestBody\":{\"description\":\"The OAuth2 client credentials\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/OAuth2ClientCredentials\"}}}},\"responses\":{\"201\":{\"description\":\"The newly created client credentials\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/OAuth2ClientCredentials\"}}}}},\"security\":[{\"studio\":[]}]},\"get\":{\"description\":\"Get a list of client credentials for the authenticated user\",\"tags\":[\"main\",\"user\",\"current-user\",\"auth\",\"oauth2\",\"client-credentials\"],\"operationId\":\"listCurrentUserOAuth2ClientCredentials\",\"responses\":{\"200\":{\"description\":\"A list of client credentials entities.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/OAuth2ClientCredentials\"}}}}}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/emails\":{\"get\":{\"tags\":[\"main\",\"user\",\"current-user\",\"email\"],\"description\":\"List email addresses registered to logged in user's account.\",\"operationId\":\"listCurrentUserEmails\",\"responses\":{\"200\":{\"description\":\"The email address has been added successfully.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/UserEmail\"}}}}}},\"security\":[{\"studio\":[]}]},\"post\":{\"tags\":[\"main\",\"user\",\"current-user\",\"email\"],\"description\":\"Register a new email to logged in user's account.\",\"operationId\":\"addCurrentUserEmail\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserEmail\"}}}},\"responses\":{\"201\":{\"description\":\"The email address has been added successfully.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserEmail\"}}}}},\"security\":[{\"studio\":[]}]},\"delete\":{\"tags\":[\"main\",\"user\",\"current-user\",\"email\"],\"description\":\"Remove an existing email to logged in user's account.\",\"operationId\":\"removeCurrentUserEmail\",\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/UserEmail\"}}}},\"responses\":{\"204\":{\"description\":\"The email address has been removed successfully.\"}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/organizations\":{\"get\":{\"tags\":[\"main\",\"user\",\"current-user\",\"organization\"],\"description\":\"Fetch the logged in user's organizations.\",\"operationId\":\"getCurrentUserOrganizations\",\"responses\":{\"200\":{\"description\":\"The organizations the logged in user is a member of.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"$ref\":\"#/components/schemas/Organization/properties/id\"},\"name\":{\"$ref\":\"#/components/schemas/Organization/properties/name\"},\"role\":{\"$ref\":\"#/components/schemas/OrganizationMember/properties/role\"}}}}}}}},\"security\":[{\"studio\":[]}]}},\"/api/users/current/unsubscribe\":{\"post\":{\"tags\":[\"main\",\"user\",\"current-user\"],\"description\":\"Unsubscribe a user from the newsletter\",\"operationId\":\"unsubscribeCurrentUser\",\"responses\":{\"201\":{\"description\":\"Unsubscribed successfully\"},\"401\":{\"description\":\"Invalid or missing admin API secret\"}},\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"required\":[\"email\"],\"properties\":{\"email\":{\"type\":\"string\",\"format\":\"email\"}}}}}}}},\"/api/users/current\":{\"get\":{\"tags\":[\"main\",\"user\",\"current-user\"],\"description\":\"Fetch the logged in user's profile.\",\"operationId\":\"getCurrentUser\",\"responses\":{\"200\":{\"description\":\"The user's profile.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/User\"}}}}},\"security\":[{\"studio\":[]}]},\"put\":{\"tags\":[\"main\",\"user\",\"current-user\"],\"description\":\"Update the logged in user's profile.\",\"operationId\":\"patchCurrentUser\",\"requestBody\":{\"required\":true,\"$ref\":\"#/components/requestBodies/user\"},\"responses\":{\"200\":{\"description\":\"The user's profile.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/User\"}}}}},\"security\":[{\"studio\":[]}]}},\"/api/users/subscribed\":{\"get\":{\"tags\":[\"main\",\"user\"],\"description\":\"Get a list of active and verified users subscribed to the appsemble newsletter\",\"operationId\":\"getSubscribedUsers\",\"responses\":{\"200\":{\"description\":\"List of subscribed users\"},\"401\":{\"description\":\"Invalid or missing admin API secret\"}}}}},\"tags\":[{\"name\":\"account\",\"description\":\"Operations related to app accounts\"},{\"name\":\"app-member\",\"description\":\"Operations related to app members\"},{\"name\":\"app\",\"description\":\"Operations related to apps\"},{\"name\":\"action\",\"description\":\"Operations related to actions\"},{\"name\":\"app-collection\",\"description\":\"Operations related to app collections\"},{\"name\":\"app-definition\",\"description\":\"Operations related to the app definitions\"},{\"name\":\"asset\",\"description\":\"Operations related to assets\"},{\"name\":\"auth\",\"description\":\"Operations related to authentication\"},{\"name\":\"authorization\",\"description\":\"Operations related to authorizations\"},{\"name\":\"block\",\"description\":\"Operations related to blocks\"},{\"name\":\"client-credentials\",\"description\":\"Operations related to client credentials\"},{\"name\":\"common\",\"description\":\"Operations shared between apps and the studio\"},{\"name\":\"current-member\",\"description\":\"Operations related to the currently logged in user\"},{\"name\":\"current-user\",\"description\":\"Operations related to the currently logged in user\"},{\"name\":\"demo-group\",\"description\":\"Operations related to demo groups\"},{\"name\":\"demo-member\",\"description\":\"Operations related to demo members\"},{\"name\":\"email\",\"description\":\"Operations related to emails\"},{\"name\":\"invite\",\"description\":\"Operations related to invites.\"},{\"name\":\"main\",\"description\":\"Operations related to the main api\"},{\"name\":\"member\",\"description\":\"Operations related to members\"},{\"name\":\"oauth2\",\"description\":\"Operations related to oauth2\"},{\"name\":\"organization\",\"description\":\"Operations related to organizations\"},{\"name\":\"rating\",\"description\":\"Operations related to ratings\"},{\"name\":\"readme\",\"description\":\"Operations related to readmes\"},{\"name\":\"resource\",\"description\":\"Operations related to the resources\"},{\"name\":\"saml\",\"description\":\"Operations related to saml\"},{\"name\":\"scim\",\"description\":\"Operations related to scim\"},{\"name\":\"screenshot\",\"description\":\"Operations related to screenshots\"},{\"name\":\"secret\",\"description\":\"Operations related to secrets\"},{\"name\":\"service\",\"description\":\"Operations related to service secrets\"},{\"name\":\"snapshot\",\"description\":\"Operations related to snapshots\"},{\"name\":\"ssl\",\"description\":\"Operations related to ssl\"},{\"name\":\"subscription\",\"description\":\"Operations related to subscriptions\"},{\"name\":\"group-member\",\"description\":\"Operations related to group members\"},{\"name\":\"group\",\"description\":\"Operations related to groups\"},{\"name\":\"template\",\"description\":\"Operations related to templates\"},{\"name\":\"training\",\"description\":\"Operations related to trainings\"},{\"name\":\"translation\",\"description\":\"Operations related to translations\"},{\"name\":\"user\",\"description\":\"Operations related to users.\"},{\"name\":\"variable\",\"description\":\"Operations related to app variables.\"},{\"name\":\"version\",\"description\":\"Operations related to versions.\"},{\"name\":\"webhook\",\"description\":\"Operations related to webhooks.\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"AppDefinition\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"openapi":"3.0.2","components":{"parameters":{"$filter":{"name":"$filter","in":"query","description":"\n An OData filter\n\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter\n ","schema":{"type":"string"}},"$orderby":{"name":"$orderby","in":"query","description":"\n An OData query option to fetch ordered data\n\n https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby\n ","schema":{"type":"string"}},"$own":{"name":"$own","schema":{"type":"boolean"},"description":"If only the resources created by the authenticated app member should be included","in":"query"},"$select":{"name":"$select","in":"query","description":"\n The OData `$select` query option.\n\n This is a comma separated string of fields to select. Only filtering flat properties is\n supported.\n\n http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect\n ","schema":{"type":"string"}},"$skip":{"name":"$skip","in":"query","description":"Start the query from an offset.","schema":{"type":"integer","minimum":0}},"$top":{"name":"$top","in":"query","description":"Limit the number of entities returned.","schema":{"type":"integer","minimum":0}},"appId":{"name":"appId","in":"path","description":"The ID of the app on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/App/properties/id"}},"appMemberId":{"name":"memberId","in":"path","description":"The id of the app member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppMember/properties/id"}},"appOAuth2SecretId":{"name":"appOAuth2SecretId","in":"path","description":"The ID of the app OAuth2 secret on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppOAuth2Secret/properties/id"}},"appSamlSecretId":{"name":"appSamlSecretId","in":"path","description":"The ID of the app SAML secret on which to perform an operation","required":true,"schema":{"type":"string"}},"appVariableId":{"name":"appVariableId","in":"path","description":"The id of the app variable on which to perform an operation","required":true,"schema":{"type":"string"}},"assetId":{"name":"assetId","in":"path","description":"The ID of the asset on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/Asset/properties/id"}},"blockId":{"name":"blockId","in":"path","description":"The ID of the block on which to perform an operation, but without the organization scope.","required":true,"schema":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}},"blockVersion":{"name":"blockVersion","in":"path","description":"The version of the block on which to perform an operation.","required":true,"schema":{"$ref":"#/components/schemas/BlockVersion/properties/version"}},"delimiter":{"name":"delimiter","in":"query","description":"\nDelimiter to be used to parse the CSV file\n ","schema":{"type":"string"}},"endpoint":{"name":"endpoint","in":"query","description":"The URL of the endpoint associated with the subscription.","required":true,"schema":{"type":"string","format":"uri"}},"groupId":{"name":"groupId","in":"path","description":"The ID of the group on which to perform an operation","required":true,"schema":{"type":"number"}},"groupMemberId":{"name":"groupMemberId","in":"path","description":"The id of the group member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppMember/properties/id"}},"language":{"name":"language","in":"path","description":"The language on which to perform an operation","required":true,"schema":{"type":"string"}},"organizationId":{"name":"organizationId","required":true,"in":"path","description":"The ID of the organization on which to perform an operation","schema":{"$ref":"#/components/schemas/Organization/properties/id"}},"readmeId":{"name":"readmeId","in":"path","description":"The id of an app readme","required":true,"schema":{"type":"number"}},"resourceId":{"name":"resourceId","in":"path","description":"The ID of the resource on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/Resource/properties/id"}},"resourceType":{"name":"resourceType","in":"path","description":"The type of the resource on which to perform an operation","required":true,"schema":{"type":"string"}},"roles":{"name":"roles","in":"query","description":"The roles of app members on which to perform an operation","schema":{"type":"string"}},"screenshotId":{"name":"screenshotId","in":"path","description":"The id of an app screenshot","required":true,"schema":{"type":"number"}},"seed":{"name":"seed","in":"query","description":"\n Whether the resources or assets are seed instead.\n ","schema":{"type":"string"}},"selectedGroupId":{"name":"selectedGroupId","in":"query","description":"The currently selected group of the app member.","schema":{"type":"number"}},"serviceSecretId":{"name":"serviceSecretId","in":"path","description":"The id of the app service secret on which to perform an operation","required":true,"schema":{"type":"string"}},"trainingId":{"name":"trainingId","in":"path","description":"Id of the training on which the operation will be performed.","required":true,"schema":{"$ref":"#/components/schemas/Training/properties/id"}},"view":{"name":"view","in":"query","description":"The view of the resource to fetch.","schema":{"type":"string"}},"webhookName":{"name":"webhookName","in":"path","description":"The name of the webhook to call","required":true,"schema":{"type":"string"}},"webhookSecretId":{"name":"webhookSecretId","in":"path","description":"The id of the app webhook secret on which to perform an operation","required":true,"schema":{"type":"string"}}},"requestBodies":{"oauth2Consent":{"description":"The OAuth2 client credentials","required":true,"content":{"application/json":{"schema":{"type":"object","required":["redirectUri","scope"],"description":"A representation of a user\u2019s OAuth2 consent when logging in to an app.","additionalProperties":false,"properties":{"redirectUri":{"type":"string","format":"uri","description":"The URI to redirect the user back to."},"scope":{"type":"string","description":"The OAuth2 scope requested by the app."}}}}}},"resource":{"description":"A resource definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}},"multipart/form-data":{"schema":{"type":"object","required":["resource"],"description":"A `multipart/form-data` representation of a resource.","additionalProperties":false,"properties":{"resource":{"$ref":"#/components/schemas/Resource"},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}}}},"user":{"description":"A user profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInfo"}}}}},"responses":{"app":{"description":"An app response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"blockVersion":{"description":"A block definition response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockVersion"}}}},"default":{"description":"The default error response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"invite":{"description":"An invite response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"oauth2AuthorizationCode":{"description":"An OAuth2 authorization code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/App"}}}},"organization":{"description":"An organization response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"resource":{"description":"A resource response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}},"text/csv":{"schema":{"type":"string"}}}},"subscriptions":{"description":"A subscription response.","content":{"application/json":{"schema":{"type":"object","description":"A mapping of resources names to resource subscriptions.","additionalProperties":{"$ref":"#/components/schemas/ResourceSubscription"}}}}}},"schemas":{"ActionDefinition":{"allOf":[{"type":"object","description":"The base properties of an action definition.","additionalProperties":true,"properties":{"remapBefore":{"$ref":"#/components/schemas/RemapperDefinition","description":"This may be used to remap data before it is passed into the action function."},"remapAfter":{"$ref":"#/components/schemas/RemapperDefinition","description":"This may be used to remap data after it is passed into the action function."},"onSuccess":{"$ref":"#/components/schemas/ActionDefinition","description":"Another action that is dispatched when the action has been dispatched successfully."},"onError":{"$ref":"#/components/schemas/ActionDefinition","description":"Another action that is dispatched when the action has failed to dispatch successfully."}}},{"anyOf":[{"$ref":"#/components/schemas/AnalyticsActionDefinition"},{"$ref":"#/components/schemas/ControllerActionDefinition"},{"$ref":"#/components/schemas/ConditionActionDefinition"},{"$ref":"#/components/schemas/CsvParseActionDefinition"},{"$ref":"#/components/schemas/DialogActionDefinition"},{"$ref":"#/components/schemas/DialogErrorActionDefinition"},{"$ref":"#/components/schemas/DialogOkActionDefinition"},{"$ref":"#/components/schemas/DownloadActionDefinition"},{"$ref":"#/components/schemas/EachActionDefinition"},{"$ref":"#/components/schemas/EmailActionDefinition"},{"$ref":"#/components/schemas/EventActionDefinition"},{"$ref":"#/components/schemas/FlowBackActionDefinition"},{"$ref":"#/components/schemas/FlowFinishActionDefinition"},{"$ref":"#/components/schemas/FlowNextActionDefinition"},{"$ref":"#/components/schemas/FlowCancelActionDefinition"},{"$ref":"#/components/schemas/FlowToActionDefinition"},{"$ref":"#/components/schemas/LinkActionDefinition"},{"$ref":"#/components/schemas/LinkBackActionDefinition"},{"$ref":"#/components/schemas/LinkNextActionDefinition"},{"$ref":"#/components/schemas/LogActionDefinition"},{"$ref":"#/components/schemas/MatchActionDefinition"},{"$ref":"#/components/schemas/MessageActionDefinition"},{"$ref":"#/components/schemas/NoopActionDefinition"},{"$ref":"#/components/schemas/NotifyActionDefinition"},{"$ref":"#/components/schemas/RequestActionDefinition"},{"$ref":"#/components/schemas/ResourceCountActionDefinition"},{"$ref":"#/components/schemas/ResourceCreateActionDefinition"},{"$ref":"#/components/schemas/ResourceDeleteActionDefinition"},{"$ref":"#/components/schemas/ResourceDeleteAllActionDefinition"},{"$ref":"#/components/schemas/ResourceDeleteBulkActionDefinition"},{"$ref":"#/components/schemas/ResourceGetActionDefinition"},{"$ref":"#/components/schemas/ResourceHistoryGetActionDefinition"},{"$ref":"#/components/schemas/ResourceQueryActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionStatusActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionSubscribeActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionToggleActionDefinition"},{"$ref":"#/components/schemas/ResourceSubscriptionUnsubscribeActionDefinition"},{"$ref":"#/components/schemas/ResourceUpdateActionDefinition"},{"$ref":"#/components/schemas/ResourceUpdatePositionsActionDefinition"},{"$ref":"#/components/schemas/ResourcePatchActionDefinition"},{"$ref":"#/components/schemas/ShareActionDefinition"},{"$ref":"#/components/schemas/StaticActionDefinition"},{"$ref":"#/components/schemas/StorageAppendActionDefinition"},{"$ref":"#/components/schemas/StorageSubtractActionDefinition"},{"$ref":"#/components/schemas/StorageReadActionDefinition"},{"$ref":"#/components/schemas/StorageWriteActionDefinition"},{"$ref":"#/components/schemas/StorageUpdateActionDefinition"},{"$ref":"#/components/schemas/StorageDeleteActionDefinition"},{"$ref":"#/components/schemas/GroupMemberInviteActionDefinition"},{"$ref":"#/components/schemas/GroupMemberQueryActionDefinition"},{"$ref":"#/components/schemas/GroupMemberDeleteActionDefinition"},{"$ref":"#/components/schemas/GroupMemberRoleUpdateActionDefinition"},{"$ref":"#/components/schemas/GroupQueryActionDefinition"},{"$ref":"#/components/schemas/ThrowActionDefinition"},{"$ref":"#/components/schemas/AppMemberLoginActionDefinition"},{"$ref":"#/components/schemas/AppMemberLogoutActionDefinition"},{"$ref":"#/components/schemas/AppMemberRegisterActionDefinition"},{"$ref":"#/components/schemas/AppMemberInviteActionDefinition"},{"$ref":"#/components/schemas/AppMemberRoleUpdateActionDefinition"},{"$ref":"#/components/schemas/AppMemberCurrentPatchActionDefinition"},{"$ref":"#/components/schemas/AppMemberPropertiesPatchActionDefinition"},{"$ref":"#/components/schemas/AppMemberQueryActionDefinition"},{"$ref":"#/components/schemas/AppMemberDeleteActionDefinition"}]}]},"AnalyticsActionDefinition":{"type":"object","additionalProperties":false,"required":["type","target"],"properties":{"type":{"enum":["analytics"],"description":"This action sends a Google Analytics event.\n\nIt returns the input data.\n"},"target":{"type":"string","description":"The name of the analytics target event to send."},"config":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper whose result will be sent to Google Analytics as additional context"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"App":{"type":"object","description":"An app definition defines what an app will look like.","additionalProperties":false,"properties":{"id":{"type":"number","minimum":0,"readOnly":true,"description":"The unique identifier for the app.\n\nThis value will be generated automatically by the API.\n"},"OrganizationId":{"$ref":"#/components/schemas/Organization/properties/id"},"path":{"type":"string","minLength":1,"maxLength":41,"pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The URL path segment on which this app is reachable.\n\nThis may only contain lower case characters, numbers, and hyphens. By default this is a\nnormalized version of the app name.\n"},"domain":{"anyOf":[{"type":"string","maxLength":0},{"type":"string","format":"hostname"}],"description":"The domain name on which this app should be served.\n\nIf this is unspecified, the app will be served from the path on the domain of the server\n`HOSTNAME` variable.\n"},"visibility":{"description":"Determine the app visibility of the app in the Appsemble app store.\n\nThis doesn\u2019t affect whether or not the app can be accessed on its own domain.\n\n- **public**: The app is publicly listed in the Appsemble app store.\n- **unlisted**: The app store page can be accessed, but the app isn\u2019t listed publicly in the\n Appsemble app store.\n- **private**: The app is only visible to people who are part of the organization.\n","default":"unlisted","enum":["public","unlisted","private"]},"showAppDefinition":{"type":"boolean","description":"Whether or not people who have access to the app may see the app definition."},"locked":{"enum":["fullLock","studioLock","unlocked"],"default":"unlocked","description":"Determines whether this app should be locked from being updated.\n If this is set to `fullLock`, no changes can be made to the app,\n if this is set to `studioLock`, no changes can be made from the studio but updating from the CLI is possible,\n and to make any changes from the studio, this should be set to `unlocked`.\n"},"displayAppMemberName":{"type":"boolean","description":"Whether to display app member name in the title bar."},"displayInstallationPrompt":{"type":"boolean","description":"Whether to display installtion prompt to the users of app"},"template":{"type":"boolean","description":"Determines whether this app should be included when fetching for templates."},"demoMode":{"type":"boolean","description":"Determines whether this app should be used in demo mode."},"longDescription":{"type":"string","description":"\nA long description for the app.\n\nThe long description will be rendered on the app details page. Markdown content is supported.\n"},"definition":{"$ref":"#/components/schemas/AppDefinition"},"screenshotUrls":{"type":"array","description":"A list of URLs referencing app screenshots","items":{"type":"string"}},"googleAnalyticsID":{"type":"string","description":"If this is specified, Google analytics will be applied to the app","pattern":"^(|UA-\\d{4,10}-\\d{1,4}|G-[\\dA-Z]{4,})$"},"sentryDsn":{"type":"string","description":"The Sentry DSN to use for this app.\n\nIf this is specified, the given Sentry DSN will be used for error tracking. Apps without a custom\ndomain fall back to use the Appsemble server Sentry DSN.\n","format":"url"},"sentryEnvironment":{"type":"string","description":"The name that should be used as the sentry environment.\n\n This is only applied when `sentryDsn` is specified."},"controllerCode":{"type":"string","description":"Custom app logic as a JavaScript string"},"controllerImplementations":{"type":"string","description":"Appsemble SDK interfaces implementations"}}},"AppAccount":{"type":"object","description":"An object representing a member of an app","additionalProperties":false,"properties":{"app":{"$ref":"#/components/schemas/App","description":"The app this account is for."},"appMemberInfo":{"$ref":"#/components/schemas/AppMemberInfo","description":"The app member info."},"sso":{"type":"array","description":"The single sign on configurations which link the user to an external account.","items":{"$ref":"#/components/schemas/SSOConfiguration"}}}},"AppCollection":{"type":"object","description":"An app collection","additionalProperties":false,"properties":{"id":{"type":"integer","readOnly":true,"description":"The unique ID of the app collection."},"name":{"type":"string","description":"The name of the app collection."},"OrganizationId":{"type":"string","description":"The ID of the organization that owns the app collection."},"OrganizationName":{"type":"string","description":"The name of the organization that owns the app collection."},"visibility":{"enum":["private","public"],"description":"The visibility of the app collection."},"$expert":{"type":"object","additionalProperties":false,"description":"The app collection\u2019s expert/curator.","properties":{"name":{"type":"string","description":"The name of the expert."},"description":{"type":"string","description":"The description of the expert."},"profileImage":{"type":"string","description":"The URL at which the expert\u2019s profile image can be found."}}},"headerImage":{"type":"string","description":"The URL at which the app collection\u2019s header image can be found."},"$created":{"type":"string","format":"date-time","description":"When the collection was first created as an ISO 8601 formatted string"},"$updated":{"type":"string","format":"date-time","description":"When the collection was last updated as an ISO 8601 formatted string"}}},"AppCollectionDefinition":{"type":"object","description":"An app collection","additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of the app collection.","minLength":1,"maxLength":30},"visibility":{"enum":["private","public"],"description":"The visibility of the app collection."},"expertName":{"type":"string","description":"The name of the app collection\u2019s expert/curator.","minLength":1,"maxLength":30},"expertDescription":{"type":"string","description":"The description of the app collection\u2019s expert/curator.","maxLength":4000},"expertProfileImage":{"type":"string","format":"binary","description":"The profile image of the app collection\u2019s expert/curator."},"headerImage":{"type":"string","format":"binary","description":"The header image of the app collection."},"domain":{"anyOf":[{"type":"string","maxLength":0},{"type":"string","format":"hostname","maxLength":253}]}}},"AppDefinition":{"type":"object","required":["name","defaultPage","pages"],"additionalProperties":false,"description":"An app definition describes what an Appsemble app looks like.","properties":{"name":{"type":"string","minLength":1,"maxLength":30,"description":"The human readable name of the app.\n\nThis will be displayed for example on the home screen or in the browser tab.\n"},"description":{"type":"string","maxLength":80,"description":"A short description describing the app.\n\nThis will be displayed on the app store.\n"},"layout":{"$ref":"#/components/schemas/AppLayoutDefinition","description":"Properties related to the layout of the app."},"notifications":{"enum":["login","opt-in","startup"],"description":"The strategy to use for apps to subscribe to push notifications.\n\nIf specified, push notifications can be sent to subscribed users via the _Notifications_ tab in the\napp details page in Appsemble Studio. Setting this to `opt-in` allows for users to opt into\nreceiving push notifications by pressing the subscribe button in the App settings page. Setting this\nto `startup` will cause Appsemble to immediately request for the permission upon opening the app.\nIf this is set to `login`, the app will request permissions for push notification once the user\nlogs in.\n\n> **Note**: Setting `notifications` to `startup` is not recommended, due to its invasive nature.\n"},"defaultPage":{"type":"string","description":"The name of the page that should be displayed when the app is initially loaded.\n\nThis **must** match the name of a page defined for the app.\n"},"defaultLanguage":{"type":"string","default":"en","minLength":2,"description":"The default language for the app."},"controller":{"$ref":"#/components/schemas/ControllerDefinition"},"members":{"$ref":"#/components/schemas/AppMembersDefinition"},"resources":{"type":"object","description":"Resources define how Appsemble can store data for an app.\n\nThe most basic resource has a `schema` property and defines the minimal security rules.\n","additionalProperties":{"description":"A single resource definition.","$ref":"#/components/schemas/ResourceDefinition"}},"security":{"$ref":"#/components/schemas/SecurityDefinition","description":"Role and guest definitions that may be used by the app."},"pages":{"type":"array","minItems":1,"description":"The pages of the app.","items":{"anyOf":[{"$ref":"#/components/schemas/PageDefinition"},{"$ref":"#/components/schemas/TabsPageDefinition"},{"$ref":"#/components/schemas/FlowPageDefinition"},{"$ref":"#/components/schemas/LoopPageDefinition"},{"$ref":"#/components/schemas/ContainerPageDefinition"}]}},"theme":{"$ref":"#/components/schemas/Theme"},"cron":{"type":"object","minProperties":1,"description":"A list of cron jobs that are associated with this app.","additionalProperties":{"$ref":"#/components/schemas/CronDefinition"}},"webhooks":{"type":"object","minProperties":1,"description":"A list of callable webhooks that are associated with this app.","additionalProperties":{"$ref":"#/components/schemas/WebhookDefinition"}},"anchors":{"type":"array","minItems":1,"description":"Helper property that can be used to store YAML anchors.","items":{}},"containers":{"type":"array","minItems":1,"additionalProperties":false,"description":"Definition of the companion containers to be created.","items":{"$ref":"#/components/schemas/ContainerDefinition"}},"registry":{"type":"string","default":null,"description":"The default registry used to pull images for companion containers."}}},"AppLayoutDefinition":{"type":"object","description":"The layout definition allows you to tweak several layout elements of the app.","additionalProperties":false,"minProperties":1,"properties":{"login":{"enum":["navbar","navigation","hidden"],"default":"navbar","description":"The location of the login button."},"settings":{"enum":["navbar","navigation","hidden"],"default":"navbar","description":"The location of the settings button.\n\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\n"},"feedback":{"enum":["navbar","navigation","hidden"],"default":"navigation","description":"The location of the feedback button.\n\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\n"},"install":{"enum":["navbar","navigation","hidden"],"default":"navigation","description":"The location of the install button.\n\nIf set to `navigation`, it will only be visible if `login` is also visible in `navigation`.\n"},"navigation":{"enum":["bottom","left-menu","hidden"],"default":"left-menu","description":"The navigation type to use.\n\nIf this is omitted, a collapsable side navigation menu will be rendered on the left.\n"}}},"AppMember":{"type":"object","description":"An object representing a member of an app","additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true,"description":"The id of the app member."},"role":{"type":"string","description":"The role of the app member within the app."},"name":{"type":"string","description":"The full name of the app member."},"email":{"type":"string","format":"email","description":"The email address of the app member."}}},"AppMemberCurrentPatchActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["app.member.current.patch"],"description":"Allows the app member to patch their own app member account.\n\nDoes nothing if the app member isn\u2019t logged in."},"name":{"$ref":"#/components/schemas/RemapperDefinition","description":"The new full name of the app member."},"properties":{"$ref":"#/components/schemas/RemapperDefinition","description":"The updated custom properties for the app member.\n\nValues will be validated based on `members.properties`, if defined in the app definition."},"picture":{"$ref":"#/components/schemas/RemapperDefinition","description":"The picture for the patched app member"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberDeleteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","sub"],"properties":{"type":{"enum":["app.member.delete"],"description":"Allows the app member to delete another app member.\n\nDoes nothing if the app member isn\u2019t logged in."},"sub":{"$ref":"#/components/schemas/RemapperDefinition","description":"The id of the app member to be deleted."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberInfo":{"type":"object","description":"An object representing the OAuth2 info of a member of an app","additionalProperties":false,"properties":{"sub":{"type":"string","readOnly":true,"description":"The id of the app member."},"name":{"type":"string","description":"The full name of the app member."},"email":{"type":"string","format":"email","description":"The email address of the app member."},"email_verified":{"type":"boolean","description":"Whether this email address has been verified."},"picture":{"type":"string","format":"url","description":"The URL of the profile picture of the app member."},"locale":{"type":"string","description":"The locale of the app member."},"zoneinfo":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"],"description":"The time zone of the app member."},"role":{"type":"string","description":"The role of the app member within the app"},"properties":{"type":"object","description":"The custom properties of the app member.","additionalProperties":true}}},"AppMemberInviteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","email","role"],"properties":{"type":{"enum":["app.member.invite"],"description":"Allows the app member to invite another app member using an email address and a role.\n\nDoes nothing if the app member is not logged in."},"email":{"$ref":"#/components/schemas/RemapperDefinition","description":"The email to invite."},"role":{"$ref":"#/components/schemas/RemapperDefinition","description":"The role of the invited app member."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberLoginActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["app.member.login"],"description":"Allows the app member to login using an email address and a password.\n\nDoes nothing if the app member is already logged in."},"password":{"$ref":"#/components/schemas/RemapperDefinition","description":"The password to log in with."},"email":{"$ref":"#/components/schemas/RemapperDefinition","description":"The email to log in with."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberLogoutActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["app.member.logout"],"description":"Allow the app members to log out of the application."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberPropertiesPatchActionDefinition":{"type":"object","additionalProperties":false,"required":["type","sub"],"properties":{"type":{"enum":["app.member.properties.patch"],"description":"Allows the app member to patch the properties of another app member account.\n\nDoes nothing if the app member isn\u2019t logged in."},"sub":{"$ref":"#/components/schemas/RemapperDefinition","description":"The new full name name of the app member."},"properties":{"$ref":"#/components/schemas/RemapperDefinition","description":"The updated custom properties for the app member.\n\nValues will be validated based on `members.properties`, if defined in the app definition."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberPropertyDefinition":{"anyOf":[{"type":"object","description":"Definition for an app member custom property.","required":["schema"],"additionalProperties":false,"properties":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JSONSchemaInteger"},{"$ref":"#/components/schemas/JSONSchemaArray"}]},"reference":{"type":"object","additionalProperties":false,"description":"The object for the reference to another resource","properties":{"resource":{"type":"string","description":"The resource referenced by this app member property."}}}}},{"type":"object","description":"Definition for an app member property.","required":["schema"],"additionalProperties":false,"properties":{"schema":{"anyOf":[{"$ref":"#/components/schemas/JSONSchemaInteger"},{"$ref":"#/components/schemas/JSONSchemaArray"},{"$ref":"#/components/schemas/JSONSchemaString"},{"$ref":"#/components/schemas/JSONSchemaNumber"},{"$ref":"#/components/schemas/JSONSchemaEnum"},{"$ref":"#/components/schemas/JSONSchemaBoolean"},{"$ref":"#/components/schemas/JSONSchemaObject"}]}}}]},"AppMemberQueryActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["app.member.query"],"description":"Allows the currently logged in app member to fetch a list of app members by their roles.\n\nDoes nothing if the app member isn\u2019t logged in."},"roles":{"$ref":"#/components/schemas/RemapperDefinition","description":"The roles of the app members that would be fetched."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"Additional filters to fetch members based on properties and other fields"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberRegisterActionDefinition":{"type":"object","additionalProperties":false,"required":["type","email","password"],"properties":{"type":{"enum":["app.member.register"],"description":"Allows the app member to register using an email address and a password.\n\nDoes nothing if the app member is already logged in."},"password":{"$ref":"#/components/schemas/RemapperDefinition","description":"The password to log in with."},"email":{"$ref":"#/components/schemas/RemapperDefinition","description":"The email to log in with."},"name":{"$ref":"#/components/schemas/RemapperDefinition","description":"The full name of the app member."},"picture":{"$ref":"#/components/schemas/RemapperDefinition","description":"The image to use for the profile picture of the app member."},"properties":{"$ref":"#/components/schemas/RemapperDefinition","description":"The custom properties for the app member.\n\nValues will be validated based on `members.properties`, if defined in the app definition."},"login":{"type":"boolean","description":"Whether to login after registering.","default":true},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMemberRoleUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","sub"],"properties":{"type":{"enum":["app.member.role.update"],"description":"Allows the app member to update the role of another app member account.\n\nDoes nothing if the app member isn\u2019t logged in."},"sub":{"$ref":"#/components/schemas/RemapperDefinition","description":"The id of the app member."},"role":{"$ref":"#/components/schemas/RemapperDefinition","description":"The updated role of the app member.\n\nThe role must exist in the roles property of the app's security definition or in the predefined app roles in the system -\n`Member`, `MembersManager`, `GroupMembersManager`, `GroupsManager`, `ResourcesManager` and `Owner`"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"AppMembersDefinition":{"type":"object","description":"Definition for app member properties.","required":[],"additionalProperties":false,"properties":{"properties":{"type":"object","description":"The properties object configuring app members","additionalProperties":{"description":"A single app member property definition.","$ref":"#/components/schemas/AppMemberPropertyDefinition"}}}},"AppMessages":{"type":"object","description":"The response object of an messages create call.","required":["language","messages"],"additionalProperties":false,"properties":{"language":{"type":"string","description":"The language the messages represent."},"messages":{"$ref":"#/components/schemas/AppsembleMessages"},"force":{"type":"boolean","writeOnly":true,"description":"If this is true, the app lock is ignored."}}},"AppOAuth2Secret":{"type":"object","description":"Settings for login in apps using third party OAuth2 providers","required":["authorizationUrl","clientId","clientSecret","icon","name","scope","tokenUrl"],"additionalProperties":false,"properties":{"id":{"type":"number","description":"An autogenerated ID","readOnly":true},"authorizationUrl":{"type":"string","format":"uri","description":"The OAuth2 redirect URL."},"tokenUrl":{"type":"string","format":"uri","description":"The URL to request access tokens from."},"clientId":{"type":"string","description":"The public client id which identifies Appsemble to the authorization server."},"clientSecret":{"type":"string","description":"The OAuth2 client secret."},"icon":{"type":"string","description":"A Font Awesome icon which represents the OAuth2 provider."},"name":{"type":"string","description":"A display name which represents the OAuth2 provider."},"scope":{"type":"string","description":"The login scope that will be requested from the authorization server."},"userInfoUrl":{"type":"string","format":"uri","description":"The URL to request user info from"},"remapper":{"type":"array","description":"A remapper to apply on retrieved user information from the user info endpoint.","items":{}},"created":{"type":"string","format":"date-time","description":"When the secret was created originally."},"updated":{"type":"string","format":"date-time","description":"When the secret was last updated."}}},"AppServiceSecret":{"type":"object","description":"App service secret settings","required":["urlPatterns","authenticationMethod"],"additionalProperties":false,"properties":{"id":{"type":"number","description":"An autogenerated ID.","readOnly":true},"name":{"type":"string","description":"An optional name to give extra clarity what the secret is used for."},"urlPatterns":{"type":"string","description":"The url pattern that is matched when a proxied request action is called."},"authenticationMethod":{"enum":["http-basic","client-certificate","client-credentials","cookie","custom-header","query-parameter"],"description":"The method to authenticate the request action with."},"identifier":{"type":"string","description":"The parameter name, header name, username or certificate that goes with the secret."},"secret":{"type":"string","description":"The secret to authenticate the proxied outgoing request with."},"tokenUrl":{"type":"string","description":"The URL to request access tokens from."},"scope":{"type":"string","description":"The scope to request access tokens for."},"public":{"type":"boolean","description":"If a secret is marked public, it can be applied to the unauthenticated users, e.g. in the requests originating in a custom sign up or login page.","default":false},"ca":{"type":"string","description":"The custom certificate authority."}}},"AppVariable":{"type":"object","description":"App variable","required":["name"],"additionalProperties":false,"properties":{"id":{"type":"number","description":"An autogenerated ID.","readOnly":true},"name":{"type":"string","description":"The name of the variable, that will be accessible from clients."},"value":{"description":"The value of the variable.","anyOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]}}},"AppWebhookSecret":{"type":"object","description":"App webhook secret settings","additionalProperties":false,"properties":{"id":{"type":"number","description":"An autogenerated ID.","readOnly":true},"name":{"type":"string","description":"An optional name to give extra clarity what the secret is used for."},"webhookName":{"type":"string","description":"The name of the webhook the secret is tied to"},"secret":{"type":"string","description":"The autogenerated secret to authenticate the webhook caller with."}}},"AppsembleMessages":{"type":"object","description":"A mapping of the messages for this language","additionalProperties":false,"properties":{"core":{"type":"object","description":"Translations for the core of the app.","additionalProperties":{"type":"string"}},"app":{"type":"object","description":"Translations for global block messages and meta properties of the app.","additionalProperties":{"type":"string"}},"blocks":{"type":"object","description":"Translations for the core of the app.","additionalProperties":{"type":"object","description":"The name of the block type.","pattern":"^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","additionalProperties":{"type":"object","description":"The version of the block.","pattern":"^\\d+\\.\\d+\\.\\d+(-[\\d.a-z-]+)?$","additionalProperties":{"type":"string"}}}},"messageIds":{"type":"object","description":"A list of custom message IDs used by the app.","additionalProperties":{"type":"string"}}}},"ArrayRemapperDefinition":{"type":"array","description":"If a remapper is an array, it represents a chain of remappers.\n\nEach item represents a remapper which is called with the result of the remapper before it.\n\nIf an array is nested, it will be flattened. This allows you to create reusable remappers and\nreference them using YAML anchors.\n","minItems":1,"items":{"anyOf":[{"$ref":"#/components/schemas/ObjectRemapperDefinition"},{"$ref":"#/components/schemas/ArrayRemapperDefinition"}]}},"Asset":{"type":"object","description":"The response object of an asset publish call.","additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true,"description":"The unique identifier for the asset.","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"},"mime":{"type":"string","readOnly":true,"description":"The IANA MIME type of the asset."},"filename":{"type":"string","readOnly":true,"description":"The filename of the asset."},"name":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The given name of the asset. Assets may be referenced by their name or ID in the API."}}},"BlockDefinition":{"type":"object","description":"A block that is displayed on a page.","required":["type","version"],"additionalProperties":false,"properties":{"theme":{"$ref":"#/components/schemas/Theme"},"type":{"type":"string","pattern":"^(@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/)?([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The type of the block.\n\nA block type follows the format `@organization/name`. If the organization is _appsemble_, it may\nbe omitted.\n\nSome examples:\n\n- `form`\n- `@amsterdam/splash`\n"},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(-[\\d.a-z-]+)?$","description":"The version of the block to use.\n\nSince blocks may change over time, a version must be specified in order to ensure that the block\nwill remain the same until it is manually updated.\n"},"layout":{"description":"An override of the block\u2019s default layout.\n\n`float` sets the block position to float on the page and does not collide with other blocks.\nLayout float can be combined with the `position` property to place the block on the desired location.\n`grow` adds space between blocks so the page is filled.\n`static` on the contrary, does not add extra space between blocks.\n","enum":["float","grow","static"]},"hide":{"$ref":"#/components/schemas/RemapperDefinition","description":"Whether to render the block or not"},"header":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional header to render above the block."},"roles":{"type":"array","description":"The list of roles that are allowed to view this block.\n\nIf a user does not have the right role, the block is not rendered.\n","items":{"type":"string"}},"position":{"description":"For floating blocks this property defines where the block should float.","default":"bottom right","enum":["top left","top","top right","left","right","bottom left","bottom","bottom right"]},"parameters":{"type":"object","description":"A free form mapping of named parameters.\n\nThe exact meaning of the parameters depends on the block type.\n","additionalProperties":true},"actions":{"type":"object","description":"A mapping of actions that can be fired by the block to action handlers.","additionalProperties":{"$ref":"#/components/schemas/ActionDefinition"}},"events":{"$ref":"#/components/schemas/EventsDefinition"}}},"BlockVersion":{"type":"object","description":"A version of a block definition\n\nBlock versions can\u2019t be updated or deleted. This ensures apps that use a block version can never\nbe broken by alterations of block definitions.\n","required":["name","version","files"],"additionalProperties":false,"properties":{"name":{"type":"string","readOnly":true,"description":"The name of a block.\n\nThis uses the same form as scoped npm packages. For example, `@appsemble/form`.\n","pattern":"^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"},"description":{"type":"string","description":"The description of the block.","maxLength":160},"longDescription":{"type":"string","description":"The long description of the block."},"icon":{"type":"string","format":"binary","description":"An icon to represent the block in Appsemble studio."},"iconUrl":{"type":"string","format":"uri","description":"The relative URL on which the icon is served","readOnly":true},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(-[\\d.a-z-]+)?$","description":"A [semver](https://semver.org) representation of the block version."},"visibility":{"enum":["public","unlisted"],"default":"public","description":"Whether the block should be listed publicly for users who aren\u2019t part of the block\u2019s organization.\n\n- **`public`**: The block is visible for everyone.\n- **`unlisted`**: The block will only be visible if the user is logged in and is part of the block\u2019s organization."},"layout":{"description":"How the block will be displayed on the screen.\n\n- **`float`**: The block will float somewhere on the screen.\n- **`grow`**: The block will be positioned in the main page. It will grow to fill up remaining\n space on the page.\n- **`static`**: The block will be positioned in the main page. It will take up a fixed amount of\n space.\n- **`hidden`**: The block will not be rendered at all.\n","default":"grow","enum":["float","grow","static","hidden"]},"actions":{"type":"object","description":"An object which describes the actions a block can trigger.\n\nThis will be used to validate app definitions.\n","additionalProperties":true},"parameters":{"$ref":"#/components/schemas/JSONSchemaRoot","description":"A draft 7 JSON schema to use for block parameter validation.\n\nIf the parameters of a block definition don\u2019t conform to this schema, the app definition will be\nconsidered invalid.\n"},"events":{"type":"object","description":"An object describing the names of the events the block can listen and emit to.","additionalProperties":false,"properties":{"listen":{"type":"object","description":"A mapping of events this block may listen on","additionalProperties":{"description":"A mapping of events this block may listen on","type":"object","additionalProperties":false,"properties":{"description":{"type":"string"}}}},"emit":{"type":"object","description":"A mapping of events this block may emit","additionalProperties":{"description":"A mapping of events this block may emit","type":"object","additionalProperties":false,"properties":{"description":{"type":"string"}}}}}},"resources":{"type":"object","description":"deprecated","additionalProperties":true},"messages":{"type":"object","description":"The translated messages for the block.\n\nEnglish (`en`) messages are required.\n","required":["en"],"properties":{"en":{"type":"object","description":"A mapping of language IDs to their English translation","additionalProperties":{"type":"string","description":"The default translations to use.","minLength":1}}},"additionalProperties":{"type":"object","description":"A mapping of language IDs to their internationalized translation","additionalProperties":{"type":"string","description":"The translated messages for this language."}}},"files":{"type":"array","description":"A list of file assets that belong to the app version.","minLength":1,"items":{"type":"string","format":"binary"}},"examples":{"type":"array","description":"A list of exmples how the block can be used within an app definition.","items":{"type":"string"}}}},"ConditionActionDefinition":{"type":"object","additionalProperties":false,"required":["type","if"],"properties":{"type":{"enum":["condition"],"description":"Run another action if a certain contition is met."},"if":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper to determine the condition to check.\n\nIf this yields a truthy value, the `then` action is called. Otherwise the `else` action is\ncalled.\n"},"then":{"description":"This action is called if the `if` remapper yields a truthy value.","$ref":"#/components/schemas/ActionDefinition"},"else":{"description":"This action is called if the `if` remapper yields a falsy value.","$ref":"#/components/schemas/ActionDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ContainerDefinition":{"type":"object","additionalProperties":false,"description":"An object describing a companion container","required":["name","image","port"],"properties":{"name":{"type":"string","description":"Alias used to reference the container"},"image":{"type":"string","description":"Name of the image used for the container"},"port":{"type":"number","description":"Port used by the image provided"},"resources":{"type":"object","additionalProperties":true,"description":"Maximum amount of resources the container can use. Deafult: 1 CPU and 512Mi memory"},"env":{"type":"array","description":"Environment variables that will be used within the container","items":{"type":"object","additionalProperties":false,"description":"Each item is an environment variable. `useValueFromSecret` property determines whether the value is taken literally or from and existing secret","required":["name","value"],"properties":{"name":{"type":"string","description":"Name of the environment variable"},"useValueFromSecret":{"type":"boolean","description":"If set to true, will retrieve the value from the Kubernetes secret, the value property will refer to the secret key. If false, will take the value literally"},"value":{"type":"string","description":"The value of the environment variable. If `useValueFromSecret` is true, this property will refer to the Kubernetes secret's key"}}}},"metadata":{"type":"object","additionalProperties":true,"description":"Metadata including labels and annotations to be added to the container"}}},"ContainerPageDefinition":{"type":"object","additionalProperties":false,"description":"Groups pages together under a collapsible parent page. Following is an example of\nhow this can be used:\n```yaml\npages:\n - name: Page 1\n type: container\n pages:\n - name: Contained page 1\n blocks:\n - type: action-button\n version: 0.29.8\n parameters:\n icon: git-alt\n actions:\n onClick:\n type: link\n to: Contained page 2\n - name: Contained page 2\n blocks:\n - type: action-button\n version: 0.29.8\n parameters:\n icon: git-alt\n actions:\n onClick:\n type: link\n to: Contained page 1\n```\n","required":["type","pages","name"],"properties":{"type":{"enum":["container"]},"pages":{"type":"array","minItems":1,"description":"The pages of the app.","items":{"anyOf":[{"$ref":"#/components/schemas/PageDefinition"},{"$ref":"#/components/schemas/TabsPageDefinition"},{"$ref":"#/components/schemas/FlowPageDefinition"},{"$ref":"#/components/schemas/LoopPageDefinition"},{"$ref":"#/components/schemas/ContainerPageDefinition"}]}},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn\u2019t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren\u2019t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"},"badgeCount":{"$ref":"#/components/schemas/RemapperDefinition","description":"A Remapper that resolves to a number to be visibile in the side-menu."}}},"ControllerActionDefinition":{"type":"object","additionalProperties":false,"required":["type","handler"],"properties":{"type":{"enum":["controller"],"description":"Use the controller to handle the action."},"handler":{"type":"string","description":"The name of the function in the controller that will handle the action"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ControllerDefinition":{"type":"object","description":"A controller for application logic.","required":[],"additionalProperties":false,"properties":{"actions":{"type":"object","description":"A mapping of actions that can be fired by the controller to action handlers.","additionalProperties":{"$ref":"#/components/schemas/ActionDefinition"}},"events":{"$ref":"#/components/schemas/EventsDefinition"}}},"CronDefinition":{"type":"object","required":["schedule"],"description":"A cron definition defines tasks that Appsemble will run periodically for the app.","additionalProperties":false,"properties":{"schedule":{"description":"A crontab string to define when the action should be run.\n\nSee [Crontab guru](https://crontab.guru) for details\n","type":"string"},"action":{"description":"The action to run when the cronjob is triggered.","$ref":"#/components/schemas/ActionDefinition"}}},"CsvParseActionDefinition":{"type":"object","additionalProperties":false,"required":["type","file"],"properties":{"type":{"description":"An action to parse the CSV files","enum":["csv.parse"]},"file":{"description":"The CSV file to be parsed","$ref":"#/components/schemas/RemapperDefinition"},"delimiter":{"description":"The delimiter to be used, defaults to comma(\",\")","$ref":"#/components/schemas/RemapperDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"CustomFontDefinition":{"type":"object","description":"A custom font definition.","additionalProperties":false,"required":["source","family"],"properties":{"source":{"description":"Use a custom font.","enum":["custom"]},"family":{"type":"string","description":"The font family to use in the app.\n\nMake sure the font is available using custom CSS.\n"}}},"DialogActionDefinition":{"type":"object","additionalProperties":false,"required":["type","blocks"],"properties":{"type":{"enum":["dialog"],"description":"This action opens a pop-up dialog that can be used to seamlessly transition to a new set of blocks temporarily.\n\nDialogs can be closed by calling the [`dialog.ok`](#DialogOkActionDefinition) or\n[`dialog.error`](#DialogErrorActionDefinition). Users can still manually close dialogs, which\nshould be supported by the app.\n\nBlocks with the layout type `float` (e.g. `action-button`) do not work in this action.\n"},"title":{"description":"An optional title to set in the dialog header.","$ref":"#/components/schemas/RemapperDefinition"},"closable":{"type":"boolean","default":true,"description":"Whether users are allowed to close the dialog by clicking outside of it or on the close button."},"fullscreen":{"type":"boolean","default":false,"description":"Whether the dialog should be displayed full screen as if it\u2019s a new page, or as a pop-up."},"blocks":{"type":"array","description":"A list of blocks to display in the dialog.","items":{"$ref":"#/components/schemas/BlockDefinition"}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"DialogErrorActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["dialog.error"],"description":"Close an open dialog.\n\nThe dialog action that opened the dialog will be rejected with the data passed to this action.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"DialogOkActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["dialog.ok"],"description":"Close an open dialog.\n\nThe dialog action that opened the dialog will be resolved with the data passed to this action.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"DownloadActionDefinition":{"type":"object","required":["type","filename"],"additionalProperties":false,"properties":{"type":{"enum":["download"],"description":"Download the data as a file."},"filename":{"type":"string","description":"The filename to save the file as. This must include a file extension.","pattern":"\\."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"EachActionDefinition":{"type":"object","additionalProperties":false,"required":["type","do"],"properties":{"type":{"enum":["each"],"description":"Run an action for each entry in an array.\n\nThe actions are run in parallel.\n\nIf the input is not an array, the action will be applied to the input instead."},"serial":{"description":"Runs the action in series instead of parallel","type":"boolean"},"do":{"description":"This action is called for each item in the input array.","$ref":"#/components/schemas/ActionDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"EmailActionDefinition":{"type":"object","additionalProperties":false,"required":["type","subject","body"],"properties":{"type":{"enum":["email"],"description":"The email action can be used to send emails via the Appsemble server.\n\nIf `to`, `cc`, and `bcc` all end up being empty, no emails will be sent but the action will still continue as normal.\n"},"to":{"$ref":"#/components/schemas/RemapperDefinition","description":"The address the email should be sent to. Can be either in the format of `[email protected]`, or `John Doe <[email protected]>`"},"from":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the sender of the email."},"cc":{"$ref":"#/components/schemas/RemapperDefinition","description":"The list of additional email addresses email should be sent to. Uses the same format as `to`. Every email address in the CC is visible to all recipients."},"bcc":{"$ref":"#/components/schemas/RemapperDefinition","description":"The list of additional email addresses email should be sent to. Uses the same format as `to`. Email addresses in the BCC are hidden from other recipients."},"subject":{"$ref":"#/components/schemas/RemapperDefinition","description":"The subject of the email."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"The body of the email. The content of the body is converted to HTML using the Markdown syntax."},"attachments":{"$ref":"#/components/schemas/RemapperDefinition","description":"The attachments to include in the email.\n\nThe remapper must resolve to an object containing the following properties:\n\n- `target`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with `content`.\n- `content`: The raw content to include as the file content. This is mutually exclusive with `target`.\n- `filename`: The filename to include the attachment as.\n- `accept` If the target is a URL, this will be set as the HTTP `Accept` header when downloading the file.\n\nIf the attachment is a string, it will be treated as the target."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Error":{"type":"object","description":"The generic error object returned by any expected API errors.","readOnly":true,"additionalProperties":false,"properties":{"statusCode":{"type":"number","description":"Matches the HTTP response status code.","example":404},"error":{"type":"string","description":"Matches the HTTP response status description.","example":"Not Found"},"message":{"type":"string","description":"A message describing the error.","example":"Entity not found"}}},"EventActionDefinition":{"type":"object","additionalProperties":false,"required":["type","event"],"properties":{"type":{"enum":["event"],"description":"This action allows for other blocks to emit data upon triggering the action.\n\nThis can be used to make blocks interact with each other, such as triggering the `data-loader`\nblock to refresh itself by sending an event action that matches the name of what the block is\nlistening to.\n"},"event":{"type":"string","description":"The name of the event to emit."},"waitFor":{"type":"string","description":"If specified, the action will wait for this event to have been emitted and respond with its data."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"EventsDefinition":{"type":"object","description":"An object describing the names of the events the block can listen and emit to.","additionalProperties":false,"minProperties":1,"properties":{"listen":{"type":"object","description":"This property defines the events this block will listen on.\n\nThe key is the name of the event will listen on. The value is a user defined event name which should\nmatch the name of an emitted event on the same page.\n","minProperties":1,"additionalProperties":{"type":"string"}},"emit":{"type":"object","description":"This property defines the events this block will emit.\n\nThe key is the name of the event will emit. The value is a user defined event name which should\nmatch the name of a event on the same page that\u2019s being listened on.\n","minProperties":1,"additionalProperties":{"type":"string"}}}},"FilterParametersDefinition":{"type":"object","description":"An object describing the comparison that should be applied to the key in an OData filter.","additionalProperties":false,"properties":{"type":{"enum":["Boolean","String","Number","Date","Guid"]},"value":{"$ref":"#/components/schemas/RemapperDefinition"},"comparator":{"enum":["eq","ge","gt","le","lt","ne"]}}},"FlowBackActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.back"],"description":"On [flow pages](#flow-page-definition-sub-pages), return to the previous page if\nit is present. If this is called on the first page, nothing happens.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowCancelActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.cancel"],"description":"On [flow pages](../guides/page-types#flow-page), cancel the ongoing flow and invoke the page's [`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowFinishActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.finish"],"description":"On [flow pages](../guides/page-types#flow-page), triggers the\n[`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action on the page.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowNextActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["flow.next"],"description":"On [flow pages](#flow-page-definition-sub-pages), proceed to the next page if it\nis present. Otherwise, the flow is considered to be complete and [`flow.finish`](#flowfinish) will\nbe called instead.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"FlowPageActionsDefinition":{"type":"object","description":"These actions are fired on a flow page.","additionalProperties":false,"properties":{"onFlowCancel":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when `flow.cancel` gets called."},"onFlowFinish":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when a flow is finished.\n\nA flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final\nsubpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action."},"onLoad":{"$ref":"#/components/schemas/ActionDefinition","description":"This action is fired when a page loads, highly helpful in loading data for the page"}}},"FlowPageDefinition":{"type":"object","description":"Shows a set of sub pages in a certain order which the user can navigate through.","required":["type","steps","name"],"additionalProperties":false,"properties":{"type":{"enum":["flow"]},"steps":{"type":"array","minItems":2,"description":"Steps belonging to this page's flow.","items":{"$ref":"#/components/schemas/SubPage"}},"actions":{"$ref":"#/components/schemas/FlowPageActionsDefinition"},"progress":{"description":"The method that should be used to display the status of flow pages.","enum":["corner-dots","hidden"]},"retainFlowData":{"type":"boolean","description":"Whether to retain the flow data when navigating away to another page outside the flow.\n\nBy default the flow page retains it's data after navigating once. Set to false to clear it.\n","default":true},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn\u2019t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren\u2019t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"},"badgeCount":{"$ref":"#/components/schemas/RemapperDefinition","description":"A Remapper that resolves to a number to be visibile in the side-menu."}}},"FlowToActionDefinition":{"type":"object","additionalProperties":false,"required":["type","step"],"properties":{"type":{"enum":["flow.to"],"description":"On [flow pages](#flow-page-definition-sub-pages), move to a specific step."},"step":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the step to move to.\n\nThis is a remapper which gets called with the action input and context.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"GoogleFontDefinition":{"type":"object","description":"A Google font definition.","additionalProperties":false,"required":["family"],"properties":{"source":{"description":"Use a font from [Google Fonts](https://fonts.google.com).","enum":["google"]},"family":{"enum":["ABeeZee","ADLaM Display","AR One Sans","Abel","Abhaya Libre","Aboreto","Abril Fatface","Abyssinica SIL","Aclonica","Acme","Actor","Adamina","Advent Pro","Afacad","Agbalumo","Agdasima","Aguafina Script","Akatab","Akaya Kanadaka","Akaya Telivigala","Akronim","Akshar","Aladin","Alata","Alatsi","Albert Sans","Aldrich","Alef","Alegreya","Alegreya SC","Alegreya Sans","Alegreya Sans SC","Aleo","Alex Brush","Alexandria","Alfa Slab One","Alice","Alike","Alike Angular","Alkalami","Alkatra","Allan","Allerta","Allerta Stencil","Allison","Allura","Almarai","Almendra","Almendra Display","Almendra SC","Alumni Sans","Alumni Sans Collegiate One","Alumni Sans Inline One","Alumni Sans Pinstripe","Amarante","Amaranth","Amatic SC","Amethysta","Amiko","Amiri","Amiri Quran","Amita","Anaheim","Andada Pro","Andika","Anek Bangla","Anek Devanagari","Anek Gujarati","Anek Gurmukhi","Anek Kannada","Anek Latin","Anek Malayalam","Anek Odia","Anek Tamil","Anek Telugu","Angkor","Annie Use Your Telescope","Anonymous Pro","Antic","Antic Didone","Antic Slab","Anton","Antonio","Anuphan","Anybody","Aoboshi One","Arapey","Arbutus","Arbutus Slab","Architects Daughter","Archivo","Archivo Black","Archivo Narrow","Are You Serious","Aref Ruqaa","Aref Ruqaa Ink","Arima","Arimo","Arizonia","Armata","Arsenal","Artifika","Arvo","Arya","Asap","Asap Condensed","Asar","Asset","Assistant","Astloch","Asul","Athiti","Atkinson Hyperlegible","Atma","Atomic Age","Aubrey","Audiowide","Autour One","Average","Average Sans","Averia Gruesa Libre","Averia Libre","Averia Sans Libre","Averia Serif Libre","Azeret Mono","B612","B612 Mono","BIZ UDGothic","BIZ UDMincho","BIZ UDPGothic","BIZ UDPMincho","Babylonica","Bacasime Antique","Bad Script","Bagel Fat One","Bahiana","Bahianita","Bai Jamjuree","Bakbak One","Ballet","Baloo 2","Baloo Bhai 2","Baloo Bhaijaan 2","Baloo Bhaina 2","Baloo Chettan 2","Baloo Da 2","Baloo Paaji 2","Baloo Tamma 2","Baloo Tammudu 2","Baloo Thambi 2","Balsamiq Sans","Balthazar","Bangers","Barlow","Barlow Condensed","Barlow Semi Condensed","Barriecito","Barrio","Basic","Baskervville","Battambang","Baumans","Bayon","Be Vietnam Pro","Beau Rivage","Bebas Neue","Belanosima","Belgrano","Bellefair","Belleza","Bellota","Bellota Text","BenchNine","Benne","Bentham","Berkshire Swash","Besley","Beth Ellen","Bevan","BhuTuka Expanded One","Big Shoulders Display","Big Shoulders Inline Display","Big Shoulders Inline Text","Big Shoulders Stencil Display","Big Shoulders Stencil Text","Big Shoulders Text","Bigelow Rules","Bigshot One","Bilbo","Bilbo Swash Caps","BioRhyme","BioRhyme Expanded","Birthstone","Birthstone Bounce","Biryani","Bitter","Black And White Picture","Black Han Sans","Black Ops One","Blaka","Blaka Hollow","Blaka Ink","Blinker","Bodoni Moda","Bokor","Bona Nova","Bonbon","Bonheur Royale","Boogaloo","Borel","Bowlby One","Bowlby One SC","Braah One","Brawler","Bree Serif","Bricolage Grotesque","Bruno Ace","Bruno Ace SC","Brygada 1918","Bubblegum Sans","Bubbler One","Buda","Buenard","Bungee","Bungee Hairline","Bungee Inline","Bungee Outline","Bungee Shade","Bungee Spice","Butcherman","Butterfly Kids","Cabin","Cabin Condensed","Cabin Sketch","Caesar Dressing","Cagliostro","Cairo","Cairo Play","Caladea","Calistoga","Calligraffitti","Cambay","Cambo","Candal","Cantarell","Cantata One","Cantora One","Caprasimo","Capriola","Caramel","Carattere","Cardo","Carlito","Carme","Carrois Gothic","Carrois Gothic SC","Carter One","Castoro","Castoro Titling","Catamaran","Caudex","Caveat","Caveat Brush","Cedarville Cursive","Ceviche One","Chakra Petch","Changa","Changa One","Chango","Charis SIL","Charm","Charmonman","Chathura","Chau Philomene One","Chela One","Chelsea Market","Chenla","Cherish","Cherry Bomb One","Cherry Cream Soda","Cherry Swash","Chewy","Chicle","Chilanka","Chivo","Chivo Mono","Chokokutai","Chonburi","Cinzel","Cinzel Decorative","Clicker Script","Climate Crisis","Coda","Codystar","Coiny","Combo","Comfortaa","Comforter","Comforter Brush","Comic Neue","Coming Soon","Comme","Commissioner","Concert One","Condiment","Content","Contrail One","Convergence","Cookie","Copse","Corben","Corinthia","Cormorant","Cormorant Garamond","Cormorant Infant","Cormorant SC","Cormorant Unicase","Cormorant Upright","Courgette","Courier Prime","Cousine","Coustard","Covered By Your Grace","Crafty Girls","Creepster","Crete Round","Crimson Pro","Crimson Text","Croissant One","Crushed","Cuprum","Cute Font","Cutive","Cutive Mono","DM Mono","DM Sans","DM Serif Display","DM Serif Text","Dai Banna SIL","Damion","Dancing Script","Dangrek","Darker Grotesque","Darumadrop One","David Libre","Dawning of a New Day","Days One","Dekko","Dela Gothic One","Delicious Handrawn","Delius","Delius Swash Caps","Delius Unicase","Della Respira","Denk One","Devonshire","Dhurjati","Didact Gothic","Diphylleia","Diplomata","Diplomata SC","Do Hyeon","Dokdo","Domine","Donegal One","Dongle","Doppio One","Dorsa","Dosis","DotGothic16","Dr Sugiyama","Duru Sans","DynaPuff","Dynalight","EB Garamond","Eagle Lake","East Sea Dokdo","Eater","Economica","Eczar","Edu NSW ACT Foundation","Edu QLD Beginner","Edu SA Beginner","Edu TAS Beginner","Edu VIC WA NT Beginner","El Messiri","Electrolize","Elsie","Elsie Swash Caps","Emblema One","Emilys Candy","Encode Sans","Encode Sans Condensed","Encode Sans Expanded","Encode Sans SC","Encode Sans Semi Condensed","Encode Sans Semi Expanded","Engagement","Englebert","Enriqueta","Ephesis","Epilogue","Erica One","Esteban","Estonia","Euphoria Script","Ewert","Exo","Exo 2","Expletus Sans","Explora","Fahkwang","Familjen Grotesk","Fanwood Text","Farro","Farsan","Fascinate","Fascinate Inline","Faster One","Fasthand","Fauna One","Faustina","Federant","Federo","Felipa","Fenix","Festive","Figtree","Finger Paint","Finlandica","Fira Code","Fira Mono","Fira Sans","Fira Sans Condensed","Fira Sans Extra Condensed","Fjalla One","Fjord One","Flamenco","Flavors","Fleur De Leah","Flow Block","Flow Circular","Flow Rounded","Foldit","Fondamento","Fontdiner Swanky","Forum","Fragment Mono","Francois One","Frank Ruhl Libre","Fraunces","Freckle Face","Fredericka the Great","Fredoka","Freehand","Fresca","Frijole","Fruktur","Fugaz One","Fuggles","Fuzzy Bubbles","GFS Didot","GFS Neohellenic","Gabarito","Gabriela","Gaegu","Gafata","Gajraj One","Galada","Galdeano","Galindo","Gamja Flower","Gantari","Gasoek One","Gayathri","Gelasio","Gemunu Libre","Genos","Gentium Book Plus","Gentium Plus","Geo","Geologica","Georama","Geostar","Geostar Fill","Germania One","Gideon Roman","Gidugu","Gilda Display","Girassol","Give You Glory","Glass Antiqua","Glegoo","Gloock","Gloria Hallelujah","Glory","Gluten","Goblin One","Gochi Hand","Goldman","Golos Text","Gorditas","Gothic A1","Gotu","Goudy Bookletter 1911","Gowun Batang","Gowun Dodum","Graduate","Grand Hotel","Grandiflora One","Grandstander","Grape Nuts","Gravitas One","Great Vibes","Grechen Fuemen","Grenze","Grenze Gotisch","Grey Qo","Griffy","Gruppo","Gudea","Gugi","Gulzar","Gupter","Gurajada","Gwendolyn","Habibi","Hachi Maru Pop","Hahmlet","Halant","Hammersmith One","Hanalei","Hanalei Fill","Handjet","Handlee","Hanken Grotesk","Hanuman","Happy Monkey","Harmattan","Headland One","Hedvig Letters Sans","Hedvig Letters Serif","Heebo","Henny Penny","Hepta Slab","Herr Von Muellerhoff","Hi Melody","Hina Mincho","Hind","Hind Guntur","Hind Madurai","Hind Siliguri","Hind Vadodara","Holtwood One SC","Homemade Apple","Homenaje","Honk","Hubballi","Hurricane","IBM Plex Mono","IBM Plex Sans","IBM Plex Sans Arabic","IBM Plex Sans Condensed","IBM Plex Sans Devanagari","IBM Plex Sans Hebrew","IBM Plex Sans JP","IBM Plex Sans KR","IBM Plex Sans Thai","IBM Plex Sans Thai Looped","IBM Plex Serif","IM Fell DW Pica","IM Fell DW Pica SC","IM Fell Double Pica","IM Fell Double Pica SC","IM Fell English","IM Fell English SC","IM Fell French Canon","IM Fell French Canon SC","IM Fell Great Primer","IM Fell Great Primer SC","Ibarra Real Nova","Iceberg","Iceland","Imbue","Imperial Script","Imprima","Inclusive Sans","Inconsolata","Inder","Indie Flower","Ingrid Darling","Inika","Inknut Antiqua","Inria Sans","Inria Serif","Inspiration","Instrument Sans","Instrument Serif","Inter","Inter Tight","Irish Grover","Island Moments","Istok Web","Italiana","Italianno","Itim","Jacques Francois","Jacques Francois Shadow","Jaldi","JetBrains Mono","Jim Nightshade","Joan","Jockey One","Jolly Lodger","Jomhuria","Jomolhari","Josefin Sans","Josefin Slab","Jost","Joti One","Jua","Judson","Julee","Julius Sans One","Junge","Jura","Just Another Hand","Just Me Again Down Here","K2D","Kablammo","Kadwa","Kaisei Decol","Kaisei HarunoUmi","Kaisei Opti","Kaisei Tokumin","Kalam","Kalnia","Kameron","Kanit","Kantumruy Pro","Karantina","Karla","Karma","Katibeh","Kaushan Script","Kavivanar","Kavoon","Kay Pho Du","Kdam Thmor Pro","Keania One","Kelly Slab","Kenia","Khand","Khmer","Khula","Kings","Kirang Haerang","Kite One","Kiwi Maru","Klee One","Knewave","KoHo","Kodchasan","Koh Santepheap","Kolker Brush","Konkhmer Sleokchher","Kosugi","Kosugi Maru","Kotta One","Koulen","Kranky","Kreon","Kristi","Krona One","Krub","Kufam","Kulim Park","Kumar One","Kumar One Outline","Kumbh Sans","Kurale","La Belle Aurore","Labrada","Lacquer","Laila","Lakki Reddy","Lalezar","Lancelot","Langar","Lateef","Lato","Lavishly Yours","League Gothic","League Script","League Spartan","Leckerli One","Ledger","Lekton","Lemon","Lemonada","Lexend","Lexend Deca","Lexend Exa","Lexend Giga","Lexend Mega","Lexend Peta","Lexend Tera","Lexend Zetta","Libre Barcode 128","Libre Barcode 128 Text","Libre Barcode 39","Libre Barcode 39 Extended","Libre Barcode 39 Extended Text","Libre Barcode 39 Text","Libre Barcode EAN13 Text","Libre Baskerville","Libre Bodoni","Libre Caslon Display","Libre Caslon Text","Libre Franklin","Licorice","Life Savers","Lilita One","Lily Script One","Limelight","Linden Hill","Linefont","Lisu Bosa","Literata","Liu Jian Mao Cao","Livvic","Lobster","Lobster Two","Londrina Outline","Londrina Shadow","Londrina Sketch","Londrina Solid","Long Cang","Lora","Love Light","Love Ya Like A Sister","Loved by the King","Lovers Quarrel","Luckiest Guy","Lugrasimo","Lumanosimo","Lunasima","Lusitana","Lustria","Luxurious Roman","Luxurious Script","M PLUS 1","M PLUS 1 Code","M PLUS 1p","M PLUS 2","M PLUS Code Latin","M PLUS Rounded 1c","Ma Shan Zheng","Macondo","Macondo Swash Caps","Mada","Magra","Maiden Orange","Maitree","Major Mono Display","Mako","Mali","Mallanna","Mandali","Manjari","Manrope","Mansalva","Manuale","Marcellus","Marcellus SC","Marck Script","Margarine","Marhey","Markazi Text","Marko One","Marmelad","Martel","Martel Sans","Martian Mono","Marvel","Mate","Mate SC","Material Icons","Material Icons Outlined","Material Icons Round","Material Icons Sharp","Material Icons Two Tone","Material Symbols Outlined","Material Symbols Rounded","Material Symbols Sharp","Maven Pro","McLaren","Mea Culpa","Meddon","MedievalSharp","Medula One","Meera Inimai","Megrim","Meie Script","Meow Script","Merienda","Merriweather","Merriweather Sans","Metal","Metal Mania","Metamorphous","Metrophobic","Michroma","Milonga","Miltonian","Miltonian Tattoo","Mina","Mingzat","Miniver","Miriam Libre","Mirza","Miss Fajardose","Mitr","Mochiy Pop One","Mochiy Pop P One","Modak","Modern Antiqua","Mogra","Mohave","Moirai One","Molengo","Molle","Monda","Monofett","Monomaniac One","Monoton","Monsieur La Doulaise","Montaga","Montagu Slab","MonteCarlo","Montez","Montserrat","Montserrat Alternates","Montserrat Subrayada","Moo Lah Lah","Mooli","Moon Dance","Moul","Moulpali","Mountains of Christmas","Mouse Memoirs","Mr Bedfort","Mr Dafoe","Mr De Haviland","Mrs Saint Delafield","Mrs Sheppards","Ms Madi","Mukta","Mukta Mahee","Mukta Malar","Mukta Vaani","Mulish","Murecho","MuseoModerno","My Soul","Mynerve","Mystery Quest","NTR","Nabla","Nanum Brush Script","Nanum Gothic","Nanum Gothic Coding","Nanum Myeongjo","Nanum Pen Script","Narnoor","Neonderthaw","Nerko One","Neucha","Neuton","New Rocker","New Tegomin","News Cycle","Newsreader","Niconne","Niramit","Nixie One","Nobile","Nokora","Norican","Nosifer","Notable","Nothing You Could Do","Noticia Text","Noto Color Emoji","Noto Emoji","Noto Kufi Arabic","Noto Music","Noto Naskh Arabic","Noto Nastaliq Urdu","Noto Rashi Hebrew","Noto Sans","Noto Sans Adlam","Noto Sans Adlam Unjoined","Noto Sans Anatolian Hieroglyphs","Noto Sans Arabic","Noto Sans Armenian","Noto Sans Avestan","Noto Sans Balinese","Noto Sans Bamum","Noto Sans Bassa Vah","Noto Sans Batak","Noto Sans Bengali","Noto Sans Bhaiksuki","Noto Sans Brahmi","Noto Sans Buginese","Noto Sans Buhid","Noto Sans Canadian Aboriginal","Noto Sans Carian","Noto Sans Caucasian Albanian","Noto Sans Chakma","Noto Sans Cham","Noto Sans Cherokee","Noto Sans Chorasmian","Noto Sans Coptic","Noto Sans Cuneiform","Noto Sans Cypriot","Noto Sans Cypro Minoan","Noto Sans Deseret","Noto Sans Devanagari","Noto Sans Display","Noto Sans Duployan","Noto Sans Egyptian Hieroglyphs","Noto Sans Elbasan","Noto Sans Elymaic","Noto Sans Ethiopic","Noto Sans Georgian","Noto Sans Glagolitic","Noto Sans Gothic","Noto Sans Grantha","Noto Sans Gujarati","Noto Sans Gunjala Gondi","Noto Sans Gurmukhi","Noto Sans HK","Noto Sans Hanifi Rohingya","Noto Sans Hanunoo","Noto Sans Hatran","Noto Sans Hebrew","Noto Sans Imperial Aramaic","Noto Sans Indic Siyaq Numbers","Noto Sans Inscriptional Pahlavi","Noto Sans Inscriptional Parthian","Noto Sans JP","Noto Sans Javanese","Noto Sans KR","Noto Sans Kaithi","Noto Sans Kannada","Noto Sans Kawi","Noto Sans Kayah Li","Noto Sans Kharoshthi","Noto Sans Khmer","Noto Sans Khojki","Noto Sans Khudawadi","Noto Sans Lao","Noto Sans Lao Looped","Noto Sans Lepcha","Noto Sans Limbu","Noto Sans Linear A","Noto Sans Linear B","Noto Sans Lisu","Noto Sans Lycian","Noto Sans Lydian","Noto Sans Mahajani","Noto Sans Malayalam","Noto Sans Mandaic","Noto Sans Manichaean","Noto Sans Marchen","Noto Sans Masaram Gondi","Noto Sans Math","Noto Sans Mayan Numerals","Noto Sans Medefaidrin","Noto Sans Meetei Mayek","Noto Sans Mende Kikakui","Noto Sans Meroitic","Noto Sans Miao","Noto Sans Modi","Noto Sans Mongolian","Noto Sans Mono","Noto Sans Mro","Noto Sans Multani","Noto Sans Myanmar","Noto Sans NKo","Noto Sans NKo Unjoined","Noto Sans Nabataean","Noto Sans Nag Mundari","Noto Sans Nandinagari","Noto Sans New Tai Lue","Noto Sans Newa","Noto Sans Nushu","Noto Sans Ogham","Noto Sans Ol Chiki","Noto Sans Old Hungarian","Noto Sans Old Italic","Noto Sans Old North Arabian","Noto Sans Old Permic","Noto Sans Old Persian","Noto Sans Old Sogdian","Noto Sans Old South Arabian","Noto Sans Old Turkic","Noto Sans Oriya","Noto Sans Osage","Noto Sans Osmanya","Noto Sans Pahawh Hmong","Noto Sans Palmyrene","Noto Sans Pau Cin Hau","Noto Sans Phags Pa","Noto Sans Phoenician","Noto Sans Psalter Pahlavi","Noto Sans Rejang","Noto Sans Runic","Noto Sans SC","Noto Sans Samaritan","Noto Sans Saurashtra","Noto Sans Sharada","Noto Sans Shavian","Noto Sans Siddham","Noto Sans SignWriting","Noto Sans Sinhala","Noto Sans Sogdian","Noto Sans Sora Sompeng","Noto Sans Soyombo","Noto Sans Sundanese","Noto Sans Syloti Nagri","Noto Sans Symbols","Noto Sans Symbols 2","Noto Sans Syriac","Noto Sans Syriac Eastern","Noto Sans TC","Noto Sans Tagalog","Noto Sans Tagbanwa","Noto Sans Tai Le","Noto Sans Tai Tham","Noto Sans Tai Viet","Noto Sans Takri","Noto Sans Tamil","Noto Sans Tamil Supplement","Noto Sans Tangsa","Noto Sans Telugu","Noto Sans Thaana","Noto Sans Thai","Noto Sans Thai Looped","Noto Sans Tifinagh","Noto Sans Tirhuta","Noto Sans Ugaritic","Noto Sans Vai","Noto Sans Vithkuqi","Noto Sans Wancho","Noto Sans Warang Citi","Noto Sans Yi","Noto Sans Zanabazar Square","Noto Serif","Noto Serif Ahom","Noto Serif Armenian","Noto Serif Balinese","Noto Serif Bengali","Noto Serif Devanagari","Noto Serif Display","Noto Serif Dogra","Noto Serif Ethiopic","Noto Serif Georgian","Noto Serif Grantha","Noto Serif Gujarati","Noto Serif Gurmukhi","Noto Serif HK","Noto Serif Hebrew","Noto Serif JP","Noto Serif KR","Noto Serif Kannada","Noto Serif Khitan Small Script","Noto Serif Khmer","Noto Serif Khojki","Noto Serif Lao","Noto Serif Makasar","Noto Serif Malayalam","Noto Serif Myanmar","Noto Serif NP Hmong","Noto Serif Old Uyghur","Noto Serif Oriya","Noto Serif Ottoman Siyaq","Noto Serif SC","Noto Serif Sinhala","Noto Serif TC","Noto Serif Tamil","Noto Serif Tangut","Noto Serif Telugu","Noto Serif Thai","Noto Serif Tibetan","Noto Serif Toto","Noto Serif Vithkuqi","Noto Serif Yezidi","Noto Traditional Nushu","Nova Cut","Nova Flat","Nova Mono","Nova Oval","Nova Round","Nova Script","Nova Slim","Nova Square","Numans","Nunito","Nunito Sans","Nuosu SIL","Odibee Sans","Odor Mean Chey","Offside","Oi","Old Standard TT","Oldenburg","Ole","Oleo Script","Oleo Script Swash Caps","Onest","Oooh Baby","Open Sans","Oranienbaum","Orbit","Orbitron","Oregano","Orelega One","Orienta","Original Surfer","Oswald","Outfit","Over the Rainbow","Overlock","Overlock SC","Overpass","Overpass Mono","Ovo","Oxanium","Oxygen","Oxygen Mono","PT Mono","PT Sans","PT Sans Caption","PT Sans Narrow","PT Serif","PT Serif Caption","Pacifico","Padauk","Padyakke Expanded One","Palanquin","Palanquin Dark","Palette Mosaic","Pangolin","Paprika","Parisienne","Passero One","Passion One","Passions Conflict","Pathway Extreme","Pathway Gothic One","Patrick Hand","Patrick Hand SC","Pattaya","Patua One","Pavanam","Paytone One","Peddana","Peralta","Permanent Marker","Petemoss","Petit Formal Script","Petrona","Philosopher","Phudu","Piazzolla","Piedra","Pinyon Script","Pirata One","Pixelify Sans","Plaster","Play","Playball","Playfair","Playfair Display","Playfair Display SC","Playpen Sans","Plus Jakarta Sans","Podkova","Poiret One","Poller One","Poltawski Nowy","Poly","Pompiere","Pontano Sans","Poor Story","Poppins","Port Lligat Sans","Port Lligat Slab","Potta One","Pragati Narrow","Praise","Prata","Preahvihear","Press Start 2P","Pridi","Princess Sofia","Prociono","Prompt","Prosto One","Proza Libre","Public Sans","Puppies Play","Puritan","Purple Purse","Qahiri","Quando","Quantico","Quattrocento","Quattrocento Sans","Questrial","Quicksand","Quintessential","Qwigley","Qwitcher Grypen","REM","Racing Sans One","Radio Canada","Radley","Rajdhani","Rakkas","Raleway","Raleway Dots","Ramabhadra","Ramaraja","Rambla","Rammetto One","Rampart One","Ranchers","Rancho","Ranga","Rasa","Rationale","Ravi Prakash","Readex Pro","Recursive","Red Hat Display","Red Hat Mono","Red Hat Text","Red Rose","Redacted","Redacted Script","Redressed","Reem Kufi","Reem Kufi Fun","Reem Kufi Ink","Reenie Beanie","Reggae One","Rethink Sans","Revalia","Rhodium Libre","Ribeye","Ribeye Marrow","Righteous","Risque","Road Rage","Roboto","Roboto Condensed","Roboto Flex","Roboto Mono","Roboto Serif","Roboto Slab","Rochester","Rock 3D","Rock Salt","RocknRoll One","Rokkitt","Romanesco","Ropa Sans","Rosario","Rosarivo","Rouge Script","Rowdies","Rozha One","Rubik","Rubik 80s Fade","Rubik Beastly","Rubik Broken Fax","Rubik Bubbles","Rubik Burned","Rubik Dirt","Rubik Distressed","Rubik Doodle Shadow","Rubik Doodle Triangles","Rubik Gemstones","Rubik Glitch","Rubik Glitch Pop","Rubik Iso","Rubik Lines","Rubik Maps","Rubik Marker Hatch","Rubik Maze","Rubik Microbe","Rubik Mono One","Rubik Moonrocks","Rubik Pixels","Rubik Puddles","Rubik Scribble","Rubik Spray Paint","Rubik Storm","Rubik Vinyl","Rubik Wet Paint","Ruda","Rufina","Ruge Boogie","Ruluko","Rum Raisin","Ruslan Display","Russo One","Ruthie","Ruwudu","Rye","STIX Two Text","Sacramento","Sahitya","Sail","Saira","Saira Condensed","Saira Extra Condensed","Saira Semi Condensed","Saira Stencil One","Salsa","Sanchez","Sancreek","Sansita","Sansita Swashed","Sarabun","Sarala","Sarina","Sarpanch","Sassy Frass","Satisfy","Sawarabi Gothic","Sawarabi Mincho","Scada","Scheherazade New","Schibsted Grotesk","Schoolbell","Scope One","Seaweed Script","Secular One","Sedgwick Ave","Sedgwick Ave Display","Sen","Send Flowers","Sevillana","Seymour One","Shadows Into Light","Shadows Into Light Two","Shalimar","Shantell Sans","Shanti","Share","Share Tech","Share Tech Mono","Shippori Antique","Shippori Antique B1","Shippori Mincho","Shippori Mincho B1","Shizuru","Shojumaru","Short Stack","Shrikhand","Siemreap","Sigmar","Sigmar One","Signika","Signika Negative","Silkscreen","Simonetta","Single Day","Sintony","Sirin Stencil","Six Caps","Sixtyfour","Skranji","Slabo 13px","Slabo 27px","Slackey","Slackside One","Smokum","Smooch","Smooch Sans","Smythe","Sniglet","Snippet","Snowburst One","Sofadi One","Sofia","Sofia Sans","Sofia Sans Condensed","Sofia Sans Extra Condensed","Sofia Sans Semi Condensed","Solitreo","Solway","Sometype Mono","Song Myung","Sono","Sonsie One","Sora","Sorts Mill Goudy","Source Code Pro","Source Sans 3","Source Serif 4","Space Grotesk","Space Mono","Special Elite","Spectral","Spectral SC","Spicy Rice","Spinnaker","Spirax","Splash","Spline Sans","Spline Sans Mono","Squada One","Square Peg","Sree Krushnadevaraya","Sriracha","Srisakdi","Staatliches","Stalemate","Stalinist One","Stardos Stencil","Stick","Stick No Bills","Stint Ultra Condensed","Stint Ultra Expanded","Stoke","Strait","Style Script","Stylish","Sue Ellen Francisco","Suez One","Sulphur Point","Sumana","Sunflower","Sunshiney","Supermercado One","Sura","Suranna","Suravaram","Suwannaphum","Swanky and Moo Moo","Syncopate","Syne","Syne Mono","Syne Tactile","Tai Heritage Pro","Tajawal","Tangerine","Tapestry","Taprom","Tauri","Taviraj","Teko","Tektur","Telex","Tenali Ramakrishna","Tenor Sans","Text Me One","Texturina","Thasadith","The Girl Next Door","The Nautigal","Tienne","Tillana","Tilt Neon","Tilt Prism","Tilt Warp","Timmana","Tinos","Tiro Bangla","Tiro Devanagari Hindi","Tiro Devanagari Marathi","Tiro Devanagari Sanskrit","Tiro Gurmukhi","Tiro Kannada","Tiro Tamil","Tiro Telugu","Titan One","Titillium Web","Tomorrow","Tourney","Trade Winds","Train One","Trirong","Trispace","Trocchi","Trochut","Truculenta","Trykker","Tsukimi Rounded","Tulpen One","Turret Road","Twinkle Star","Ubuntu","Ubuntu Condensed","Ubuntu Mono","Uchen","Ultra","Unbounded","Uncial Antiqua","Underdog","Unica One","UnifrakturCook","UnifrakturMaguntia","Unkempt","Unlock","Unna","Updock","Urbanist","VT323","Vampiro One","Varela","Varela Round","Varta","Vast Shadow","Vazirmatn","Vesper Libre","Viaoda Libre","Vibes","Vibur","Victor Mono","Vidaloka","Viga","Vina Sans","Voces","Volkhov","Vollkorn","Vollkorn SC","Voltaire","Vujahday Script","Waiting for the Sunrise","Wallpoet","Walter Turncoat","Warnes","Water Brush","Waterfall","Wavefont","Wellfleet","Wendy One","Whisper","WindSong","Wire One","Wix Madefor Display","Wix Madefor Text","Work Sans","Workbench","Xanh Mono","Yaldevi","Yanone Kaffeesatz","Yantramanav","Yatra One","Yellowtail","Yeon Sung","Yeseva One","Yesteryear","Yomogi","Young Serif","Yrsa","Ysabeau","Ysabeau Infant","Ysabeau Office","Ysabeau SC","Yuji Boku","Yuji Hentaigana Akari","Yuji Hentaigana Akebono","Yuji Mai","Yuji Syuku","Yusei Magic","ZCOOL KuaiLe","ZCOOL QingKe HuangYou","ZCOOL XiaoWei","Zen Antique","Zen Antique Soft","Zen Dots","Zen Kaku Gothic Antique","Zen Kaku Gothic New","Zen Kurenaido","Zen Loop","Zen Maru Gothic","Zen Old Mincho","Zen Tokyo Zoo","Zeyada","Zhi Mang Xing","Zilla Slab","Zilla Slab Highlight"],"description":"The font to use in the app.\n\nAny font available on [Google Fonts](https://fonts.google.com) may be used.\n","default":{"family":"Open Sans","source":"google"}}}},"GroupMember":{"type":"object","description":"An object representing a member of a group","additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true,"description":"The id of the app member."},"role":{"type":"string","description":"The role of the app member within the group."},"name":{"$ref":"#/components/schemas/AppMember/properties/name"},"email":{"$ref":"#/components/schemas/AppMember/properties/email"}}},"GroupMemberDeleteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"enum":["group.member.delete"],"description":"Delete a group member from the group in which the invoking user is a member"},"id":{"$ref":"#/components/schemas/RemapperDefinition","description":"The id of the group member to delete"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"GroupMemberInviteActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["group.member.invite"],"description":"Invite an app member to join a group."},"id":{"description":"The ID of the group to invite the app member to.","$ref":"#/components/schemas/RemapperDefinition"},"email":{"description":"The email address of the user to invite.","$ref":"#/components/schemas/RemapperDefinition"},"role":{"description":"The role to invite the user as.","$ref":"#/components/schemas/RemapperDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"GroupMemberQueryActionDefinition":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"enum":["group.member.query"],"description":"Get a list of a group's members"},"id":{"description":"The ID of a specific group to get the members from","$ref":"#/components/schemas/RemapperDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"GroupMemberRoleUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","id","role"],"properties":{"type":{"enum":["group.member.role.update"],"description":"Update the role of a group member."},"id":{"description":"The id of the group member to update the role of.","$ref":"#/components/schemas/RemapperDefinition"},"role":{"description":"The new role of the group member.","$ref":"#/components/schemas/RemapperDefinition"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"GroupQueryActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["group.query"],"description":"Get a list of all of the groups in an app."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Health":{"type":"object","description":"A health check status","readOnly":true,"additionalProperties":false,"properties":{"database":{"type":"boolean","description":"Whether or not the database status is healthy"}}},"JSONPointer":{"type":"object","description":"A JSON pointer which may be used to reference a JSON schema.","additionalProperties":false,"required":["$ref"],"properties":{"$ref":{"type":"string","description":"A JSON schema reference.","pattern":"^#\\/definitions\\/","example":"#/definitions/MyReusableSchema"},"default":{"description":"The default value that will be used."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchema":{"anyOf":[{"$ref":"#/components/schemas/JSONPointer"},{"$ref":"#/components/schemas/JSONSchemaAnyOf"},{"$ref":"#/components/schemas/JSONSchemaArray"},{"$ref":"#/components/schemas/JSONSchemaBoolean"},{"$ref":"#/components/schemas/JSONSchemaConst"},{"$ref":"#/components/schemas/JSONSchemaEnum"},{"$ref":"#/components/schemas/JSONSchemaInteger"},{"$ref":"#/components/schemas/JSONSchemaMultiType"},{"$ref":"#/components/schemas/JSONSchemaNot"},{"$ref":"#/components/schemas/JSONSchemaNull"},{"$ref":"#/components/schemas/JSONSchemaNumber"},{"$ref":"#/components/schemas/JSONSchemaObject"},{"$ref":"#/components/schemas/JSONSchemaOneOf"},{"$ref":"#/components/schemas/JSONSchemaRemapper"},{"$ref":"#/components/schemas/JSONSchemaString"}]},"JSONSchemaAnyOf":{"type":"object","description":"A JSON schema which determines the value must match one or more of the given schemas.","additionalProperties":false,"required":["anyOf"],"properties":{"anyOf":{"type":"array","description":"The JSON schema must match one or more of the given schemas.","items":{"$ref":"#/components/schemas/JSONSchema"}},"examples":{"type":"array","description":"An example value which is valid according to this schema.","items":{}},"default":{"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaArray":{"type":"object","description":"A JSON schema for an array.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["array"],"description":"The type of the JSON schema. An array means a list of data."},"example":{"type":"array","description":"An example array which is valid according to this schema.","items":{"type":"array","items":{}}},"default":{"type":"array","description":"The default value which is used if no value is supplied.","items":{}},"maxItems":{"type":"integer","description":"The minimum amount of items the array is allowed to have.","minimum":1},"minItems":{"type":"integer","description":"The maximum amount of items the array is allowed to have.","minimum":0},"uniqueItems":{"type":"boolean","description":"If true, all items in the array need to be unique","default":false},"items":{"$ref":"#/components/schemas/JSONSchema","description":"This property describes what the items in an array should look like."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaBoolean":{"type":"object","description":"A JSON schema for a boolean.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["boolean"],"description":"The type of the JSON schema. A boolean means either true or false."},"examples":{"type":"array","items":{"type":"boolean","description":"An example boolean which is valid according to this schema."}},"default":{"type":"boolean","description":"The default value which is used if no value is supplied."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"boolean"}},"const":{"type":"boolean","description":"If const is specified, the type can be safely removed."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaConst":{"type":"object","description":"A JSON schema which describes a constant","additionalProperties":false,"required":["const"],"properties":{"const":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}],"description":"The given value must exactly match one the value specified here."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaEnum":{"type":"object","description":"A JSON schema for an enum.","additionalProperties":false,"required":["enum"],"properties":{"enum":{"type":"array","description":"A specific set of values this property is allowed to have.","items":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}]}},"enumDescriptions":{"type":"array","description":"An array is descriptions for the enum values.\n\nThe description is applied to the enum value at the same index.","items":{"type":"string"}},"examples":{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}],"description":"An example which is valid according to this schema."}},"default":{"anyOf":[{"type":"boolean"},{"type":"number"},{"type":"string"},{"enum":[null]}],"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaInteger":{"type":"object","description":"A JSON schema for an integer.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["integer"],"description":"The type of the JSON schema. An integer means a fractionless number."},"examples":{"type":"array","items":{"type":"integer","description":"An example integer which is valid according to this schema."}},"default":{"type":"integer","description":"The default value which is used if no value is supplied."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"integer"}},"const":{"type":"integer","description":"If const is specified, the type can be safely removed."},"minimum":{"type":"integer","description":"The minimum value of the number.","example":0},"maximum":{"type":"integer","description":"The maximum value of the number.","example":100},"multipleOf":{"type":"integer","description":"The value must be a multiple of this number.\n\nFor example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,\n5, 7, 8, etc.\n"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaMultiType":{"type":"object","description":"A JSON schema which defines multiple types.","additionalProperties":false,"required":["type"],"properties":{"type":{"type":"array","uniqueItems":true,"minItems":2,"description":"The type of the JSON schema. It\u2019s recommended to use only one.","items":{"enum":["array","boolean","integer","null","number","string"]}},"examples":{"type":"array","description":"An example which is valid according to this schema.","items":{}},"default":{"description":"The default value which is used if no value is supplied."},"maxItems":{"type":"integer","description":"The minimum amount of items the array is allowed to have.","minimum":1},"minItems":{"type":"integer","description":"The maximum amount of items the array is allowed to have.","minimum":0},"uniqueItems":{"type":"boolean","description":"If true, all items in the array need to be unique","default":false},"items":{"$ref":"#/components/schemas/JSONSchema","description":"This property describes what the items in an array should look like."},"minimum":{"type":"integer","description":"The minimum value of the number.","example":0},"maximum":{"type":"integer","description":"The maximum value of the number.","example":100},"multipleOf":{"type":"integer","description":"The value must be a multiple of this number.\n\nFor example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,\n5, 7, 8, etc.\n"},"maxProperties":{"type":"integer","description":"The maximum number of properties the object is allowed to have.","minimum":0},"minProperties":{"type":"integer","description":"The minimum number of properties the object is must have.","minimum":1},"properties":{"type":"object","description":"A mapping of object keys for the object to nested JSON schemas.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"required":{"type":"array","description":"A list of properties that are required.","minItems":1,"items":{"type":"string","description":"A property name which is required on the object."}},"additionalProperties":{"description":"Describe if this object is allowed to have properties besides those defined in `properties`\n\nIt\u2019s recommended to set this to `false`.\n","example":false,"anyOf":[{"type":"boolean","description":"If false, the object may not have any additional properties.\n\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\n"},{"$ref":"#/components/schemas/JSONSchema","description":"If this is a JSON schema, it describes any additional properties."}]},"format":{"enum":["date-time","time","date","duration","email","idn-email","hostname","idn-hostname","ipv4","ipv6","uuid","uri","uri-reference","iri","iri-reference","uri-template","json-pointer","relative-json-pointer","regex","action","binary","event-emitter","event-listener","fontawesome"],"description":"The format values should adhere to."},"minLength":{"type":"integer","description":"The minimum length of the string.","minimum":1},"maxLength":{"type":"integer","description":"The maximum length of the string.\n\nIt\u2019s highly recommended to set this property, even if it\u2019s a big number. For example 5000 characters\nis plenty for most larger input fields. Not doing so may result in extremely large user input, which\nresults in a bad user experience.\n","minimum":1,"example":5000},"pattern":{"type":"string","description":"A regular expression to describe user input.\n\nRegular expressions are a powerful way to enforce proper user input, but the learning curve is high.\nIf you don\u2019t know what this is, we recommend to omit this field for now.\n","minLength":1,"format":"regex"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaNot":{"type":"object","description":"A JSON schema which may not be matched.","additionalProperties":false,"required":["not"],"properties":{"not":{"$ref":"#/components/schemas/JSONSchema","description":"The JSON schema which the value may not match."},"examples":{"type":"array","description":"An example value which is valid according to this schema.","items":{}},"default":{"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaNull":{"type":"object","description":"A JSON schema of type null only accepts a null value","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["null"],"description":"Only accept a null value."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaNumber":{"type":"object","description":"A JSON schema for a number which has fractions.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["number"],"description":"The type of the JSON schema. A number represents a number which has fractions. For fractionless numbers, use `integer` instead."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"number"}},"const":{"type":"number","description":"If const is specified, the type can be safely removed."},"examples":{"type":"array","items":{"type":"number","description":"An example number which is valid according to this schema."}},"default":{"type":"number","description":"The default value which is used if no value is supplied."},"minimum":{"type":"number","description":"The minimum value of the number.","example":0},"maximum":{"type":"number","description":"The maximum value of the number.","example":100},"exclusiveMinimum":{"type":"number","description":"The value must be bigger than this number. The given value itself is not allowed."},"exclusiveMaximum":{"type":"number","description":"The value must be smaller than this number. The given value itself is not allowed."},"multipleOf":{"type":"number","description":"The value must be a multiple of this number.\n\nFor example, if this is set to 0.5, then the values 0, 0.5, 1, 1.5, 2, 2.5, etc. will be allowed,\nbut not 0.3, 1.7, etc.\n"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaObject":{"type":"object","description":"A JSON schema for an object.","additionalProperties":false,"required":["type","additionalProperties"],"properties":{"type":{"enum":["object"],"description":"The type of the JSON schema."},"examples":{"type":"array","items":{"type":"object","description":"An example object which is valid according to this schema.","additionalProperties":true}},"default":{"type":"object","description":"The default value which is used if no value is supplied.","additionalProperties":true},"maxProperties":{"type":"integer","description":"The maximum number of properties the object is allowed to have.","minimum":0},"minProperties":{"type":"integer","description":"The minimum number of properties the object is must have.","minimum":1},"required":{"type":"array","description":"A list of properties that are required.","minItems":1,"items":{"type":"string","description":"A property name which is required on the object."}},"properties":{"type":"object","description":"A mapping of object keys for the object to nested JSON schemas.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"additionalProperties":{"description":"Describe if this object is allowed to have properties besides those defined in `properties`\n\nIt\u2019s recommended to set this to `false`.\n","example":false,"anyOf":[{"type":"boolean","description":"If false, the object may not have any additional properties.\n\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\n"},{"$ref":"#/components/schemas/JSONSchema","description":"If this is a JSON schema, it describes any additional properties."}]},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaOneOf":{"type":"object","description":"A JSON schema which determines the value must match exactly one of the given schemas.","additionalProperties":false,"required":["oneOf"],"properties":{"oneOf":{"type":"array","description":"The JSON schema must match exactly one of the given schemas.","items":{"$ref":"#/components/schemas/JSONSchema"}},"example":{"description":"An example value which is valid according to this schema."},"default":{"description":"The default value which is used if no value is supplied."},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaRemapper":{"type":"object","description":"A JSON schema which allows a format of remapper without a type.","additionalProperties":false,"required":["format"],"properties":{"format":{"enum":["remapper"],"description":"Allow a remapper definition. This is supported for blocks only."},"default":{"$ref":"#/components/schemas/RemapperDefinition"},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"JSONSchemaRoot":{"type":"object","description":"A top level JSON schema.","additionalProperties":false,"properties":{"definitions":{"description":"This property may be used to store JSON schemas that may be referenced from other places.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"$schema":{"description":"The JSON schema meta schema. You probably don\u2019t need to specify this explicitly.","enum":["http://json-schema.org/draft-04/schema#","http://json-schema.org/draft-07/schema#"],"default":"http://json-schema.org/draft-07/schema#"},"type":{"enum":["object"],"description":"The type of the JSON schema."},"examples":{"type":"array","items":{"type":"object","description":"An example object which is valid according to this schema.","additionalProperties":true}},"default":{"type":"object","description":"The default value which is used if no value is supplied.","additionalProperties":true},"maxProperties":{"type":"integer","description":"The maximum number of properties the object is allowed to have.","minimum":0},"minProperties":{"type":"integer","description":"The minimum number of properties the object is must have.","minimum":1},"required":{"type":"array","description":"A list of properties that are required.","minItems":1,"items":{"type":"string","description":"A property name which is required on the object."}},"properties":{"type":"object","description":"A mapping of object keys for the object to nested JSON schemas.","additionalProperties":{"$ref":"#/components/schemas/JSONSchema"}},"additionalProperties":{"description":"Describe if this object is allowed to have properties besides those defined in `properties`\n\nIt\u2019s recommended to set this to `false`.\n","example":false,"anyOf":[{"type":"boolean","description":"If false, the object may not have any additional properties.\n\nIf true, the object may have **any** type of additional properties. This is **not** recommended.\n"},{"$ref":"#/components/schemas/JSONSchema","description":"If this is a JSON schema, it describes any additional properties."}]},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}},"required":["type","additionalProperties"]},"JSONSchemaString":{"type":"object","description":"A JSON schema for a string.","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["string"],"description":"The type of the JSON schema. A string is the technical term for a piece of text."},"examples":{"type":"array","items":{"type":"string","description":"An example string which is valid according to this schema."}},"default":{"type":"string","description":"The default value which is used if no value is supplied."},"enum":{"type":"array","description":"If an enum is specified, the type can be safely removed.","items":{"type":"string"}},"const":{"type":"string","description":"If const is specified, the type can be safely removed."},"format":{"enum":["date-time","time","date","duration","email","idn-email","hostname","idn-hostname","ipv4","ipv6","uuid","uri","uri-reference","iri","iri-reference","uri-template","json-pointer","relative-json-pointer","regex","action","binary","event-emitter","event-listener","fontawesome"],"description":"The format values should adhere to."},"minLength":{"type":"integer","description":"The minimum length of the string.","minimum":1},"maxLength":{"type":"integer","description":"The maximum length of the string.\n\nIt\u2019s highly recommended to set this property, even if it\u2019s a big number. For example 5000 characters\nis plenty for most larger input fields. Not doing so may result in extremely large user input, which\nresults in a bad user experience.\n","minimum":1,"example":5000},"pattern":{"type":"string","description":"A regular expression to describe user input.\n\nRegular expressions are a powerful way to enforce proper user input, but the learning curve is high.\nIf you don\u2019t know what this is, we recommend to omit this field for now.\n","minLength":1,"format":"regex"},"multiline":{"type":"boolean","description":"If true, Appsemble renders a textarea in the graphical JSON editor.","default":false},"title":{"type":"string","minLength":1,"maxLength":50,"description":"A short title of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"},"description":{"type":"string","minLength":1,"maxLength":5000,"description":"A description of the instance.\n\nThis is used in various places inside Appsemble Studio.\n"}}},"LinkActionDefinition":{"type":"object","additionalProperties":false,"required":["type","to"],"properties":{"type":{"enum":["link"],"description":"The link action can be used to redirect the user to other pages or absolute URLs."},"to":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/RemapperDefinition"}],"description":"The name of the page to link to. Subpages can be referred to using arrays. If this matches with an absolute URL, link will open this instead of matching it with a page or subpage."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LinkBackActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["link.back"],"description":"Link back to the previous page in the browser history."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LinkNextActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["link.next"],"description":"Link to the next page in the browser history."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LogActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["log"],"description":"Output the result of the action into the console.\n\nThis is mostly useful for debugging blocks during development.\n"},"level":{"enum":["error","info","warn"],"default":"info","description":"The logging level on which to log."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"LoopPageActionsDefinition":{"type":"object","description":"These actions are fired on a loop page.","required":["onLoad"],"additionalProperties":false,"properties":{"onLoad":{"$ref":"#/components/schemas/ActionDefinition","description":"This action is used to define the data to pass onto the loop type array"},"onFlowCancel":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when `flow.cancel` gets called."},"onFlowFinish":{"$ref":"#/components/schemas/ActionDefinition","description":"This action gets triggered when a flow is finished.\n\nA flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final\nsubpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this action."}}},"LoopPageDefinition":{"type":"object","description":"Generates sub pages dynamically based on data and display in a flow page.","required":["type","foreach","actions","name"],"additionalProperties":false,"properties":{"type":{"enum":["loop"]},"actions":{"$ref":"#/components/schemas/LoopPageActionsDefinition"},"foreach":{"$ref":"#/components/schemas/SubPage"},"progress":{"description":"The method that should be used to display the status of flow pages.","enum":["corner-dots","hidden"]},"retainFlowData":{"type":"boolean","description":"Whether to retain the flow data when navigating away to another page outside the flow.\n\nBy default the flow page retains it's data after navigating once. Set to false to clear it.\n","default":true},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn\u2019t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren\u2019t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"},"badgeCount":{"$ref":"#/components/schemas/RemapperDefinition","description":"A Remapper that resolves to a number to be visibile in the side-menu."}}},"MatchActionDefinition":{"type":"object","additionalProperties":false,"required":["type","match"],"properties":{"type":{"enum":["match"],"description":"Run another action if one of the cases is true.\n\nOnly the first case that equals true is called."},"match":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["case","action"],"description":"","properties":{"case":{"$ref":"#/components/schemas/RemapperDefinition","description":"The case to be matched."},"action":{"$ref":"#/components/schemas/ActionDefinition","description":"Action to be called if the case equals true."}}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"MessageActionDefinition":{"type":"object","additionalProperties":false,"required":["type","body"],"properties":{"type":{"enum":["message"],"description":"Display a message to the user.\n\nThis is useful in combination with action chaining to notify users they have performed a certain action.\n"},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"The body of the message."},"color":{"enum":["dark","primary","link","success","info","warning","danger"],"default":"info","description":"The Bulma color to apply to the message."},"layout":{"enum":["bottom","top"],"default":"bottom","description":"The position of the message on the screen."},"dismissable":{"type":"boolean","description":"Boolean value indicating whether the user is able to dismiss the message manually."},"timeout":{"type":"integer","default":5000,"description":"The time in milliseconds how long the message should be visible."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"NoopActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["noop"],"description":"Do nothing when this action is triggered.\n\nThis is the default action for block actions that are not required.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"NotificationHookDataDefinition":{"type":"object","description":"The data used to display the content of the notification.","additionalProperties":true,"minProperties":1,"properties":{"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title of the notification."},"content":{"$ref":"#/components/schemas/RemapperDefinition","description":"The body of the notification."},"link":{"type":"string","description":"The URL of the page the user gets redirected to after being clicked.\n\nIf the URL is relative, it will be relative to the app.\n"}}},"NotificationHookDefinition":{"type":"object","description":"The strategy used to notify users.","additionalProperties":false,"minProperties":1,"properties":{"to":{"type":"array","description":"The list of roles to notify.\n\nAside from roles, `$author` can also be used to notify the author of the resource.\n","minItems":1,"items":{"type":"string"}},"subscribe":{"description":"If set, allows users to manually subscribe for notifications for this resource regardless of roles.\n\nThe following values are allowed:\n- `all`: Allows users to be notified about actions on all of the resources of this type.\n- `single`: Allows users to be notified about actions a single instance of a resource of this\n type.\n- `both`: Allows users to be notified about all resources or a single resource of this type.\n","enum":["all","single","both"]},"data":{"$ref":"#/components/schemas/NotificationHookDataDefinition"}}},"NotifyActionDefinition":{"type":"object","additionalProperties":false,"required":["type","title","body","to"],"properties":{"type":{"enum":["notify"],"description":"Send notifications to one or all the users of an app."},"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title of the notification."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"The description of the notification."},"to":{"$ref":"#/components/schemas/RemapperDefinition","description":"To whom the notification should be sent.\n\nUse `all` to send the notification to all app subscribed users.\nOr notify specific users by passing either a single user id or an array of user ids.\n\nNothing is sent if the value is **not** a valid user id.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"OAuth2AuthorizationCode":{"type":"object","description":"OAuth2 client credentials","required":["code"],"additionalProperties":false,"properties":{"code":{"type":"string","description":"The OAuth2 authorization code.","readOnly":true}}},"OAuth2ClientCredentials":{"type":"object","description":"OAuth2 client credentials","required":["description","scopes"],"additionalProperties":false,"properties":{"id":{"type":"string","description":"The generated client id","readOnly":true},"secret":{"type":"string","description":"The generated client secret","readOnly":true},"description":{"type":"string","description":"A description for the user to recognize the client.","maxLength":50},"expires":{"type":"string","description":"When the client credentials expire automatically.","format":"date-time"},"scopes":{"type":"array","description":"The scopes that have been granted to the client.","items":{"enum":["apps:export","apps:write","apps:delete","blocks:write","blocks:delete","organizations:write","resources:read","resources:write","assets:write","groups:read","groups:write"]}}}},"ObjectRemapperDefinition":{"type":"object","description":"An object based remapper is defined by a specific implementation\n\nObject based remappers may only define 1 key. The allowed value depends on the remapper.\n","minProperties":1,"maxProperties":1,"additionalProperties":false,"properties":{"array.map":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nThe remapper goes through the given array and applies the given remappers on each individual item.\nThis can be very handy when sorting arrays by certain data. The remapper always returns an array.\nOutput can be an empty array if the supplied data isn\u2019t an array.\n\nFor example, if you want to sort through a list of people and only get their occupations you can do\nthe following:\n\nInput:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\"\n }\n]\n```\n```yaml\narray.map:\n object.omit:\n - name\n\n```\nResult:\n\n```json\n[{\"occupation\":\"Delivery driver\"},{\"occupation\":\"Scientist\"},{\"occupation\":\"CEO\"}]\n```\n\n\nAnother great use for `array.map` is to combine it with the `if` remapper and sort your arrays on\nspecific values.\n\nUsing the same input data from the previous example, look at how you can change the code to get\npeople from a specific occupation:\n\n```yaml\n- array.map:\n if:\n condition:\n equals:\n - prop: occupation\n - Scientist\n else: null\n then:\n object.from:\n name:\n prop: name\n occupation:\n prop: occupation\n- null.strip: null\n\n```\nResult:\n\n```json\n[{\"name\":\"Otto\",\"occupation\":\"Scientist\"}]\n```\n\n\nBecause `array.map` returns an array, every item has to return something. This is why we have to\nreturn the full object with the data we want in the `then` section. It\u2019s also why we return `null`.\nThis results in an array consisting of `null` values and objects with actual data in them. To solve\nthis problem, we use the `null.strip` remapper to remove any null values which results in a clean\narray.\n"},"array.unique":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nFilters out unique values from an array. The value Remapper is applied to each entry in the array\nusing its result to determine uniqueness.\n\nIf the value Remapper results in undefined or null, the entire entry is used for uniqueness.\n\nIf the input is not an array, the input is returned without any modifications.\n\nInput:\n\n```json\n[1,1,2,3]\n```\n```yaml\narray.unique: null\n\n```\nResult:\n\n```json\n[1,2,3]\n```\n\n\nYou can also check for more complex values in arrays. The remapper accepts remappers as well, so you\ncan also use entire objects to check for unique values.\n\nFor this example, we have the following extended data with some duplicate values:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\",\n \"age\": 19\n },\n {\n \"name\": \"Peter\",\n \"occupation\": \"Photographer\",\n \"age\": 19\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\",\n \"age\": 50\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\",\n \"age\": 20\n }\n]\n```\n\nWe can be fairly sure in this list of people the first two Peters are the same person but with a\ndifferent occupation. To get more complex unique values from here, we can do the following:\n\n```yaml\narray.unique:\n object.from:\n name: { prop: name }\n age: { prop: age }\n```\n\nThis then checks the array for unique values in both the `name` and `age` fields. The result of this\nremapper is a filtered list:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\",\n \"age\": 19\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\",\n \"age\": 50\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\",\n \"age\": 20\n }\n]\n```\n "},"array.filter":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nFilters out values based on the input conditions provided.\n\nFor example:\n\nInput:\n\n```json\n[{\"name\":\"Peter\"},{\"name\":\"Louis\"},{\"name\":\"Brian\"}]\n```\n```yaml\narray.filter:\n equals:\n - prop: name\n - Louis\n\n```\nResult:\n\n```json\n[{\"name\":\"Louis\"}]\n```\n\n\nExample of how it can be used to filter a number array.\n\nInput:\n\n```json\n[1,2,1,3,4,1,5]\n```\n\n```yaml\narray.filter:\n equals:\n - array: item\n - 1\n```\n\nResult:\n\n```json\n[1,1,1]\n```\n "},"array.find":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nReturns a single object or value from an array based on the given condition.\n\nFor example:\n\nInput:\n\n```json\n[{\"name\":\"Craig\"},{\"name\":\"Joey\"},{\"name\":\"Stuart\"}]\n```\n```yaml\narray.find:\n equals:\n - prop: name\n - Craig\n\n```\nResult:\n\n```json\n{\"name\":\"Craig\"}\n```\n\n"},"array.from":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\nCreates a new array based on a provided array of remappers. This array can also consist of static\nvalues.\n\nFor example:\n\n```yaml\narray.from:\n - Peter\n - Otto\n - Harry\n\n```\nResult:\n\n```json\n[\"Peter\",\"Otto\",\"Harry\"]\n```\n\n\nThis remapper can also be used to convert given data into an array.\n\nInput:\n\n```json\n{\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n}\n```\n\n```yaml\narray.from:\n - root: null # Takes the data passed to this remapper, explained more in the 'Data' page\n```\n\nResult:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n }\n]\n```\n "},"array.append":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\nAppend new values to the end of an array. If the input is not an array an empty array is returned.\n\nUsing the array from the previous example, we can add a new object on top of it using this remapper:\n\n```yaml\narray.append:\n - object.from:\n name: James\n occupation: News reporter\n\n```\nResult:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\"\n },\n {\n \"name\": \"James\",\n \"occupation\": \"News reporter\"\n }\n]\n```\n\n\nExtra example:\n\narray remapper can also be used in combination with different remappers as in the current example comes object remapper:\n\nExample object:\n```json\n{\n \"names\": [\"Bart\", \"Bas\", \"Sam\"]\n}\n```\n\nCombination of object and array remapper:\n\n```yaml\nobject.assign:\n names:\n - { prop: Applicants }\n - array.append:\n - Kevin\n```\n\nResult:\n```json\n{\n \"names\": [\"Bart\", \"Bas\", \"Sam\", \"Kevin\"]\n}\n```\n "},"array.omit":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\nRemove values from an array. The input is expected to be the index(es) of the items to be deleted.\nAccepts an array of static or remapper values.\n\nWith the previous example we added a new person to the list of people, so now we can remove that\nperson. We already know the index of this person in the array is `3`, so it\u2019s easy:\n\n```yaml\narray.omit:\n - 3\n\n```\nResult:\n\n```json\n[\n {\n \"name\": \"Peter\",\n \"occupation\": \"Delivery driver\"\n },\n {\n \"name\": \"Otto\",\n \"occupation\": \"Scientist\"\n },\n {\n \"name\": \"Harry\",\n \"occupation\": \"CEO\"\n }\n]\n```\n\n\nHowever, usually we don\u2019t know the exact index of the item we want to delete. Because the remapper\naccepts remappers as input we can get the desired item\u2019s ID from another source as well. Take the\nfollowing example:\n\nIn this example we assume the data from the previous example is passed to this table block using a\ndata loader\u2019s emitting event called \u201cpeople\u201d. When the user clicks on one of the people in the\ntable, it gets the list of people again. Using the index of this person, and the `array.omit`\nremapper, the person gets removed from the list.\n\n```yaml\ntype: table\nversion: 0.20.38\nevents:\n listen:\n data: people\nparameters:\n fields:\n - label: Name\n value: { prop: name }\n onClick: removePerson\n - label: Occupation\n value: { prop: occupation }\nactions:\n removePerson:\n type: resource.query\n resource: citizensNYC\n remapAfter:\n array.omit:\n - context: index # This gets the index of the item in the table, explained more in the 'Data' page.\n onSuccess:\n type: resource.update\n resource: citizensNYC\n```\n "},"array.flatten":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nFlatten an array. Accepts an array of static or remapper values.\n\nSay for example that each person has some pets. We could get an array of all pets like so:\n\nInput:\n\n```json\n[\n [\n \"Milka\",\n \"Sven\"\n ],\n \"Goldie\"\n]\n```\nResult:\n\n```json\n[\"Milka\",\"Sven\",\"Goldie\"]\n```\n\n"},"array.contains":{"$ref":"#/components/schemas/RemapperDefinition","description":"\nChecks if the input array includes the provided item.\nInput:\n\n```json\n[1,2,3,4,5]\n```\n```yaml\narray.contains:\n static: 6\n\n```\nResult:\n\n```json\nfalse\n```\n\n"},"if":{"type":"object","description":"Check if condition results in a truthy value.\n\nReturns value of `then` if condition is truthy, otherwise it returns the value of `else`.\n\nFor example:\n\nInput:\n\n```json\n{\"guess\":4}\n```\n```yaml\nif:\n condition:\n equals:\n - prop: guess\n - 4\n then:\n static: You guessed right!\n else:\n static: You guessed wrong!\n\n```\nResult:\n\n```json\n\"You guessed right!\"\n```\n\n\nInput:\n\n```json\n{\"guess\":5}\n```\nResult:\n\n```json\n\"You guessed wrong!\"\n```\n\n","additionalProperties":false,"required":["condition","then","else"],"properties":{"condition":{"$ref":"#/components/schemas/RemapperDefinition","description":"The condition to check."},"then":{"$ref":"#/components/schemas/RemapperDefinition","description":"This remapper is used if the condition returns true."},"else":{"$ref":"#/components/schemas/RemapperDefinition","description":"This remapper is used if the condition returns false."}}},"equals":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"Compare all computed remapper values against each other.\n\nReturns `true` if all entries are equal, otherwise `false`.\n\nIn the following example, if the `inputValue` and `expectedValue` are of the same value, the\ncondition will return `true` and the `then` remapper will fire.\n\nInput:\n\n```json\n{\"inputValue\":\"example\",\"expectedValue\":\"example\"}\n```\n```yaml\nequals:\n - prop: inputValue\n - prop: expectedValue\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"gt":{"type":"array","description":"**(gt = Greater than)**\n\nCompare the first computed remapper value with the second computed remapper value.\n\nReturns `true` if the first entry is greater than the second entry.\n\nFor example, if `stock` is more than 5 here, it returns `true`.\n\nInput:\n\n```json\n{\"stock\":100}\n```\n```yaml\ngt:\n - prop: stock\n - 5\n\n```\nResult:\n\n```json\ntrue\n```\n\n","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/RemapperDefinition"}},"lt":{"type":"array","description":"**(lt = Lesser than)\n\nCompare the first computed remapper value with the second computed remapper value.\n\nReturns `true` if the first entry is lesser than the second entry.\n\nFor example, if `stock` is less than 5 here, it returns `true`.\n\nInput:\n\n```json\n{\"stock\":100}\n```\n```yaml\ngt:\n - prop: stock\n - 5\n\n```\nResult:\n\n```json\ntrue\n```\n\n","minItems":2,"maxItems":2,"items":{"$ref":"#/components/schemas/RemapperDefinition"}},"not":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"Compare all computed remapper values against the first.\n\nReturns `false` if all entries are equal to the first entry, otherwise `true`.\n\nIf only one remapper or none is passed, the remapper value gets computed and then inverted.\n\nIf `number` in the following example is something other than 4, the condition returns `true`.\n\nInput:\n\n```json\n{\"number\":3}\n```\n```yaml\nnot:\n - prop: number\n - 4\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"match":{"type":"array","description":"Check if any case results in a truthy value.\n\nReturns the value of the first case where the condition equals true, otherwise returns null.\n\nIn the following example, let's say the `Gem` is a \"Ruby\". The match remapper then returns\n`value: 75`.\n\nInput:\n\n```json\n{\"Gem\":\"Ruby\"}\n```\n```yaml\nmatch:\n - case:\n equals:\n - prop: Gem\n - Diamond\n value: 100\n - case:\n equals:\n - prop: Gem\n - Ruby\n value: 75\n - case:\n equals:\n - prop: Gem\n - Gold\n value: 50\n - case:\n equals:\n - prop: Gem\n - Sapphire\n value: 25\n result: {}\n\n```\nResult:\n\n```json\n75\n```\n\n","items":{"type":"object","additionalProperties":false,"required":["case","value"],"description":"","properties":{"case":{"$ref":"#/components/schemas/RemapperDefinition","description":"The condition to check."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"This remapper is used if the case is true"}}}},"and":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"Compare all computed remapper values against each other.\n\nReturns `true` if all entries are equal to `true`, otherwise `false`.\n\nIf only one remapper or none is passed, the remapper value gets computed.\n\nInput:\n\n```json\n{\"foo\":true}\n```\n```yaml\nand:\n - prop: foo\n - true\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"or":{"type":"array","items":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"Compare all computed remapper values against each other.\n\nReturns `false` if all entries are equal to `false`, otherwise `true`.\n\nIf only one remapper or none is passed, the remapper value gets computed.\n\nInput:\n\n```json\n{\"foo\":true}\n```\n```yaml\nor:\n - prop: foo\n - false\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"defined":{"$ref":"#/components/schemas/RemapperDefinition","description":"Check if a value is defined. Returns `true` if defined, `false` if not.\n\nConsiders falsy values like `0`, `\"\"` and `false` as defined.\n\nThe `null` and `undefined` values are considered as not defined.\n\nInput:\n\n```json\n[0,\"\",false,null,null]\n```\n```yaml\narray.map:\n defined:\n array: item\n\n```\nResult:\n\n```json\n[true,true,true,false,false]\n```\n\n"},"variable":{"type":"string","description":"Get a predefined app variable by name\n\nFor example:\n\n```yaml\nvariable: MY_VARIABLE\n\n```\nResult:\n\n```json\n\"variable value\"\n```\n\n"},"array":{"enum":["index","length","item","prevItem","nextItem"],"description":"Get the current array.map\u2019s index, length, the current item, previous item or next item.\n\nReturns nothing when not in the context of `array.map\u2019s`.\n\nFor example:\n\nInput:\n\n```json\n[\"a\",\"b\",\"c\"]\n```\n```yaml\narray.map:\n object.from:\n index:\n array: index\n length:\n array: length\n item:\n array: item\n prevItem:\n array: prevItem\n nextItem:\n array: nextItem\n\n```\nResult:\n\n```json\n[\n {\n \"index\": 0,\n \"length\": 3,\n \"item\": \"a\",\n \"nextItem\": \"b\"\n },\n {\n \"index\": 1,\n \"length\": 3,\n \"item\": \"b\",\n \"prevItem\": \"a\",\n \"nextItem\": \"c\"\n },\n {\n \"index\": 2,\n \"length\": 3,\n \"item\": \"c\",\n \"prevItem\": \"b\"\n }\n]\n```\n\n"},"app":{"enum":["id","locale","url"],"description":"Gives information about the current app. Using this remapper you can get access to the\nfollowing information:\n\n- `id`: App ID\n- `locale`: Current locale (user selected language) of the app\n- `url`: Base URL of the app\n\nExample:\n\n```yaml\napp: url\n\n```\nResult:\n\n```json\n\"https://example-app.example-organization.example.com\"\n```\n\n"},"context":{"type":"string","description":"Gets a property from custom context passed by blocks. This property is specific to each block. To\nunderstand what the context of a certain block does, check the block\u2019s description.\n\nFor this example, we will take the [`table`](/blocks/@appsemble/table/0.20.39) block. As of now,\nthis block provides two options for context: `index` and `repeatedIndex`. Whenever you click on an\nitem in the table, it gives the index of that table row in the associated action.\n\nSo with the following example:\n\n```yaml\ntype: table\nversion: 0.20.39\nevents:\n listen:\n data: contextData\nparameters:\n fields:\n - label: Name\n value: { prop: name }\n onClick: clickName\n - label: Age\n value: { prop: age }\nactions:\n clickName:\n remapBefore:\n context: index\n type: log\n```\n\nClicking on the first item would log `0`, the second item `1` and so on.\n"},"history":{"type":"integer","description":"> **Note:** This remapper is explained more in depth in the [History](/docs/remappers/history) page\n\nGives the data at the history entry at the specified history index. The history at specified index\nis the data that is passed to that action.\n\n```yaml\nremapBefore:\n object.from:\n title: Most influential bands of all time\n content: ...\ntype: noop # history 0\nonSuccess:\n type: resource.query # history 1\n resource: people\n onSuccess:\n type: noop # history 2\n onSuccess:\n remapBefore:\n history: 1\n type: log # history 3\n```\n\nResult:\n\n```json\n{\n \"title\": \"Most influential bands of all time\",\n \"content\": ...\n}\n```\n "},"tab.name":{"enum":[null],"description":"\n\nReturns the name of the current tab in a `tabs` page.\n\n```yaml\nname: Example Page A\ntype: tabs\n tabs:\n - name: Tab2\n blocks:\n - type: action-button\n version: \"0.27.12\"\n parameters:\n icon: chevron-right\n actions:\n onClick:\n type: log\n remapBefore:\n { tab.name: null }\n```\n "},"step":{"type":"string","description":"\n\nWhile in a loop page, this remapper allows you to get properties from the data at the current index.\n\n```yaml\nname: Survey\ntype: loop\nactions:\n onLoad:\n type: resource.query\n resource: questions\nforeach:\n blocks:\n - type: detail-viewer\n version: 0.20.39\n parameters:\n fields:\n - label: { step: title }\n```\n\nWith this example, we load an array of questions that have the `title` property. What the `step`\nremapper does in this case is show the title of the current question in the loop.\n\nThe result of this is a flow page where each page shows the question\u2019s title.\n\n"},"page":{"enum":["data","url"],"description":"Gives actual information about the current page. This remapper gives access to the following\ninformation:\n\n- `data`: Current page data (FlowPage)\n- `url`: Full URL of the current page\n\nExample:\n\n```json\n{\n \"data\": {\n \"name\": \"Peter\"\n },\n \"url\": \"https://example-app.examplecompany.appsemble.app/en/example-page-a\"\n}\n```\n\nThe page data only works in the context of a flow page. Let\u2019s say you have a\n[\u201cFlowPage\u201d](/docs/reference/app#-flow-page-definition) type with multiple subpages. Whenever you\nnavigate to the next page it adds the data from that page to the flow page\u2019s data. The page remapper\nallows you to access this cumulative data.\n\nThe following page definition shows a page definition for a flow page where the user has to fill in\nsome user information. For each subpage the result of `page: data` is shown.\n\n\n```yaml\nname: PageDataFlow\ntype: flow\nsteps:\n # page: data = {}\n - blocks:\n - type: form\n version: 0.20.39\n parameters:\n fields:\n - name: name\n type: string\n actions:\n onSubmit:\n type: flow.next\n # page: data = { name: \"Peter\" }\n - blocks:\n - type: form\n version: 0.20.39\n parameters:\n fields:\n - name: age\n type: string\n actions:\n onSubmit:\n type: flow.next\n # page: data = { name: \"Peter\", age: \"47\" }\n - blocks:\n - type: data-loader\n version: 0.20.39\n actions:\n onLoad:\n remapBefore:\n page: data\n type: log\n```\n\nThe result of the final page\u2019s log would then be:\n\n```json\n{\n \"name\": \"Peter\",\n \"age\": \"47\"\n}\n```\n\n"},"prop":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ObjectRemapperDefinition"}},{"$ref":"#/components/schemas/ObjectRemapperDefinition"}],"description":"Gets the chosen property from an object.\n\nInput:\n\n```json\n{\"age\":52,\"name\":\"John\"}\n```\n```yaml\nprop: name\n\n```\nResult:\n\n```json\n\"John\"\n```\n\n"},"len":{"enum":[null],"description":"\nReturns the length of an input array or an input string, unlike { array: length } remapper this remapper does not require\nan array to be in the context. This can be very useful when working with nested arrays.\nInput:\n\n```json\n\"string\"\n```\n```yaml\nlen: null\n\n```\nResult:\n\n```json\n6\n```\n\n"},"root":{"enum":[null],"description":"Gets the input data as it was initially passed to the remapper function.\n\n```yaml\ntype: resource.query\nresource: people\nquery:\n object.from:\n $filter: city eq 'Eindhoven'\nonSuccess:\n remapBefore:\n object.from:\n name: Residents of Eindhoven\n people:\n root: null\n```\n\nResult:\n\n```json\n{\n \"name\": \"Residents of Eindhoven\",\n \"people\": [\n {\n \"name\": ...,\n \"city\": \"Eindhoven\"\n },\n ...\n ]\n}\n```\n "},"static":{"description":"Create a static value\n\n```yaml\nstatic: Hello!\n\n```\nResult:\n\n```json\n\"Hello!\"\n```\n\n"},"translate":{"$ref":"#/components/schemas/RemapperDefinition","description":"> **Note:** This is explained much more in depth at [Translating](/docs/guides/translating)\n\nThis remapper allows you to easily add translations to your app. To make this remapper work, replace\nany static text with `translate: {name}`. Then, in your app\u2019s Translations page pick the language\nyou want to translate. You will see a list of names with input text below. Translations you manually\nput in the app using the `translate` remapper are found under \u201cCustom messages\u201d.\n\nAfter putting the translation in, any user that logs in with that language selected will see the\ntranslated message.\n\nExample:\n\n```yaml\ntype: detail-viewer\nversion: 0.20.39\nparameters:\n fields:\n - label: { translate: weatherTitle }\n value: { translate: weatherBody }\n```\n\n"},"app.member":{"enum":["sub","name","email","email_verified","picture","locale","zoneinfo","role","properties"],"description":"\n> **Note:** For this remapper to work, the app member that activated the remapper has to be logged in to\n> the app\n\nProvides some fields of app member information taken from the OpenID user info. These fields are:\n\n- `sub`: The app member\u2019s identifier\n- `name`: The app member\u2019s name\n- `email`: The app member\u2019s **primary** email address\n- `email_verified`: Whether the app member\u2019s primary email address is verified or not (`boolean`)\n- `picture`: Full URL to the app member\u2019s profile picture web address\n- `locale`: The app member\u2019s default language [`BCP47`](https://en.wikipedia.org/wiki/IETF_language_tag)\n language tag (ex. `en`) (Broken)\n- `zoneinfo`: The app member\u2019s timezone\n- `role`: The role of the app member in the app\n- `properties`: Custom properties defined on the app member\n\nExample:\n\n```json\n{\n \"email\": \"[email protected]\",\n \"email_verified\": true,\n \"locale\": \"en\",\n \"name\": \"Test User\",\n \"picture\": \"https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp\",\n \"sub\": \"5c6270e2-ad31-414f-bcab-6752a2c4dcfd\",\n \"properties\": {}\n}\n```\n "},"container":{"type":"string","description":"\n> **Note:** For this remapper to work, the application needs to define a companion container.\n\nThis remapper provides a short way to access a companion container for the purpose of making http requests.\nWhen using the 'request' action, the url can be provided by using the 'container' remapper, and providing a string.\nThe string should contain the name of the companion container, followed by the API endpoint path.\n\nExample:\n```yaml\n type: request\n url: { container: my-container/api/endpoint }\n proxy: true\n method: get\n```\n "},"slice":{"description":"Extract characters from a string, or items from an array\naccepts either an array of two numbers (indexes of starting point and ending point)\nor a number (index of the starting point).\nstartIndex is inclusive whereas the endIndex is not.\nInput:\n\n```json\n\"Laziness\"\n```\n```yaml\nslice:\n - 3\n - 6\n\n```\nResult:\n\n```json\n\"ine\"\n```\n","oneOf":[{"type":"array","items":{"type":"number"}},{"type":"number"}]},"date.add":{"type":"string","description":"Adds a specified date value to the provided date.\n\nThe value to add should be specified according to the\n[parse-duration](https://www.npmjs.com/package/parse-duration) API. If you want to add a day to a\ndate for example, the syntax would be `date.add: 1d`.\n\nFull list of supported unit types:\n- nanoseconds (ns)\n- microseconds (\u03bcs)\n- milliseconds (ms)\n- seconds (s, sec)\n- minutes (m, min)\n- hours (h, hr)\n- days (d)\n- weeks (w, wk)\n- months\n- years (y, yr)\n\nFor example:\n\nInput:\n\n```json\n\"2023-06-30T14:50:19.601Z\"\n```\n```yaml\n- date.now: null\n- date.add: 1w\n- date.format: null\n\n```\nResult:\n\n```json\n\"2023-07-07T14:50:19.601Z\"\n```\n\n"},"date.format":{"oneOf":[{"enum":[null]},{"type":"string"}],"description":"Format a date according to the RFC3339 format.\n\nHere is an example of a RFC3339 complicit date:\n`2002-10-02T15:00:00Z`\n\nIn an app definition, it\u2019s best to use this when you want to display a date in a specific format.\nFor example, if your app has a form with a Datepicker field the incoming data will be formatted\nas a simple date format. If you want to format it to the RFC3339 format, you can use this remapper.\n\nWhen you submit a form with a DateField, the internal output looks like the following. You can then format the date so that it uses the RFC3339 format.\n\nInput:\n\n```json\n\"2023-07-03\"\n```\n```yaml\ndate.format: null\n\n```\nResult:\n\n```json\n\"2023-07-02T22:00:00.000Z\"\n```\n\n\nThe remapper can also be used to format a date or timestamp using a custom format.\n\n```js\n\"2023-07-02T22:00:00.000Z\"\n```\n\nYou can then format the date with any supported pattern, please refer to https://date-fns.org/docs/format for the supported patterns.\n\n```yaml\ndate.format: yyyy-MM-dd\n```\n\nResult:\n```js\n2023-07-03\n```\n"},"date.now":{"enum":[null],"description":"Returns the current date as a JavaScript Date object.\n\n```yaml\ndate.now: null\n\n```\nResult:\n\n```json\n\"Mon Jul 03 2023 11:47:18 GMT+0200 (Midden-Europese zomertijd)\"\n```\n\n"},"date.parse":{"type":"string","description":"Convert a string to a date using a given format.\n\nFor example:\n\n```yaml\ndate.parse: MM/dd/yyyy\n\n```\nResult:\n\n```json\n\"Tue Feb 11 2014 00:00:00\"\n```\n\n\nSee [date-fns](https://date-fns.org/v2.29.3/docs/parse) for the supported formats.\n\nLeaving the format empty will try to parse the date using the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\nFor example:\n```yaml\ndate.parse:\n- static: 2014-02-11T11:30:30 # The date string to parse\n- date.parse: '' # The given format to parse the date with\n # => Tue Feb 11 2014 11:30:30\n```\n"},"from.history":{"type":"object","required":["index","props"],"description":"Creates a new object based on the specified properties in the given history index. This can be very\nuseful when you want to combine two sources of data together. It\u2019s also cleaner than separately\nusing `object.from` together with `history`.\n\nIn the following example, you can see why this might be handy. Let\u2019s say you get the details about a\nconcert from a source like an action or a block. You have this information and then you want to get\nsome additional data like the attendees of the concert. With `from.history` you can combine the\nolder data like the name and date, and add the new `attendees` data. The result will be an object\nwith this combined data.\n\nHistory index 1:\n\n```json\n{\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"price\": 120\n}\n```\n\nInput:\n\n```json\n[ .. ]\n```\n\n```yaml\nobject.from:\n concertDetails:\n from.history:\n index: 1\n props:\n name: { prop: name }\n date: { prop: date }\n attendees: { root: null }\n```\n\nResult:\n\n```json\n{\n \"concertDetails\": {\n \"attendees\": [ .. ],\n \"date\": \"07-07-2022\",\n \"name\": \"Rolling stones at Amsterdam Arena\"\n }\n}\n```\n","additionalProperties":false,"properties":{"index":{"type":"integer","description":"The index of the history stack item to assign.\n\n0 is the index of the first item in the history stack.\n"},"props":{"description":"Predefined mapper keys to choose what properties to apply.","additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"}}}},"assign.history":{"type":"object","required":["index","props"],"description":"Assigns properties from the specified history stack index to an existing object.\nSimilarly to the `from.history` remapper, this allows you to get a property from a place in the\nhistory and give it to a new object. The only difference here is that you are not creating an\nentirely new object, but you are taking an existing object and assigning new values to it.\n\nSo, we can take the example from `from.history` and flip it.\n\nHistory index 1:\n\n```json\n{\n \"peopleAmount\": 3000\n}\n```\n\nInput:\n\n```json\n{\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"price\": 120\n}\n```\n\n```yaml\nobject.from:\n concertDetails:\n assign.history:\n index: 1\n props:\n attendees: { prop: peopleAmount }\n```\n\nResult:\n\n```json\n{\n \"concertDetails\": {\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"price\": 120,\n \"attendees\": 3000\n }\n}\n```\n","additionalProperties":false,"properties":{"index":{"type":"integer","description":"The index of the history stack item to assign.\n\n0 is the index of the first item in the history stack.\n"},"props":{"description":"Predefined mapper keys to choose what properties to assign.","additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"}}}},"omit.history":{"type":"object","required":["index","keys"],"description":"Assigns properties from the specified history stack index to the current value and excludes the\ngiven properties.\n\nSimilarly to the other history remappers, this gives you the data from a certain point in the\nhistory stack and allows you to modify it before adding to the current value. This one, however,\nallows you to take the complete specified history data and omit certain values.\n\nThis remapper can be extremely helpful for re-using data you got before in the history stack while\nfiltering certain properties.\n\nFor example, let\u2019s say you have the information for a concert but don\u2019t want normal users to see\nsensitive data about it. Using `omit.history` you can take this concert data but exclude the\nsensitive parts.\n\nHistory index 1:\n\n```json\n{\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"bandPasswords\": [ .. ],\n \"bankDetailsAttendees\": [ .. ]\n}\n```\n\nInput:\n\n```json\n[ .. ]\n```\n\n```yaml\nobject.from:\n concertDetails:\n omit.history:\n index: 1\n keys:\n - bandPasswords\n - bankDetailsAttendees\n```\n\nResult:\n\n```json\n{\n \"concertDetails\": {\n \"name\": \"Rolling stones at Amsterdam Arena\",\n \"artist\": \"Rolling Stones\",\n \"location\": \"Amsterdam Arena\",\n \"date\": \"07-07-2022\",\n \"attendees\": [ .. ]\n }\n}\n```\n","additionalProperties":false,"properties":{"index":{"type":"integer","description":"The index of the history stack item to assign.\n\n0 is the index of the first item in the history stack.\n"},"keys":{"description":"Exclude properties from the history stack item, based on the given object keys.\n\nNested properties can be excluded using arrays of keys.\n\nFor example:\n```yaml\nomit.history:\n index: 0\n keys:\n - foo # Excludes the property foo\n - - bar # Excludes the property baz inside of bar\n - baz\n```\n","type":"array","items":{"minItems":1,"anyOf":[{"type":"string"},{"type":"array","minItems":2,"items":{"type":"string"}}]}}}},"number.parse":{"anyOf":[{"enum":[null]},{"type":"string"},{"$ref":"#/components/schemas/ArrayRemapperDefinition"},{"$ref":"#/components/schemas/ObjectRemapperDefinition"}],"description":"Convert a string into a number.\n\nIf there is no remapper passed and the input can be converted, this will return the converted input.\n\nIf there is no remapper passed and the input is null, this will return 0.\n\nIf there is no remapper passed and the input cannot be converted, this will return the input.\n\nIf there is a remapper passed and the remapped value can be converted, this will return the converted remapped value.\n\nIf there is a remapper passed and the remapped value is null, this will return 0.\n\nIf there is a remapper passed and the remapped value cannot be converted, this will return the remapped value.\n\nFor example:\n\nInput:\n\n```json\n\"42\"\n```\n```yaml\nnumber.parse: null\n\n```\nResult:\n\n```json\n42\n```\n\n"},"object.assign":{"additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\n\nLet\u2019s say you have an existing object that you want to add an additional value on top of. For this\nyou can use the `object.assign` remapper. The remapper takes an existing object and allows the user\nto assign their own value on top of that.\n\nInput:\n\n```json\n{\"title\":\"Weekly fishing 21\"}\n```\n```yaml\nobject.assign:\n author: John Doe\n\n```\nResult:\n\n```json\n{\"author\":\"John Doe\",\"title\":\"Weekly fishing 21\"}\n```\n\n\n"},"object.from":{"additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"},"description":"\n\nWith this remapper you can create an entirely new object based on input values and other remappers.\n`object.from` itself accepts remapper functions as its input which allows you to chain multiple\nremappers together to make complex objects.\n\nAs a base, the remapper looks like this:\n\n```yaml\nobject.from:\n email: [email protected]\n username: Chris Taub\n\n```\nResult:\n\n```json\n{\"email\":\"[email protected]\",\"username\":\"Chris Taub\"}\n```\n\n\nMost of the time you won\u2019t create an object just to store one value. Luckily, this is where the\nchaining of remappers comes in. You can create an object that contains an `object.from` remapper\nwhich then allows more inputs:\n\n```yaml\nobject.from:\n username: Chris Taub\n email: [email protected]\n addresses:\n object.from:\n work:\n object.from:\n city: Eindhoven\n address: Nachtegaallaan 15\n home:\n object.from:\n city: Amsterdam\n address: Amstel 1\n```\n\n```json\n{\n \"username\": \"Chris Taub\",\n \"email\": \"[email protected]\",\n \"addresses\": {\n \"work\": {\n \"city\": \"Eindhoven\",\n \"address\": \"Nachtegaallaan 15\"\n },\n \"home\": {\n \"city\": \"Amsterdam\",\n \"address\": \"Amstel 1\"\n }\n }\n}\n```\n\n"},"object.omit":{"type":"array","items":{"minItems":1,"anyOf":[{"type":"string"},{"type":"array","minItems":2,"items":{"type":"string"}}]},"description":"\n\nIn contrary to the previous remapper, what if you have an object from which you want to remove a\nvalue? Then you can use `object.omit`. The remapper can remove properties from an existing object\nbased on the given object keys. This includes nested properties.\n\nInput:\n\n```json\n{\n \"author\": \"John Doe\",\n \"content\": {\n \"interview\": \"...\",\n \"introduction\": \"This is the introduction for the new weekly fishing issue\",\n \"paragraph1\": \"...\"\n },\n \"title\": \"Weekly fishing 21\"\n}\n```\n```yaml\nobject.omit:\n - author\n - - content\n - interview\n\n```\nResult:\n\n```json\n{\n \"content\": {\n \"introduction\": \"This is the introduction for the new weekly fishing issue\",\n \"paragraph1\": \"...\"\n },\n \"title\": \"Weekly fishing 21\"\n}\n```\n\n"},"object.compare":{"type":"array","items":{"minItems":2,"maxItems":2,"$ref":"#/components/schemas/RemapperDefinition"},"description":"\n\nThis remapper allows you to compare two objects and get differences in their key-value pairs like in the following example:\n\nInput:\n\n```json\n{\n \"name\": \"Alice\"\n}\n```\n```yaml\nobject.compare:\n - object.from:\n name:\n prop: name\n age: 25\n address:\n object.from:\n city: Paris\n zip: 7500\n favoriteColors:\n array.from:\n - blue\n - green\n - object.from:\n name: Alice\n age: 26\n address:\n object.from:\n city: Lyon\n country: France\n favoriteColors:\n array.from:\n - red\n - green\n - blue\n\n```\nResult:\n\n```json\n[\n {\n \"path\": [\n \"age\"\n ],\n \"type\": \"changed\",\n \"from\": 25,\n \"to\": 26\n },\n {\n \"path\": [\n \"favoriteColors\"\n ],\n \"type\": \"changed\",\n \"from\": [\n \"blue\",\n \"green\"\n ],\n \"to\": [\n \"red\",\n \"green\",\n \"blue\"\n ]\n },\n {\n \"path\": [\n \"address\",\n \"city\"\n ],\n \"type\": \"changed\",\n \"from\": \"Paris\",\n \"to\": \"Lyon\"\n },\n {\n \"path\": [\n \"address\",\n \"zip\"\n ],\n \"type\": \"removed\",\n \"value\": 7500\n },\n {\n \"path\": [\n \"address\",\n \"country\"\n ],\n \"type\": \"added\",\n \"value\": \"France\"\n }\n]\n```\n\n"},"object.explode":{"type":"string","description":"\n\nTakes an object with an array property and transforms it into an array of objects.\n\nEach object in the resulting array contains all the entries of the original object\nplus all the entries of the corresponding array item from the array property.\n\nIf one of the items in the array contains a key, which exists in the original object\nit will overwrite the original key.\n\nNested arrays or objects are not exploded.\n\nExample:\nInput:\n\n```json\n{\n \"ownerName\": \"John\",\n \"country\": \"USA\",\n \"pets\": [\n {\n \"name\": \"Milka\"\n },\n {\n \"name\": \"Sven\",\n \"country\": \"Sweden\"\n },\n {\n \"name\": \"Tom\",\n \"likes\": [\n \"mice\",\n \"fish\"\n ]\n },\n {\n \"name\": \"Jerry\",\n \"looks\": {\n \"color\": \"brown\"\n }\n }\n ]\n}\n```\n```yaml\nobject.explode: pets\n\n```\nResult:\n\n```json\n[\n {\n \"ownerName\": \"John\",\n \"name\": \"Milka\",\n \"country\": \"USA\"\n },\n {\n \"ownerName\": \"John\",\n \"name\": \"Sven\",\n \"country\": \"Sweden\"\n },\n {\n \"ownerName\": \"John\",\n \"name\": \"Tom\",\n \"country\": \"USA\",\n \"likes\": [\n \"mice\",\n \"fish\"\n ]\n },\n {\n \"ownerName\": \"John\",\n \"name\": \"Jerry\",\n \"country\": \"USA\",\n \"looks\": {\n \"color\": \"brown\"\n }\n }\n]\n```\n\n"},"filter.from":{"additionalProperties":{"$ref":"#/components/schemas/FilterParametersDefinition"},"description":"\n\nWith this remapper you can generate an OData filter, ready to be passed to the `$filter` key in\nresource queries.\n\nThe different comparator options are as follows:\n\n- eq - Equal to\n- ne - Not equal to\n- lt - Less than\n- gt - Greater than\n- le - Less than or equal to\n- ge - Greater than or equal to\n\nThe most common types of values are `String`, `Number`, `Boolean` and `Date`. If you need a more specific\ntype, please refer to [the OData spec](https://www.odata.org/documentation/odata-version-2-0/overview/).\n\nAs a base, the remapper looks like this:\n\nInput:\n\n```json\n{\"exclude\":\"Peter\"}\n```\n```yaml\nfilter.from:\n name:\n type: String\n comparator: ne\n value:\n prop: exclude\n age:\n type: Number\n comparator: lt\n value: 10\n height:\n type: Number\n comparator: le\n value: 1.75\n heightString:\n type: Number\n comparator: le\n value: \"1.75\"\n birthday:\n type: Date\n comparator: ge\n value: 2000-01-01\n friendsSince:\n type: Date\n comparator: ge\n value: 2014-01-01T00:00:00Z\n job:\n type: String\n comparator: eq\n value: null\n employed:\n type: Boolean\n comparator: eq\n value: false\n id:\n type: Guid\n comparator: eq\n value: 03a0a47b-e3a2-e311-9402-00155d104c24\n undefined:\n type: String\n comparator: eq\n special:\n type: String\n comparator: eq\n value: Special character's \"test\" \\%&+?^/\n\n```\nResult:\n\n```json\n\"name ne 'Peter' and age lt 10 and height le 1.75 and heightString le 1.75 and birthday ge 2000-01-01 and friendsSince ge 2014-01-01T00:00:00Z and job eq null and employed eq false and id eq 03a0a47b-e3a2-e311-9402-00155d104c24 and undefined eq null and special eq 'Special character''s \\\"test\\\" \\\\\\\\%&+?^/'\"\n```\n\n\nHere is an example of how you can use the remapper in an app definition:\n\n```yaml\ntype: resource.query\n resource: myResource\n query:\n object.from:\n $filter:\n filter.from:\n name:\n type: String\n comparator: ne\n value: { prop: exclude }\n age:\n type: Int64\n comparator: lt\n value: 10\n birthday:\n type: Date\n comparator: ge\n value: '2000-01-01'\n job:\n type: String\n comparator: eq\n value: null\n employed:\n type: Boolean\n comparator: eq\n value: false\n special:\n type: String\n comparator: eq\n value: \"Special character's test\"\n```\n"},"order.from":{"additionalProperties":{"enum":["asc","desc"]},"description":"\n\nWith this remapper you can generate an OData order, ready to be passed to the `$orderby` key in\nresource queries.\n\nThe different order options are as follows:\n\n- asc - Ascending\n- desc - Descending\n\n```yaml\norder.from:\n name: asc\n age: desc\n\n```\nResult:\n\n```json\n\"name asc,age desc\"\n```\n\n\nHere is an example of how you can use the remapper in an app definition:\n\n```yaml\ntype: resource.query\n resource: myResource\n query:\n object.from:\n $orderby:\n order.from:\n name: asc\n age: desc\n```\n"},"random.choice":{"enum":[null],"description":"Pick and return a random entry from an array. If the input is not an array, the input is returned as-is.\nFor example:\n\nIf you input the following array:\n```json\n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]\n```\n\n```yaml\nrandom.choice: null\n```\n\nThe result could return any one of these numbers.\n\nYou can also combine different data types in this array and have it work in the same way. If mixed in\nstrings, the result could be either one of the provided numbers or one of the provided strings.\n\n```json\n[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, \"Peter\", \"Patrick\", \"Michael\", \"Harry\"]\n```\n"},"random.integer":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"integer"},"description":"Pick and return a random integer between the provided lowest and highest values.\nFor example:\n```yaml\nrandom.integer:\n - 0\n - 1000\n```\n\nReturns a random integer between 0 and 1000.\n"},"random.float":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"},"description":"Pick and return a random float value between the provided lowest and highest values.\nFor example:\n```yaml\nrandom.float:\n - 0\n - 1\n```\n\nReturns a random float value between 0 and 1.\n"},"random.string":{"type":"object","required":["choice","length"],"additionalProperties":false,"properties":{"choice":{"type":"string","minLength":1},"length":{"type":"integer","minimum":1}},"description":"Pick and return a random string from a given length using characters from a given input string defined in `choice`.\nFor example:\n```yaml\nrandom.string:\n choice: abcdefghijklmnopqrstuvwxyz0123456789\n length: 6\n```\n\nReturns a randomized string that is 6 characters long and consists of any characters in the `choice` field, like: `g8ajss9`.\n"},"string.case":{"enum":["lower","upper"],"description":"Convert a string to upper or lower case.\n\nInput:\n\n```json\n\"Patrick\"\n```\n```yaml\nstring.case: upper\n\n```\nResult:\n\n```json\n\"PATRICK\"\n```\n\n"},"string.startsWith":{"type":"string","description":"Check if the initial characters of the string matches with the input string,\nthis remapper is case-sensitive.\nInput:\n\n```json\n\"Random string here\"\n```\n```yaml\nstring.startsWith: Random\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"string.endsWith":{"oneOf":[{"type":"string"},{"type":"object","description":"Alternative way to define input to facilitate the case-insensitive matching","required":["substring"],"additionalProperties":false,"properties":{"substring":{"type":"string"},"strict":{"type":"boolean"}}}],"description":"Check if the last characters of the string matches with the input string,\nthis remapper is case-sensitive unless specified explicitly,\nTo make the remapper ignore casing of the input and passed string, use the following example\nInput:\n\n```json\n\"Random string here\"\n```\n```yaml\nstring.endsWith:\n substring: Here\n strict: false\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"string.format":{"type":"object","additionalProperties":false,"properties":{"messageId":{"$ref":"#/components/schemas/RemapperDefinition","description":"The message id pointing to the template string to format."},"template":{"type":"string","description":"The template default string to format."},"values":{"description":"A set of remappers to convert the input to usable values.","additionalProperties":{"$ref":"#/components/schemas/RemapperDefinition"}}},"description":"Format a string using remapped input variables.\nUseful for replacing static text with generated values.\n\nInput:\n\n```json\n{\"lotteryPrize\":\"5000\"}\n```\n```yaml\nstring.format:\n template: You have won \u20ac{lotteryAmount} in the lottery!!\n values:\n lotteryAmount:\n prop: lotteryPrize\n\n```\nResult:\n\n```json\n\"You have won \u20ac5000 in the lottery!!\"\n```\n\n\n> **Tip:** Considering this can be inserted anywhere a remapper is accepted. You can also use this\n> to choose specific URL\u2019s more accurately.\n\n"},"string.replace":{"type":"object","minProperties":1,"maxProperties":1,"additionalProperties":{"type":"string"},"description":"\nUses RegEx to find a value in a string and replace it with a given value.\n\nInput:\n\n```json\n\"Eindhoven is the best city in the Netherlands\"\n```\n```yaml\nstring.replace:\n (best*)\\w+: cleanest\n\n```\nResult:\n\n```json\n\"Eindhoven is the cleanest city in the Netherlands\"\n```\n\n"},"string.contains":{"type":"string","description":"\nChecks if the provided string is a substring of the input string.\nInput:\n\n```json\n\"Input string\"\n```\n```yaml\nstring.contains: string\n\n```\nResult:\n\n```json\ntrue\n```\n\n"},"ics":{"type":"object","description":"Create a calendar event. This event can be downloaded as an `.ics` file and\nuploaded to your agenda using the [download](../reference/action#download) action.\n\nFor example, the following input:\n```yaml\nics:\ncoordinates\n object.from:\n latitude: 38.897700545442646\n longitude: -77.03655660152435\ndescription: \"Sprint planning meeting\"\nduration: 1d\nend: 2023-07-19\nlocation: The Oval Office.\nstart: 2023-07-18\ntitle: Important Meeting\nurl: https://google.nl\n```\n\nCreates the following ICS-formatted object:\n```\nBEGIN:VCALENDAR\nVERSION:2.0\nCALSCALE:GREGORIAN\nPRODID:http://remappers.appsemble.localhost:9999\nMETHOD:PUBLISH\nX-PUBLISHED-TTL:PT1H\nBEGIN:VEVENT\nUID:b8TsbczhfpIxPM-3lNHQz\nSUMMARY:Important Meeting\nDTSTAMP:20230703T102029Z\nDTSTART:20230717T220000Z\nDTEND:20230718T220000Z\nDESCRIPTION:Sprint planning meeting\nURL:https://google.nl\nGEO:38.897700545442646;-77.03655123710632\nLOCATION:The Oval Office.\nEND:VEVENT\nEND:VCALENDAR\n```\n","additionalProperties":false,"required":["start","title"],"properties":{"start":{"$ref":"#/components/schemas/RemapperDefinition","description":"The start of the icalendar event."},"end":{"$ref":"#/components/schemas/RemapperDefinition","description":"The end of the icalendar event."},"duration":{"$ref":"#/components/schemas/RemapperDefinition","description":"The duration of the event.","example":"1w 3d 10h 30m"},"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title of the event."},"description":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional description of the event."},"url":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional link to attach to the event."},"location":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional location description to attach to the event."},"coordinates":{"$ref":"#/components/schemas/RemapperDefinition","description":"An optional geolocation description to attach to the event.\n\n This must be an object with the properties `lat` or `latitude`, and `lon`, `lng` or `longitude`."}}},"null.strip":{"description":"Strip all null, undefined, and empty array values from an object or array.\nFor example, with the following input value:\n```json\n[0, 4, null, null, \"Peter\", 0.4234, null]\n```\n```yaml\nnull.strip: null\n```\n\nThe null values will be removed, leaving a dense array:\n```json\n[0, 4, \"Peter\", 0.4234]\n```\n\nInstead of giving it `null` as option, you can also provide a `depth` property to specify how\ndeep to recurse into the object or array to remove null values.\n\nFor example, with the following input:\n```json\n{\n 0: [0, null, \"Peter\"],\n 1: {\n \"array1\": [4, null, 0.4234, null]\n }\n}\n```\n\nYou can specify to which degree of depth you want the null values to be removed.\nWith this remapper definition:\n```yaml\nnull.strip:\n depth: 2\n```\n\nIt will only check two objects in for any null values. That means only the first array within the\nobject will be checked. The result looks like this:\n```json\n{\n 0: [0, \"Peter\"],\n 1: {\n \"array1\": [4, null, 0.4234, null]\n }\n}\n```\n","anyOf":[{"enum":[null]},{"type":"object","required":["depth"],"additionalProperties":false,"description":"Options for the null.strip remapper.","properties":{"depth":{"type":"integer","minimum":1,"description":"How deep to recurse into objects and arrays to remove null values."}}}]},"type":{"enum":[null],"description":"Returns the type of the input object\n\nFor example, with the following input value:\n```json\n[0, 5, 7, 8]\n```\n```yaml\ntype: null\n```\n\nThe result will be:\n```json\n\"array\"\n```\n "},"log":{"enum":["info","warn","error"],"description":"Logs in the browser's console and returns the incoming data and the remapper function's context.\n\nThe context contains relevant info about the app, like the URL and locale, but also contains the\nremapper\u2019s history.\n\nThe options represent the level of logging that will show in the console.\n\n- `input`: The input data going into this remapper,\n- `context`:\n - `root`: The input data going into this remapper,\n - `appId`: ID of the application,\n - `url`: Absolute URL of the page where the remapper was fired,\n - `appUrl`: Base URL of the application,\n - `pageData`: Current page data of a FlowPage (See [page remapper](./data#page)),\n - `userInfo`: User's information if they are logged in (See [user remapper](./data#user)),\n - `context`: Internal context\n - `history`: Complete list of this remapper\u2019s history (See [history remapper](./history))\n - `locale`: The user\u2019s locale,\n - `stepRef`: In a loop page, gives the properties from the loop\u2019s current data index (See [step remapper](./data#step))\n\nFor example:\n\n```json\n{\n \"input\": {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n },\n \"context\": {\n \"root\": {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n },\n \"appId\": 49,\n \"url\": \"http://remappers.appsemble.localhost:9999/en/other\",\n \"appUrl\": \"http://remappers.appsemble.localhost:9999\",\n \"pageData\": {\n \"triedAppsemble\": false\n },\n \"userInfo\": {\n \"email\": \"[email protected]\",\n \"email_verified\": true,\n \"name\": \"Example User 1\",\n \"picture\": \"https://www.gravatar.com/avatar/f46b82357ce29bcd1099915946cda468?s=128&d=mp\",\n \"sub\": \"0000-0000-0000-0000\",\n \"locale\": \"en\",\n \"zoneinfo\": \"Europe/Amsterdam\"\n },\n \"context\": {},\n \"history\": [\n [\n 0,\n 4,\n null,\n null,\n \"Peter\",\n 0.4234,\n null\n ],\n {\n \"name\": \"Peter\",\n \"age\": 49\n },\n {\n \"name\": \"Peter\",\n \"age\": 49,\n \"birthday\": \"07-08-2023\"\n }\n ],\n \"locale\": \"en\",\n \"stepRef\": {\n \"current\": {\n \"answerType\": \"multiple choice\",\n \"question\": \"How much do you enjoy working here?\"\n }\n }\n }\n}\n```\n"},"xml.parse":{"description":"This can be used to parse an xml string into an object\n\nFor example:\n\nInput:\n\n```json\n{\"xml\":\"\\n<obj>\\n <foo>bar</foo>\\n <item foo=\\\"bar\\\">\\n <item foo=\\\"bar\\\">\\n <text>text</text>\\n </item>\\n </item>\\n <item bar=\\\"baz\\\">\\n <item bar=\\\"baz\\\">\\n <text>text 2</text>\\n </item>\\n </item>\\n <item>\\n <item foo=\\\"bar\\\">\\n <item foo=\\\"bar\\\">\\n <text>text</text>\\n </item>\\n </item>\\n <item bar=\\\"baz\\\">\\n <item bar=\\\"baz\\\">\\n <text>text 2</text>\\n </item>\\n </item>\\n </item>\\n</obj>\\n\"}\n```\n```yaml\nxml.parse:\n prop: xml\n\n```\nResult:\n\n```json\n{\n \"obj\": {\n \"foo\": \"bar\",\n \"item\": [\n {\n \"foo\": \"bar\",\n \"item\": {\n \"foo\": \"bar\",\n \"text\": \"text\"\n }\n },\n {\n \"bar\": \"baz\",\n \"item\": {\n \"bar\": \"baz\",\n \"text\": \"text 2\"\n }\n },\n {\n \"item\": [\n {\n \"foo\": \"bar\",\n \"item\": {\n \"foo\": \"bar\",\n \"text\": \"text\"\n }\n },\n {\n \"bar\": \"baz\",\n \"item\": {\n \"bar\": \"baz\",\n \"text\": \"text 2\"\n }\n }\n ]\n }\n ]\n }\n}\n```\n","$ref":"#/components/schemas/RemapperDefinition"},"maths":{"description":"This can be used to perform a mathematical operation on two numbers\n\nFor example:\n\nInput:\n\n```json\n{\"version\":0}\n```\n```yaml\nmaths:\n a:\n prop: version\n b:\n static: 1\n operation: add\n\n```\nResult:\n\n```json\n1\n```\n","additionalProperties":false,"properties":{"a":{"$ref":"#/components/schemas/RemapperDefinition"},"b":{"$ref":"#/components/schemas/RemapperDefinition"},"operation":{"enum":["add","divide","mod","multiply","subtract"]}}}}},"Organization":{"type":"object","description":"An organization groups a set of users, apps, themes, and permissions together","required":["id"],"additionalProperties":false,"properties":{"id":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","minLength":1,"maxLength":30,"description":"The unique identifier for the organization."},"name":{"type":"string","description":"The display name for the organization."},"description":{"type":"string","description":"The description of the organization.","maxLength":160},"email":{"type":"string","description":"The email address of the organization."},"website":{"type":"string","description":"The website of the organization."},"iconUrl":{"type":"string","description":"The URL used to fetch the organization\u2019s icon."}}},"OrganizationMember":{"type":"object","description":"A member of an organization.","required":["id"],"additionalProperties":false,"properties":{"id":{"$ref":"#/components/schemas/User/properties/id"},"name":{"$ref":"#/components/schemas/User/properties/name"},"primaryEmail":{"type":"string","format":"email","description":"The primary email address of the user."},"role":{"enum":["Member","AppTranslator","AppContentsExplorer","AppContentsManager","AppMemberManager","AppGroupManager","AppGroupMembersManager","AppManager","AppCollectionManager","BlockManager","Maintainer","Owner"]},"properties":{"type":"object","description":"Additional custom properties that a user might have.","additionalProperties":{"type":"string"}}}},"PageActionsDefinition":{"type":"object","description":"Action fired on page events","additionalProperties":false,"properties":{"onLoad":{"$ref":"#/components/schemas/ActionDefinition","description":"This action is fired when a page loads, highly helpful in loading data for the page"}}},"PageDefinition":{"type":"object","additionalProperties":false,"description":"The list of blocks that are displayed on the page.\n\nEach page requires at least one block. Blocks are displayed in the order that they are defined in\nthe list.\n","required":["blocks","name"],"properties":{"blocks":{"type":"array","minItems":1,"description":"The blocks that make up a page.","items":{"$ref":"#/components/schemas/BlockDefinition"}},"actions":{"$ref":"#/components/schemas/PageActionsDefinition"},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn\u2019t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren\u2019t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"},"badgeCount":{"$ref":"#/components/schemas/RemapperDefinition","description":"A Remapper that resolves to a number to be visibile in the side-menu."}}},"Rating":{"type":"object","description":"A representation of an App rating.","additionalProperties":false,"required":["rating"],"properties":{"rating":{"type":"number","minimum":1,"maximum":5,"description":"A value ranging from 1 to 5 stars rating of the App."},"description":{"type":"string","description":"An optional explanation of the given rating."},"name":{"$ref":"#/components/schemas/User/properties/name","readOnly":true,"description":"The name of the user who submitted the rating."}}},"RemapperDefinition":{"anyOf":[{"type":"boolean","description":"A boolean remapper is always returned directly."},{"enum":[null],"description":"A null remapper is always returned directly."},{"type":"number","description":"A numeric remapper is always returned directly."},{"type":"string","description":"A string remapper is always returned directly."},{"$ref":"#/components/schemas/ObjectRemapperDefinition"},{"$ref":"#/components/schemas/ArrayRemapperDefinition"}]},"RequestActionDefinition":{"type":"object","additionalProperties":false,"required":["type","url"],"properties":{"type":{"enum":["request"],"description":"Performs an HTTP request.\n\nThis can be used to call the Appsemble API or an external API in order to fetch data or send data.\nWhen sending `POST`, `PUT`, `DELETE` and `PATCH` calls the data that is currently available\nin the block gets passed through.\n\nIf the content type of the request is `text/xml` or `application/xml`, the data will be\nconverted to JSON.\n"},"url":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in the URL to send the request to.\n\nCan be a relative URL (E.g. `/api/health`) for usage with the Appsemble API, or an absolute URL\n(E.g. `https://example.com`) for usage with external sites."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Resource":{"type":"object","additionalProperties":true,"description":"A resource can be anything defined as described in an app resource definition.","properties":{"id":{"type":"number","readOnly":true},"$clonable":{"type":"boolean"},"$ephemeral":{"type":"boolean"},"$expires":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string","pattern":"^(\\d+(y|yr|years))?\\s*(\\d+months)?\\s*(\\d+(w|wk|weeks))?\\s*(\\d+(d|days))?\\s*(\\d+(h|hr|hours))?\\s*(\\d+(m|min|minutes))?\\s*(\\d+(s|sec|seconds))?$"}]}}},"ResourceCountActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.count"],"description":"Count the number of resources a similar `resource.query` action would return."},"resource":{"type":"string","description":"The type of the resource to count."},"own":{"type":"boolean","description":"If only the resources created by the authenticated app member should be included"},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceCreateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.create"],"description":"Create a resource."},"resource":{"type":"string","description":"The type of the resource to create."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceDefinition":{"type":"object","additionalProperties":false,"description":"A definition of how this resource works.","required":["schema"],"properties":{"expires":{"type":"string","description":"A time string representing when a resource should expire.\n\nExample: 1d 8h 30m\n","pattern":"^(\\d+(y|yr|years))?\\s*(\\d+months)?\\s*(\\d+(w|wk|weeks))?\\s*(\\d+(d|days))?\\s*(\\d+(h|hr|hours))?\\s*(\\d+(m|min|minutes))?\\s*(\\d+(s|sec|seconds))?$"},"clonable":{"type":"boolean","description":"Whether the resource should be able to be transferred when cloning the app it belongs to"},"schema":{"$ref":"#/components/schemas/JSONSchemaRoot","description":"JSON schema definitions that may be used by the app."},"references":{"type":"object","description":"References to other resources.\n\nThe key is the property that references the other resource. The value is an object describing the\nname of the resource and how it should behave.\n","minProperties":1,"additionalProperties":{"type":"object","description":"A reference to between two resource types.","additionalProperties":false,"properties":{"resource":{"type":"string"},"create":{"type":"object","additionalProperties":false,"description":"Defines what happens when the specified action is executed on the referenced resource.","properties":{"triggers":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"Defines the type of trigger and the cascading strategy for it","required":["type"],"properties":{"type":{"enum":["create","update","delete"]},"cascade":{"description":"Defines the cascading strategy.\n\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\n\nIf 'delete' is specified, the referencing resource is deleted.\n\nIf not specified, the referenced resource cannot be deleted\nwithout deleting the referencing resource first.","enum":["update","delete"]}}},"minItems":1,"uniqueItems":true}}},"patch":{"type":"object","additionalProperties":false,"description":"Defines what happens when the specified action is executed on the referenced resource.","properties":{"triggers":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"Defines the type of trigger and the cascading strategy for it","required":["type"],"properties":{"type":{"enum":["create","update","delete"]},"cascade":{"description":"Defines the cascading strategy.\n\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\n\nIf 'delete' is specified, the referencing resource is deleted.\n\nIf not specified, the referenced resource cannot be deleted\nwithout deleting the referencing resource first.","enum":["update","delete"]}}},"minItems":1,"uniqueItems":true}}},"update":{"type":"object","additionalProperties":false,"description":"Defines what happens when the specified action is executed on the referenced resource.","properties":{"triggers":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"Defines the type of trigger and the cascading strategy for it","required":["type"],"properties":{"type":{"enum":["create","update","delete"]},"cascade":{"description":"Defines the cascading strategy.\n\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\n\nIf 'delete' is specified, the referencing resource is deleted.\n\nIf not specified, the referenced resource cannot be deleted\nwithout deleting the referencing resource first.","enum":["update","delete"]}}},"minItems":1,"uniqueItems":true}}},"delete":{"type":"object","additionalProperties":false,"description":"Defines what happens when the specified action is executed on the referenced resource.","properties":{"triggers":{"type":"array","items":{"type":"object","additionalProperties":false,"description":"Defines the type of trigger and the cascading strategy for it","required":["type"],"properties":{"type":{"enum":["create","update","delete"]},"cascade":{"description":"Defines the cascading strategy.\n\nIf 'update' is specified, the referencing property of the referencing resource is set to null.\n\nIf 'delete' is specified, the referencing resource is deleted.\n\nIf not specified, the referenced resource cannot be deleted\nwithout deleting the referencing resource first.","enum":["update","delete"]}}},"minItems":1,"uniqueItems":true}}}}}},"positioning":{"type":"boolean","default":false,"description":"Whether to enable position column for the instances of this resource. This is used for keeping an ordered list to enable custom sorting of the data using drag and drop features."},"enforceOrderingGroupByFields":{"type":"array","pattern":"^[a-zA-Z0-9]*$","description":"Group resources by fields when handling resource positions","items":{"type":"string"},"minItems":1},"url":{"type":"string","default":"/api/apps/{appId}/{resource}","description":"URL to use if not otherwise specified."},"id":{"type":"string","default":"id","description":"Name of the field used when accessing singular entities."},"history":{"description":"A definition of how versioning should happen for instances of this resource.","default":false,"oneOf":[{"type":"boolean","description":"Setting this to `true` is the same as using an object with the property `data` set to `true`."},{"$ref":"#/components/schemas/ResourceHistoryDefinition"}]},"query":{"type":"object","description":"Overrides for 'query' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"GET","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}","description":"URL to use for this type of request."}}},"get":{"type":"object","description":"Overrides for 'get' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"GET","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."}}},"count":{"type":"object","description":"Overrides for 'count' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"GET","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/$count","description":"URL to use for this type of request."}}},"create":{"type":"object","description":"Overrides for 'create' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"POST","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"patch":{"type":"object","description":"Overrides for 'patch' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"PATCH","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"update":{"type":"object","description":"Overrides for 'update' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"PUT","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"delete":{"type":"object","description":"Overrides for 'delete' requests.","additionalProperties":false,"properties":{"query":{"type":"object","description":"The query parameters to use in the request.","additionalProperties":{"type":"string"}},"method":{"type":"string","default":"DELETE","description":"HTTP method to use for this type of request."},"url":{"type":"string","default":"/api/apps/{appId}/{resource}/{id}","description":"URL to use for this type of request."},"hooks":{"$ref":"#/components/schemas/ResourceHooksDefinition"}}},"views":{"$ref":"#/components/schemas/ResourceViewDefinition"}}},"ResourceDeleteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.delete"],"description":"Delete a resource."},"resource":{"type":"string","description":"The type of the resource to delete."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceDeleteAllActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.delete.all"],"description":"Delete all instances of a resource.\n> **Warning!**\n>\n> Use this action with caution to avoid losing precious data!"},"resource":{"type":"string","description":"The type of the resource to delete."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceDeleteBulkActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.delete.bulk"],"description":"Delete several instances of a resource."},"resource":{"type":"string","description":"The type of the resource to delete."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceGetActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.get"],"description":"Get a single resource."},"resource":{"type":"string","description":"The type of the resource to get."},"view":{"type":"string","description":"The view to use for the resource."},"id":{"$ref":"#/components/schemas/RemapperDefinition"},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceHistoryDefinition":{"type":"object","additionalProperties":false,"description":"A definition of how versioning works for instances of this resource","required":["data"],"properties":{"data":{"type":"boolean","default":true,"description":"If set to `false`, edits are still tracked, but exactly what changed is lost."}}},"ResourceHistoryGetActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.history.get"],"description":"Get the complete history of a resource."},"resource":{"type":"string","description":"The type of the resource to get."},"method":{"enum":["delete","get","patch","post","put"],"default":"get","description":"The type of request to make."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceHooksDefinition":{"type":"object","description":"Hooks that are triggered upon calling a resource action.","additionalProperties":false,"minProperties":1,"properties":{"notification":{"$ref":"#/components/schemas/NotificationHookDefinition"}}},"ResourcePatchActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.patch"],"description":"Patch a resource."},"resource":{"type":"string","description":"The type of the resource to patch."},"id":{"$ref":"#/components/schemas/RemapperDefinition"},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceQueryActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.query"],"description":"Query a list of resources."},"resource":{"type":"string","description":"The type of the resource to query."},"view":{"type":"string","description":"The view to use for the resource."},"own":{"type":"boolean","description":"If only the resources created by the authenticated app member should be included"},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscription":{"type":"object","additionalProperties":false,"description":"This describes how a user is subscribed to a resource.","properties":{"create":{"type":"boolean","description":"If true, the user is subscribed to any create actions for the resource type"},"update":{"type":"boolean","description":"If true, the user is subscribed to any update actions for the resource type"},"delete":{"type":"boolean","description":"If true, the user is subscribed to any delete actions for the resource type"},"subscriptions":{"type":"object","description":"A mapping of resource IDs to individual resource subscriptions","additionalProperties":{"type":"object","description":"The subscription status of a user for a single resource.","additionalProperties":false,"properties":{"update":{"type":"boolean","description":"If true, the user is subscribed to update actions on this particular resource."},"delete":{"type":"boolean","description":"If true, the user will be notified when this particular resource is deleted."}}}}}},"ResourceSubscriptionStatusActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.status"],"description":"Get the status of whether or not the user is subscriped to notifications for resource modifications."},"resource":{"type":"string","description":"The type of the resource to get the subscription state for."},"action":{"enum":["create","delete","update"],"description":"The resource action type to get the subscription state for.","default":"update"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscriptionSubscribeActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.subscribe"],"description":"Subscribe to notifications on resource modifications."},"resource":{"type":"string","description":"The type of the resource to subscribe to."},"action":{"enum":["create","delete","update"],"description":"The resource action type to subscribe to.","default":"update"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscriptionToggleActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.toggle"],"description":"Toggle whether or not to receive notifications on resource modifications."},"resource":{"type":"string","description":"The type of the resource to toggle the subscription state for."},"action":{"enum":["create","delete","update"],"description":"The resource action type to toggle the subscription state for.","default":"update"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceSubscriptionUnsubscribeActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.subscription.unsubscribe"],"description":"Unsubscribe from notifications on resource modifications."},"resource":{"type":"string","description":"The type of the resource to unsubscribe from."},"action":{"enum":["create","delete","update"],"description":"The resource action type to unsubscribe from.","default":"update"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.update"],"description":"Update a resource."},"resource":{"type":"string","description":"The type of the resource to update."},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceUpdatePositionsActionDefinition":{"type":"object","additionalProperties":false,"required":["type","resource"],"properties":{"type":{"enum":["resource.update.positions"],"description":"Update the position of a resource."},"resource":{"type":"string","description":"The type of the resource to update."},"id":{"$ref":"#/components/schemas/RemapperDefinition"},"query":{"$ref":"#/components/schemas/RemapperDefinition","description":"A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is."},"body":{"$ref":"#/components/schemas/RemapperDefinition","description":"remapper that results in the request body to send.\n\nIf not specified, the raw input data is used.\n"},"proxy":{"type":"boolean","default":true,"description":"By default requests will be proxied through the Appsemble API.\n\nThis allows to protect user data and ensures\n[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be\ndisabled by setting this to `false`\n"},"schema":{"description":"The name of the schema to validate against before submitting data.","$ref":"#/components/schemas/JSONSchema"},"headers":{"type":"object","description":"The headers to be set for the outgoing request","additionalProperties":false,"properties":{"Content-Type":{"description":"Content type for the outgoing request","enum":["application/xml","text/plain","application/x-www-form-urlencoded","multipart/form-data"]}}},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"ResourceViewDefinition":{"type":"object","minProperties":1,"description":"Alternative views of a resource that are modified using remappers and support different sets of roles.","additionalProperties":{"type":"object","additionalProperties":false,"description":"A custom view for a resource.","properties":{"roles":{"type":"array","description":"The list of roles that are allowed to use this view.","items":{"type":"string"}},"remap":{"$ref":"#/components/schemas/RemapperDefinition","description":"The modified view."}}}},"SSLSecret":{"type":"object","additionalProperties":false,"description":"The SSL secret of an app.","properties":{"certificate":{"type":"string","description":"The public SSL certificate chain in PEM format."},"key":{"type":"string","description":"The SSL private key in PEM format."}}},"SSOConfiguration":{"type":"object","description":"A single sign on configuration which is exposed to users.","additionalProperties":false,"properties":{"url":{"type":"string","format":"url","description":"The URL users will be redirected to in the login process."},"name":{"type":"string","description":"A user readable name for the configuration."},"icon":{"type":"string","description":"A Font Awesome icon."}}},"ScimPatchOp":{"type":"object","description":"A SCIM patch operation","required":["schemas","operations"],"additionalProperties":true,"properties":{"schemas":{"type":"array","maxItems":1,"minItems":1,"items":{"enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}},"operations":{"type":"array","description":"Patch operations to apply to the resource","items":{"anyOf":[{"type":"object","description":"A SCIM patch single replace operation","additionalProperties":false,"required":["op","path","value"],"properties":{"op":{"enum":["add","replace"]},"name":{"type":"string"},"path":{"type":"string"},"value":{}}},{"type":"object","description":"A SCIM patch bulk replace operation","additionalProperties":false,"required":["op","path"],"properties":{"op":{"enum":["remove"]},"path":{"type":"string"}}}]}}}},"ScimSecret":{"type":"object","additionalProperties":false,"description":"An app\u2019s SCIM configuration.","properties":{"enabled":{"type":"boolean","description":"Whether or not SCIM is enabled for the app."},"token":{"type":"string","description":"The secret SCIM token"}}},"ScimUser":{"type":"object","additionalProperties":true,"description":"The definition of a user according to the SCIM documentation.","required":["emails","schemas","userName"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"userName":{"type":"string","description":"A unique identifier for the user (generally maps to the Azure AD user principal name)"},"active":{"type":"boolean"},"meta":{"type":"object","additionalProperties":false,"description":"Read-only metadata maintained by the service provider","properties":{"resourceType":{"type":"string"},"created":{"type":"string"},"lastModified":{"type":"string"},"location":{"type":"string"}}},"emails":{"type":"array","minLength":1,"items":{"type":"object","additionalProperties":false,"description":"A user's email. By default, one of these should be of type 'work' and have 'primary' set to true. Value contains actual address","required":["primary","type","value"],"properties":{"primary":{"type":"boolean"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"SecurityCronDefinition":{"type":"object","description":"This describes the permissions that unauthenticated users have.","additionalProperties":false,"properties":{"inherits":{"type":"array","minItems":1,"description":"The name of the role to inherit from.\n\nNote that this role must exist.\n","items":{"type":"string"}},"permissions":{"type":"array","description":"Specific permissions within the app, which unauthenticated users should have","items":{"type":"string"}}}},"SecurityDefaultDefinition":{"type":"object","required":["role"],"description":"The default role to apply to members.","additionalProperties":false,"properties":{"policy":{"enum":["everyone","organization","invite"],"default":"everyone","description":"How the `default` role gets applied to users.\n\nThe following values are allowed:\n- `everyone`: Every authenticated user gets the default role.\n- `organization`: Every authenticated user gets the default role if they are in the same organization as the app.\n- `invite`: The app member has to be invited to the app with a specific role.\n\n> **Important**: When [OAuth2](../guides/oauth2) or [SAML2.0](../guides/saml) is used in the\n> app, you must set the policy to `everyone`. This will specifically allow every configured\n> authentication method on the secrets page to be used as login method. If you do not want other\n> Appsemble user accounts to be able to log in, you must `disable` the `appsemble login` options\n> (including the Appsemble OAuth2 option) in the secrets page. If this option is enabled, any\n> Appsemble user account is able to log in to the app and will receive the default role.\n"},"role":{"type":"string","description":"The default role to apply to members.\n\nThis must match with one of the roles defined within the security definition.\n"}}},"SecurityDefinition":{"type":"object","description":"This describes how the app is secured.","additionalProperties":false,"properties":{"default":{"$ref":"#/components/schemas/SecurityDefaultDefinition"},"guest":{"$ref":"#/components/schemas/SecurityGuestDefinition"},"cron":{"$ref":"#/components/schemas/SecurityCronDefinition"},"roles":{"type":"object","description":"This property defines the app roles that are available within the app.","minProperties":1,"additionalProperties":{"$ref":"#/components/schemas/SecurityRoleDefinition"}}}},"SecurityGuestDefinition":{"type":"object","description":"This describes the permissions that unauthenticated users have.","additionalProperties":false,"properties":{"inherits":{"type":"array","minItems":1,"description":"The name of the role to inherit from.\n\nNote that this role must exist.\n","items":{"type":"string"}},"permissions":{"type":"array","description":"Specific permissions within the app, which unauthenticated users should have","items":{"type":"string"}}}},"SecurityRoleDefinition":{"type":"object","description":"This describes a security role.","additionalProperties":false,"properties":{"description":{"type":"string","description":"The description of the role."},"defaultPage":{"type":"string","description":"The default page to redirect users with this role to."},"inherits":{"type":"array","minItems":1,"description":"The name of the role to inherit from.\n\nNote that this role must exist and can not inherit itself via this field or the `inherits` field\nof the referenced role.\n","items":{"type":"string"}},"permissions":{"type":"array","description":"Specific permissions within the app, which this role should have","items":{"type":"string"}}}},"ShareActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["share"],"description":"The `share` action can be used to display a prompt that allows the user to share something with others, primarily via social media.\n\nDepending on whether the user\u2019s browser supports a native share function it will either display a\nnative dialog for sharing links, or display a more limited fallback in a dialog.\n"},"url":{"$ref":"#/components/schemas/RemapperDefinition","description":"The url that is being shared."},"title":{"$ref":"#/components/schemas/RemapperDefinition","description":"The title that should be shared."},"text":{"$ref":"#/components/schemas/RemapperDefinition","description":"The main body that should be shared."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StaticActionDefinition":{"type":"object","additionalProperties":false,"required":["type","value"],"properties":{"type":{"enum":["static"],"description":"The `static` action returns static data defined in the action definition.\n\nThis is useful for example for stubbing data.\n"},"value":{"description":"The static value to return."},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageAppendActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key","value"],"properties":{"type":{"enum":["storage.append"],"description":"Append data to an existing array in storage.\n If the storage entry is a single object, it turns it into an array to append the data on.\n\nFor example:\n```yaml\ntype: storage.append\nkey: temp\nvalue: { root }\nstorage: localStorage\nremapBefore:\n object.from:\n text:\n This is a new data item\n value:\n 1\n```\n"},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"The data to write on top of the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to store the data.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageDeleteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key"],"properties":{"type":{"enum":["storage.delete"],"description":"Delete the item that is stored at the specified key.\n\nFor example:\n```yaml\ntype: storage.delete\nkey: temp\nstorage: localStorage\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry to remove."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to remove the data from.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageReadActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key"],"properties":{"type":{"enum":["storage.read"],"description":"Read data from the app\u2019s local storage.\n\nFor example:\n```yaml\ntype: storage.read\nkey: temp\nstorage: localStorage\n```\n\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to read the data from.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageSubtractActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key"],"properties":{"type":{"enum":["storage.subtract"],"description":"Subtract last item from a storage entry.\n\nIf the entry consists of only one item, turns it into a singular object.\n\nIf the entry is a single item, the entry is removed entirely.\n\nFor example:\n```yaml\ntype: storage.subtract\nkey: temp\nstorage: localStorage\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to read the data from.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageUpdateActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key","value"],"properties":{"type":{"enum":["storage.update"],"description":"Update an existing item in storage, or update an item inside a stored array.\n\nFor example:\n```yaml\ntype: storage.update\nkey: temp\nitem: 1\nvalue: { root }\nstorage: localStorage\nremapBefore:\n object.from:\n text: { prop: text }\n value: { prop: value }\n newField: \"New field\"\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"item":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the item in an array to update."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"The data to update the specified item with."},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to store the data.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"StorageWriteActionDefinition":{"type":"object","additionalProperties":false,"required":["type","key","value"],"properties":{"type":{"enum":["storage.write"],"description":"Write data to the app\u2019s local storage.\n\nFor example:\n```yaml\ntype: storage.write\nkey: temp\nvalue: { root }\nstorage: localStorage\nremapBefore:\n object.from:\n data:\n cool data\n value:\n 1\n```\n "},"key":{"$ref":"#/components/schemas/RemapperDefinition","description":"The key of the storage entry."},"value":{"$ref":"#/components/schemas/RemapperDefinition","description":"The data to write to the storage entry."},"expiry":{"enum":["1d","3d","7d","12h"],"description":"Set an expiry for your data, only works with the localStorage"},"storage":{"enum":["indexedDB","localStorage","sessionStorage","appStorage"],"description":"The mechanism used to store the data.","default":"indexedDB"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"SubPage":{"type":"object","description":"This describes what a sub page will look like in the app.","required":["blocks"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the sub page."},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn\u2019t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren\u2019t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"blocks":{"type":"array","minItems":1,"description":"The blocks that make up a page.","items":{"$ref":"#/components/schemas/BlockDefinition"}}}},"TabsPageDefinition":{"type":"object","description":"Shows a set of subpages as tabs at the top of the page.","oneOf":[{"required":["type","tabs"]},{"required":["type","definition"]}],"additionalProperties":true,"properties":{"type":{"enum":["tabs"]},"tabs":{"type":"array","minItems":1,"description":"Each of the available tabs for the tabs page.","items":{"$ref":"#/components/schemas/SubPage"}},"definition":{"type":"object","additionalProperties":false,"description":"Generate tabs dynamically","required":["events","foreach"],"properties":{"events":{"$ref":"#/components/schemas/EventsDefinition"},"foreach":{"$ref":"#/components/schemas/SubPage"}}},"actions":{"$ref":"#/components/schemas/PageActionsDefinition"},"name":{"type":"string","maxLength":50,"description":"The name of an app.\n\nThis field is always required and must be unique within the app, meaning that it is not possible to\nhave two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.\n\n> **Note**: The URL used to navigate to pages is determined by this property.\n"},"hideName":{"type":"boolean","description":"Whether or not the page name should be displayed in the *app bar*."},"navTitle":{"$ref":"#/components/schemas/RemapperDefinition","description":"The name of the page when displayed in the navigation menu.\n\n Context property `name` can be used to access the name of the page.\n "},"hideNavTitle":{"type":"boolean","description":"Whether or not the page should be displayed in navigational menus.\n\n By default all pages without parameters are added to navigational menus. Set to `true` to hide the\n page from menus.\n ","default":false},"navigation":{"$ref":"#/components/schemas/AppLayoutDefinition/properties/navigation","description":"The type of navigation displayed on the page.\n\nThis overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or\nApp navigation are not set.\n\nSet to `bottom` to use a navigation pane at the bottom of the screen instead of the default side\nmenu. Set to `hidden` to display no navigational menus at all.\n"},"icon":{"type":"string","description":"An optional icon from the fontawesome icon set\n\nThis will be displayed in the navigation menu.\n"},"parameters":{"type":"array","description":"Page parameters can be used for linking to a page that should display a single resource.\n\nThis defined as a list of strings representing the properties to pass through. More often than not\npassing `id` through is sufficient, depending on the block.\n","items":{"type":"string","minLength":1,"maxLength":30}},"roles":{"type":"array","description":"The list of roles that are allowed to view this page.\n\nIf the user doesn\u2019t have any of the roles in the list the page will be unavailable to them. An empty\nlist can be used to specify that users need to log in but do not need a specific role.\n\nUsers trying to visit a page without having the correct roles will be redirected to the first page\nthat they are allowed to view. If there aren\u2019t any accessible pages, the user will be logged out and\ninstructed to contact the app owner to get permissions.\n","items":{"type":"string"}},"theme":{"$ref":"#/components/schemas/Theme"},"badgeCount":{"$ref":"#/components/schemas/RemapperDefinition","description":"A Remapper that resolves to a number to be visibile in the side-menu."}},"required":["name"]},"Theme":{"type":"object","description":"A generic theme definition.","additionalProperties":false,"minProperties":1,"properties":{"themeColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#ffffff","description":"The generic theme color of the app.\n\nThis is used for example in the URL bar on Android.\n"},"splashColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#ffffff","description":"The background color of the PWA splash screen.\n\nThis defaults to the theme color.\n"},"primaryColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#5393ff","description":"The primary color used within the app.\n\nThis is used in various elements like the navbar.\n"},"linkColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#0440ad","description":"The color used for links."},"infoColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#a7d0ff","description":"The color used for informational messages."},"successColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#1fd25b","description":"The color used for successful actions."},"warningColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#fed719","description":"The color used for warning messages."},"dangerColor":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","default":"#ff2800","description":"The color used for error messages."},"tileLayer":{"type":"string","format":"uri","default":"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png","description":"The tileLayer to use for Leaflet maps."},"font":{"description":"The font to use in the app.","anyOf":[{"$ref":"#/components/schemas/CustomFontDefinition"},{"$ref":"#/components/schemas/GoogleFontDefinition"}]}}},"ThrowActionDefinition":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"type":{"enum":["throw"],"description":"This action throws a new exception based on the data that is passed through.\n\nThis can be used to create a custom error that ends up in the error action handler.\n"},"remapBefore":{},"remapAfter":{},"onSuccess":{},"onError":{}}},"Training":{"type":"object","description":"Object representation of a training","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"string","description":"Id of the training"}}},"TrainingCompleted":{"type":"object","description":"Object which stores that a user has completed a certain training","additionalProperties":false,"properties":{"trainingId":{"type":"string","description":"The training that the user has completed.","readOnly":true},"userId":{"type":"string","description":"The user who completed the training"}}},"User":{"type":"object","description":"An object representing a user","additionalProperties":false,"properties":{"id":{"type":"string","readOnly":true,"description":"The id of the user."}}},"UserEmail":{"type":"object","description":"\n An email address that is linked to a user.\n\n Users may use any of their email addresses to login.\n ","required":["email"],"additionalProperties":false,"properties":{"email":{"type":"string","format":"email","description":"The email address that is registered"},"verified":{"type":"boolean","readOnly":true,"description":"Wether or not the email address has been verified by the user."}}},"UserInfo":{"type":"object","description":"An object representing the OAuth2 info of a user","additionalProperties":false,"properties":{"sub":{"type":"string","readOnly":true,"description":"The id of the user."},"name":{"type":"string","description":"The full name of the user."},"email":{"type":"string","description":"The email of the user."},"email_verified":{"type":"boolean","description":"Whether this email address has been verified."},"picture":{"type":"string","format":"url","description":"The URL of the profile picture of the user."},"locale":{"type":"string","description":"The locale of the user."},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"],"description":"The time zone of the user."},"subscribed":{"type":"boolean","description":"If the user is subscribed to the newsletter."}}},"WebhookDefinition":{"type":"object","required":["schema","action"],"description":"A webhook definition defines app specific callable endpoints that Appsemble can handle.","additionalProperties":false,"properties":{"schema":{"$ref":"#/components/schemas/JSONSchemaRoot","description":"JSON schema definition of the payload."},"action":{"description":"The action to run when the webhook is triggered.","$ref":"#/components/schemas/ActionDefinition"}}}},"securitySchemes":{"app":{"type":"oauth2","description":"\n OAuth2 login for apps.\n\n The authorization code flow is recommended. The password flow exists for legacy apps and will be\n removed in the future.\n ","flows":{"authorizationCode":{"authorizationUrl":"/connect/authorize","tokenUrl":"/apps/{appId}/auth/oauth2/token","refreshUrl":"/apps/{appId}/auth/oauth2/token","scopes":{"email":"Read the user email address.","openid":"Login the user to the requesting app using OpenID.","profile":"Read the user profile, including the display name and profile picture.","resources:manage":"Manage app resources on behalf of a user.","groups:read":"Read the groups the user is a part of.","groups:write":"Add new members to a group."}},"password":{"tokenUrl":"/apps/{appId}/auth/oauth2/token","refreshUrl":"/apps/{appId}/auth/oauth2/token","scopes":{"email":"Read the user email address.","openid":"Login the user to the requesting app using OpenID.","profile":"Read the user profile, including the display name and profile picture.","resources:manage":"Manage app resources on behalf of a user.","groups:read":"Read the groups the user is a part of.","groups:write":"Add new members to a group."}}}},"basic":{"type":"http","scheme":"basic","description":"Used for logging in to the web interface"},"cli":{"type":"oauth2","description":"\n OAuth2 login for client credentials.\n\n For example the Appsemble CLI uses this.\n ","flows":{"clientCredentials":{"tokenUrl":"/auth/oauth2/token","scopes":{"apps:export":"Export apps as zip files","apps:write":"Create and update apps","apps:delete":"Delete apps","blocks:write":"Register and update blocks, and publish new block versions.","blocks:delete":"Delete specific block versions.","organizations:write":"Create and manage organizations.","resources:read":"Read app resources on behalf of a user.","resources:write":"Modify app resources on behalf of a user.","assets:write":"Create app assets on behalf of a user.","groups:read":"Read information about the user\u2019s groups.","groups:write":"Read information about the user\u2019s groups."}}}},"scim":{"type":"http","scheme":"bearer","description":"Used SCIM clients"},"studio":{"type":"http","scheme":"bearer","bearerFormat":"jwt","description":"Used for authenticating requests made using Appsemble studio interface."},"webhook":{"type":"http","scheme":"bearer","description":"Used for webhook calls"}}},"externalDocs":{"description":"Appsemble developer documentation","url":"https://appsemble.app:9999/docs"},"info":{"title":"Appsemble","description":"Welcome to the Appsemble API.\n\nThe app studio can be found on\n> https://appsemble.app:9999\n\nThe OpenAPI explorer can be found on\n> https://appsemble.app:9999/api-explorer\n","license":{"name":"LGPL","url":"https://gitlab.com/appsemble/appsemble/blob/main/LICENSE.md"},"version":"0.33.5"},"paths":{"/api/app-collections/{appCollectionId}/apps/{appId}/pinned":{"post":{"tags":["main","app-collection","app"],"description":"Pin an app to an app collection","operationId":"pinAppToAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection to pin the app to","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}},{"name":"appId","in":"path","description":"The id of the app to pin","required":true,"schema":{"$ref":"#/components/schemas/App/properties/id"}}],"responses":{"200":{"description":"The app was pinned to the app collection","content":{"application/json":{"schema":{"type":"object","properties":{"pinned":{"type":"string","format":"date-time"}}}}}}},"security":[{"studio":[]}]},"delete":{"tags":["main","app-collection","app"],"description":"Unpin an app from an app collection","operationId":"unpinAppFromAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection to unpin the app from","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}},{"name":"appId","in":"path","description":"The id of the app to unpin","required":true,"schema":{"$ref":"#/components/schemas/App/properties/id"}}],"responses":{"204":{"description":"The app was unpinned from the app collection"}},"security":[{"studio":[]}]}},"/api/app-collections/{appCollectionId}/apps/{appId}":{"delete":{"tags":["main","app-collection","app"],"description":"Remove an app from an app collection","operationId":"removeAppFromAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}},{"name":"appId","in":"path","description":"The id of the app","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"responses":{"204":{"description":"The app was removed from the app collection"}},"security":[{"studio":[]}]}},"/api/app-collections/{appCollectionId}/apps":{"get":{"tags":["main","app-collection","app"],"description":"Get a list of apps in an app collection","operationId":"queryAppCollectionApps","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}},{"name":"language","in":"query","description":"The language to include the translations of, if available","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of apps","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/App"},{"type":"object","properties":{"pinned":{"type":"string","format":"date-time","nullable":true}}}]}}}}}},"security":[{"studio":[]},{}]},"post":{"tags":["main","app-collection","app"],"description":"Add an app to an app collection","operationId":"addAppToAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"requestBody":{"description":"The app to add to the app collection","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"AppId":{"$ref":"#/components/schemas/App/properties/id"}}}}}},"responses":{"204":{"description":"The app was added to the app collection"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/app-collections/{appCollectionId}/expert/profile-image":{"get":{"tags":["main","app-collection"],"description":"Get an app collection\u2019s expert\u2019s profile image","operationId":"getAppCollectionExpertProfileImage","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"responses":{"200":{"description":"The app collection\u2019s expert\u2019s profile image","content":{"image/png":{},"image/jpeg":{},"image/tiff":{},"image/webp":{}}}},"security":[{"studio":[]},{}]}},"/api/app-collections/{appCollectionId}/header-image":{"get":{"tags":["main","app-collection"],"description":"Get an app collection\u2019s header image","operationId":"getAppCollectionHeaderImage","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"responses":{"200":{"description":"The app collection\u2019s header image","content":{"image/png":{},"image/jpeg":{},"image/tiff":{},"image/webp":{}}}},"security":[{"studio":[]},{}]}},"/api/app-collections/{appCollectionId}":{"get":{"tags":["main","app-collection"],"description":"Get an app collection","operationId":"getAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"responses":{"200":{"description":"An app collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppCollection"}}}}},"security":[{"studio":[]},{}]},"patch":{"tags":["main","app-collection"],"description":"Update an app collection","operationId":"updateAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"requestBody":{"description":"The app collection to update","required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AppCollectionDefinition"},"encoding":{"expertProfileImage":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"},"headerImage":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"description":"The updated app collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppCollection"}}}}},"security":[{"studio":[]}]},"delete":{"tags":["main","app-collection"],"description":"Delete an app collection","operationId":"deleteAppCollection","parameters":[{"name":"appCollectionId","in":"path","description":"The id of the app collection","required":true,"schema":{"$ref":"#/components/schemas/AppCollection/properties/id"}}],"responses":{"204":{"description":"The app collection was deleted"}},"security":[{"studio":[]}]}},"/api/app-collections":{"get":{"tags":["main","app-collection"],"description":"Get a list of app collections","operationId":"queryAppCollections","responses":{"200":{"description":"A list of app collections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppCollection"}}}}}},"security":[{"studio":[]},{}]}},"/api/app-invites/{token}/respond":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"post":{"tags":["app-invite"],"description":"Respond to a given invitation.","operationId":"respondAppInvite","requestBody":{"description":"The response of the invitation.\n\n If response is true, user will join the app. If response is false, the user declines the invite and the invite is removed.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["response"],"properties":{"response":{"type":"boolean"},"password":{"type":"string","minLength":8},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]},"locale":{"type":"string"}}}}}},"responses":{"204":{"description":"The response has been processed."}}}},"/api/app-invites/{token}":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"get":{"tags":["app-invite"],"description":"Fetch information about an invite.","operationId":"getAppInvite","responses":{"200":{"description":"An invite response","$ref":"#/components/responses/invite"}}}},"/api/app-members/{appMemberId}/picture":{"parameters":[{"name":"appMemberId","in":"path","description":"The id of the member on which to perform the operation","required":true,"schema":{"$ref":"#/components/schemas/AppMember/properties/id"}}],"get":{"tags":["common","app-member"],"description":"Get an app member\u2019s profile picture.\n\n This will return a 404 if the user has not uploaded one.","operationId":"getAppMemberPicture","responses":{"200":{"description":"The profile picture of the app member.","content":{"image/png":{},"image/jpeg":{},"image/tiff":{},"image/webp":{}}}}}},"/api/app-members/{appMemberId}/properties":{"parameters":[{"name":"appMemberId","in":"path","description":"The id of the app member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppMember/properties/id"}}],"patch":{"tags":["common","app-member"],"description":"Patch the properties of an app member.","operationId":"patchAppMemberProperties","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"properties":{"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The member\u2019s custom properties."}}}}}},"responses":{"200":{"description":"The updated app member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMember"}}}}},"security":[{"studio":[]},{"app":[]}]}},"/api/app-members/{appMemberId}/role":{"parameters":[{"name":"appMemberId","in":"path","description":"The id of the app member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppMember/properties/id"}}],"put":{"tags":["common","app","member"],"description":"Patch an app member.","operationId":"updateAppMemberRole","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"role":{"type":"string"}}}}}},"responses":{"200":{"description":"The updated app member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMember"}}}}},"security":[{"studio":[]},{"app":[]}]}},"/api/app-members/{appMemberId}":{"parameters":[{"name":"appMemberId","in":"path","description":"The id of the app member on which to perform an operation","required":true,"schema":{"$ref":"#/components/schemas/AppMember/properties/id"}}],"delete":{"tags":["common","app-member"],"description":"Delete an app member.","operationId":"deleteAppMember","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"responses":{"204":{"description":"The app member was deleted successfully."}},"security":[{"studio":[]},{"app":["resources:manage"]},{}]}},"/api/apps/{appId}/actions/{path}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"in":"path","name":"path","description":"The path to the action to execute.","required":true,"schema":{"type":"string"}}],"get":{"tags":["app","action"],"description":"Proxy a GET request action","operationId":"proxyGet","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"parameters":[{"in":"query","name":"data","description":"The data that was passed to the action","required":true,"schema":{"type":"string"}}]},"delete":{"tags":["app","action"],"description":"Proxy a DELETE request action","operationId":"proxyDelete","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"parameters":[{"in":"query","name":"data","description":"The data that was passed to the action","required":true,"schema":{"type":"string"}}]},"patch":{"tags":["app","action"],"description":"Proxy a PATCH request action","operationId":"proxyPatch","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"requestBody":{"description":"The data that was passed to the action","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","description":"A `multipart/form-data` representation of a resource.","additionalProperties":true,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}},"*/*":{}}}},"post":{"tags":["app","action"],"description":"Proxy a POST request action","operationId":"proxyPost","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"requestBody":{"description":"The data that was passed to the action","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","description":"A `multipart/form-data` representation of a resource.","additionalProperties":true,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}},"*/*":{}}}},"put":{"tags":["app","action"],"description":"Proxy a PUT request action","operationId":"proxyPut","responses":{"default":{"description":"The proxied response"}},"security":[{"app":["email","profile"]},{}],"requestBody":{"description":"The data that was passed to the action","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","description":"A `multipart/form-data` representation of a resource.","additionalProperties":true,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}},"*/*":{}}}}},"/api/apps/{appId}/assets/\\$count":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app","asset"],"description":"Get the number of assets in the app.","operationId":"countAppAssets","responses":{"200":{"description":"The number of assets in the app.","content":{"application/json":{"schema":{"type":"number"}}}}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]}},"/api/apps/{appId}/assets/{assetId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/assetId"}],"get":{"tags":["common","app","asset"],"description":"Get a single asset","operationId":"getAppAssetById","responses":{"200":{"description":"The asset that matches the given id."}}},"head":{"tags":["common","app","asset"],"description":"Get the headers for a single asset","operationId":"getAppAssetHeadersById","responses":{"200":{"description":"The headers of the asset that matches the given id."}}},"delete":{"tags":["common","app","asset"],"description":"Remove an existing asset","operationId":"deleteAppAsset","responses":{"204":{"description":"The asset was successfully deleted."}},"security":[{"studio":[]},{"app":["resources:manage"]}]}},"/api/apps/{appId}/assets":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app","asset"],"description":"Get all of the app\u2019s assets.","operationId":"queryAppAssets","parameters":[{"$ref":"#/components/parameters/$skip"},{"$ref":"#/components/parameters/$top"},{"$ref":"#/components/parameters/seed"}],"responses":{"200":{"description":"The assets associated with the app.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}}},"security":[{"studio":[]},{}]},"post":{"tags":["common","app","asset"],"description":"Upload a new asset.","operationId":"createAppAsset","parameters":[{"$ref":"#/components/parameters/seed"}],"requestBody":{"description":"The asset to upload.","content":{"multipart/form-data":{"schema":{"type":"object","description":"The request body for creating an asset.","additionalProperties":false,"required":["file"],"properties":{"file":{"type":"string","format":"binary","writeOnly":true,"description":"The binary data of the asset. This may include a filename."},"name":{"type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","description":"The given name of the asset. Assets may be referenced by their name or ID in the API."},"clonable":{"type":"boolean","description":"Whether the asset should be transferable when cloning the app they are in."}}}}}},"responses":{"201":{"description":"The asset that was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}}}},"security":[{"studio":[]},{"cli":["assets:write"]},{}]},"delete":{"tags":["common","app","asset"],"description":"Delete multiple app assets.","operationId":"deleteAppAssets","parameters":[{"$ref":"#/components/parameters/seed"}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"An array of asset IDs to remove.","items":{"$ref":"#/components/schemas/Asset/properties/id"}}}}},"responses":{"204":{"description":"The app assets have been deleted successfully."}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["assets:write"]},{}]}},"/api/apps/{appId}/broadcast":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app"],"description":"Broadcast a push notification to every subscriber of the app.","operationId":"sendAppNotifications","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"The data to include in the notification","required":["body"],"properties":{"title":{"description":"The title of the notification. This defaults to the name of the app if not otherwise specified.","type":"string"},"body":{"description":"The content of the notification","type":"string"}}}}}},"responses":{"204":{"description":"The notification has been successfully broadcasted."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/demo-groups":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app","demo-group"],"description":"Get a list of app groups.","operationId":"getAppDemoGroups","responses":{"200":{"description":"The list of all groups.","content":{"application/json":{"schema":{"type":"array","items":{"description":"An app demo group","type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}}}}}},"/api/apps/{appId}/demo-members":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/roles"}],"get":{"tags":["common","app","demo-member"],"description":"Fetch all demo members of an app.","operationId":"queryAppDemoMembers","responses":{"200":{"description":"The list of app demo members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppMemberInfo"}}}}}}}},"/api/apps/{appId}/email":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app"],"description":"Get the app\u2019s email settings.","operationId":"getAppEmailSettings","responses":{"200":{"description":"The current app email settings","content":{"application/json":{"schema":{"type":"object","properties":{"emailName":{"type":"string","description":"The name used for emails."},"emailHost":{"type":"string","description":"The hostname of the SMTP server."},"emailPassword":{"type":"boolean","description":"Whether a password is set."},"emailUser":{"type":"string","description":"The username used to authenticate against the SMTP server."},"emailPort":{"type":"string","description":"The port used for the SMTP server."},"emailSecure":{"type":"boolean","description":"Whether TLS is being used."}}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/export":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app"],"description":"Export an app as a zip file","operationId":"exportApp","parameters":[{"name":"resources","schema":{"type":"boolean"},"description":"Whether to include resources for an app.","in":"query"},{"name":"assets","schema":{"type":"boolean"},"description":"Whether to include assets in the export file","in":"query"},{"name":"screenshots","schema":{"type":"boolean"},"description":"Whether to include screenshots in the export file","in":"query"},{"name":"readmes","schema":{"type":"boolean"},"description":"Whether to include readmes in the export file","in":"query"}],"responses":{"200":{"description":"App exported successfully."}},"security":[{"studio":[]},{"cli":["apps:export"]}]}},"/api/apps/{appId}/groups":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app","group"],"description":"Get a list of app groups.","operationId":"getAppGroups","responses":{"200":{"description":"The list of all groups.","content":{"application/json":{"schema":{"type":"array","items":{"description":"An app group","type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}}}},"security":[{"studio":[]},{"app":["groups:read"]},{}]},"post":{"tags":["common","app","group"],"description":"Create a new group.","operationId":"createAppGroup","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"requestBody":{"description":"The group to create.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"annotations":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"responses":{"201":{"description":"The created group","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"role":{"type":"string","description":"The role of the user who created the group","enum":["member"]}}}}}}},"security":[{"app":["groups:write"]},{"studio":[]},{"cli":["groups:write"]}]}},"/api/apps/{appId}/icon":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app"],"description":"Get the current app icon.","operationId":"getAppIcon","responses":{"200":{"description":"The icon of the app that matches the given id.","content":{"image/png":{},"image/jpeg":{},"image/tiff":{},"image/webp":{}}}}},"delete":{"tags":["main","app"],"description":"Delete the current app icon.","operationId":"deleteAppIcon","responses":{"204":{"description":"The icon has been successfully removed"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/invites/resend":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app"],"description":"Request to resend an invitation.","operationId":"resendAppInvite","requestBody":{"description":"The email of the person to resend the invitation to.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}}}}},"responses":{"204":{"description":"The invite has been sent."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/invites":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app","invite"],"description":"Get a list of invited app members.","operationId":"getAppInvites","responses":{"200":{"description":"The list of all invites.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string"}}}}}}}},"security":[{"studio":[]}]},"post":{"tags":["app","invite"],"description":"Invite a new app member to an app.","operationId":"createAppInvites","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"requestBody":{"description":"The invite to create.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["email","role"],"properties":{"email":{"type":"string","format":"email","description":"The email address of the user to invite."},"role":{"type":"string","description":"The role to invite the user as."}}}}}}},"responses":{"200":{"description":"The invited member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMember"}}}}},"security":[{"studio":[]},{"app":["app:write"]}]},"delete":{"tags":["app","invite"],"description":"Revoke an app member invitation.","operationId":"deleteAppInvite","requestBody":{"description":"The email address to revoke the invite of.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The invitation has been successfully revoked."}},"security":[{"studio":[]}]}},"/api/apps/{appId}/lock":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app"],"description":"Update the locked property an app.","operationId":"setAppLock","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["locked"],"properties":{"locked":{"$ref":"#/components/schemas/App/properties/locked","description":"Whether the app should be locked."}}}}}},"responses":{"204":{"description":"Lock status successfully changed","content":{"application/zip":{}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/maskable-icon":{"parameters":[{"$ref":"#/components/parameters/appId"}],"delete":{"tags":["main","app"],"description":"Delete the current app\u2019s maskable icon.","operationId":"deleteAppMaskableIcon","responses":{"204":{"description":"The icon has been successfully removed"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/members/current/groups":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app","member","current-member"],"description":"Get a list of groups that the app member is a member of.","operationId":"getCurrentAppMemberGroups","responses":{"200":{"description":"The list of groups of the app member.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"role":{"type":"string"}}}}}}}},"security":[{"app":[]}]}},"/api/apps/{appId}/members/current/link":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app","member","current-member"],"description":"Link the app member to an unlinked authorization.","operationId":"linkCurrentAppMember","security":[{"app":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"externalId":{"type":"string","description":"The external id of the of the external user.\n\nThe `externalId` maps to the following ids of the external login methods.\n- Appsemble OAuth2 login: `UserId`\n- App OAuth2 login: `sub`\n- App SAML login: `nameId`\n"},"secret":{"type":"string","description":"The secret that was used to get the external id."}}}}}},"responses":{"200":{"description":"","content":{}}}}},"/api/apps/{appId}/members/current":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["app","member","current-member"],"description":"\n Get the app member information formatted as OpenID user info.\n\n See https://connect2id.com/products/server/docs/api/userinfo\n ","operationId":"getCurrentAppMember","security":[{"app":["openid"]}],"responses":{"200":{"description":"OpenID compatible app member information","content":{"application/json":{"schema":{"type":"object","properties":{"sub":{"type":"string","description":"The subject (end-user) identifier. "},"name":{"type":"string","description":"The full name of the end-user"},"picture":{"type":"string","format":"url","description":"The URL of the profile page for the end-user."},"profile":{"type":"string","format":"url","description":"The URL to the app member profile."},"email":{"type":"string","format":"email","description":"The end-user\u2019s preferred email address."},"email_verified":{"type":"boolean","description":"True if the end-user\u2019s email address has been verified, else false."},"properties":{"type":"object","description":"Custom app member properties."}}}}}}}},"patch":{"description":"Update the data of the currently logged in app member","tags":["app","member"],"operationId":"patchCurrentAppMember","security":[{"studio":[]},{"app":[]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"picture":{"type":"string","format":"binary","description":"The member\u2019s profile picture."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The member\u2019s custom properties."},"locale":{"type":"string","description":"The preferred locale of the user."}}},"encoding":{"picture":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"description":"The patched app member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMember"}}}}}}},"/api/apps/{appId}/members":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/roles"},{"$ref":"#/components/parameters/selectedGroupId"},{"$ref":"#/components/parameters/$filter"}],"get":{"tags":["common","app","member"],"description":"Fetch all members of an app.","operationId":"queryAppMembers","security":[{"studio":[]},{"app":["openid"]},{}],"responses":{"200":{"description":"The list of app members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppMemberInfo"}}}}}}}},"/api/apps/{appId}/messages/{language}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/language"},{"in":"query","name":"merge","description":"Whether the language\u2019s messages should be merged with its base language.","schema":{"type":"string"}},{"in":"query","name":"override","description":"Whether the app\u2019s language overrides should be included and merged.","schema":{"type":"string","default":"true"}}],"delete":{"tags":["main","apps","language"],"description":"Delete the app\u2019s messages for this language.","operationId":"deleteAppMessages","responses":{"204":{"description":"The messages have successfully been deleted."}},"security":[{"studio":[]}]},"get":{"tags":["common","apps","language"],"description":"Get the app\u2019s messages for this language.","operationId":"getAppMessages","responses":{"200":{"description":"The app messages for the selected language.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMessages"}}}}}}},"/api/apps/{appId}/messages":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"merge","in":"query","schema":{"type":"boolean"}},{"name":"includeMessages","in":"query","schema":{"type":"boolean"}}],"get":{"tags":["common","apps","language"],"description":"Get a list of all languages with messages.","operationId":"getAppLanguages","responses":{"200":{"description":"The list of supported languages","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/AppMessages"}]}}}}}}},"post":{"tags":["main","apps","language"],"description":"Upload messages for the given language.","operationId":"createAppMessages","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AppMessages"},{"type":"array","items":{"$ref":"#/components/schemas/AppMessages"}}]}}}},"responses":{"201":{"description":"The translation was created.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AppMessages"},{"type":"array","items":{"$ref":"#/components/schemas/AppMessages"}}]}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/quotas/email":{"get":{"tags":["main","app","quota","email"],"operationId":"getAppEmailQuota","parameters":[{"$ref":"#/components/parameters/appId"}],"security":[{"studio":[]},{}],"responses":{"200":{"description":"Email quota for an app","content":{"application/json":{"schema":{"type":"object","properties":{"used":{"type":"number","description":"Number of emails sent today"},"limit":{"type":"number","description":"Maximum number of emails that can be sent today"},"reset":{"type":"string","format":"date-time","description":"Date and time when the quota resets"}}}}}}}}},"/api/apps/{appId}/ratings":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","rating"],"description":"Fetch all ratings of an app.","operationId":"getAppRatings","responses":{"200":{"description":"The list of apps ratings.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Rating"}}}}}}},"post":{"tags":["main","app","rating"],"description":"Submit an app rating.","operationId":"createAppRating","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["rating"],"properties":{"rating":{"$ref":"#/components/schemas/Rating/properties/rating"},"description":{"$ref":"#/components/schemas/Rating/properties/description"}}}}}},"responses":{"200":{"description":"The submitted app rating.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset/properties/id"}}}}},"security":[{"studio":[]}]}},"/api/apps/{appId}/readmes/{readmeId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/readmeId"}],"get":{"tags":["main","app","readme"],"description":"Get a readme of an app.","operationId":"getAppReadme","responses":{"200":{"description":"The app readme"}}}},"/api/apps/{appId}/reseed":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app"],"operationId":"reseedDemoApp","responses":{"200":{"description":"The app has successfully been reseeded."}},"security":[{"studio":["apps:write"]}]}},"/api/apps/{appId}/resources/{resourceType}/\\$count":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/selectedGroupId"}],"get":{"tags":["common","app","resource"],"description":"Get a count of all resources of this app.","operationId":"countAppResources","parameters":[{"$ref":"#/components/parameters/$filter"},{"$ref":"#/components/parameters/$own"}],"responses":{"200":{"description":"The count of all this app\u2019s resources of this type.","content":{"application/json":{"schema":{"type":"number"}}}}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}/subscriptions":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/endpoint"}],"get":{"tags":["common","app","resource","subscription"],"description":"Get the subscription status of a resource.","operationId":"getAppResourceSubscription","responses":{"200":{"description":"The subscription status of the resource that matches the given id.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"update":{"type":"boolean"},"delete":{"type":"boolean"}}}}}}}}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/selectedGroupId"}],"get":{"tags":["common","app","resource"],"parameters":[{"$ref":"#/components/parameters/view"},{"name":"$own","schema":{"type":"boolean"},"description":"If the resources created by the authenticated app member should be included","in":"query"}],"description":"Get a single app resource.","operationId":"getAppResourceById","responses":{"200":{"description":"The resource that matches the given id.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]},"put":{"tags":["common","app","resource"],"description":"Update an existing app resource.","operationId":"updateAppResource","requestBody":{"required":true,"$ref":"#/components/requestBodies/resource"},"responses":{"200":{"description":"The updated resource.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"patch":{"tags":["common","app","resource"],"description":"Patch an existing app resource.","operationId":"patchAppResource","requestBody":{"required":true,"$ref":"#/components/requestBodies/resource"},"responses":{"200":{"description":"The patched resource.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"delete":{"tags":["common","app","resource"],"description":"Delete an existing app resource.","operationId":"deleteAppResource","responses":{"204":{"description":"The app resource has been deleted successfully.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/subscriptions":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/endpoint"}],"get":{"tags":["common","app","resource","subscription"],"description":"Get the current subscription status of this resource.","operationId":"getAppResourceTypeSubscription","responses":{"200":{"description":"The subscription status for this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSubscription"}}}}},"security":[{"studio":[]},{"app":["openid"]},{}]}},"/api/apps/{appId}/resources/{resourceType}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/selectedGroupId"}],"get":{"tags":["common","app","resource"],"description":"Get all resources of this app.","operationId":"queryAppResources","parameters":[{"$ref":"#/components/parameters/view"},{"$ref":"#/components/parameters/$filter"},{"$ref":"#/components/parameters/$orderby"},{"$ref":"#/components/parameters/$select"},{"$ref":"#/components/parameters/$skip"},{"$ref":"#/components/parameters/$top"},{"$ref":"#/components/parameters/$own"},{"$ref":"#/components/parameters/delimiter"}],"responses":{"200":{"description":"The list of all this app\u2019s resources of this type.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}},"text/csv":{"schema":{"type":"string"}}}}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:read"]},{}]},"post":{"tags":["common","app","resource"],"description":"Create a new resource for this app.","operationId":"createAppResource","requestBody":{"required":true,"description":"The resource to create","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Resource"},{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}]}},"multipart/form-data":{"schema":{"type":"object","required":["resource"],"description":"A `multipart/form-data` representation of a resource.","additionalProperties":false,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resource.","items":{"type":"string","format":"binary"}}}}},"text/csv":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}}},"responses":{"201":{"description":"The resource that was created.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"put":{"tags":["common","app","resource"],"description":"Update existing app resources.","operationId":"updateAppResources","requestBody":{"required":true,"description":"The resources to update","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}}},"multipart/form-data":{"schema":{"type":"object","required":["resource"],"description":"A `multipart/form-data` representation of a resource.","additionalProperties":false,"properties":{"resource":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"assets":{"type":"array","description":"A list of assets that should be linked to the resources.","items":{"type":"string","format":"binary"}}}}},"text/csv":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}}},"responses":{"200":{"description":"The updated resources.","$ref":"#/components/responses/resource"}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]},"delete":{"tags":["common","app","resource"],"description":"Delete multiple app resources.","operationId":"deleteAppResources","requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"An array of resource IDs to remove.","items":{"$ref":"#/components/schemas/Resource/properties/id"}}}}},"responses":{"204":{"description":"The app resources have been deleted successfully."}},"security":[{"studio":[]},{"app":["resources:manage"]},{"cli":["resources:write"]},{}]}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}/versions":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/selectedGroupId"}],"get":{"tags":["main","app","resource","version"],"description":"Get the known history of a resource","operationId":"getAppResourceVersions","responses":{"200":{"description":"The resource that matches the given id.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/responses/resource"}}}}}},"security":[{"studio":[]},{"app":["resources:manage"]}]}},"/api/apps/{appId}/resources/{resourceType}/{resourceId}/positions":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/resourceType"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/selectedGroupId"},{"$ref":"#/components/parameters/$filter"}],"put":{"tags":["app","resource","positioning","custom-sort"],"description":"Update the current position of the resource in the order.","operationId":"updateAppResourcePosition","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"","required":["prevResourcePosition","nextResourcePosition"],"properties":{"prevResourcePosition":{"oneOf":[{"type":"number","minimum":0},{"enum":[null]}]},"nextResourcePosition":{"oneOf":[{"type":"number","minimum":0},{"enum":[null]}]}}}}}},"responses":{"200":{"description":"The subscription status of the resource that matches the given id.","content":{"application/json":{"schema":{"type":"number","description":"The updated position"}}}}},"security":[{"app":["resources:manage"]},{}]}},"/api/apps/{appId}/resources":{"parameters":[{"$ref":"#/components/parameters/appId"}],"delete":{"tags":["main","app","resource"],"description":"Delete all app seed resources.","operationId":"deleteAppSeedResources","responses":{"204":{"description":"The app resources have been deleted successfully."}},"security":[{"cli":["resources:write"]},{}]}},"/api/apps/{appId}/saml/{appSamlSecretId}/acs":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"post":{"tags":["main","app","saml"],"operationId":"assertAppSamlConsumerService","security":[{"studio":[]},{}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"RelayState":{"type":"string"},"SAMLResponse":{"type":"string"}}}}}},"responses":{"302":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{}}}}}}},"/api/apps/{appId}/saml/{appSamlSecretId}/authn":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"post":{"tags":["main","app","saml"],"operationId":"createAppSamlAuthnRequest","security":[{"studio":[]},{}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"redirectUri":{"type":"string"},"scope":{"type":"string"},"state":{"type":"string"},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]}}}}}},"responses":{"201":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{}}}}}}},"/api/apps/{appId}/saml/{appSamlSecretId}/metadata.xml":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"get":{"tags":["main","app","saml"],"operationId":"getAppSamlEntityId","responses":{"200":{"description":"Get the SAML entity ID metadata","content":{"application/xml":{"schema":{}}}}}}},"/api/apps/{appId}/scim/resource-types/{resourceTypeId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"resourceTypeId","in":"path","schema":{"type":"string"}}],"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimResourceType","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{}}}}}}},"/api/apps/{appId}/scim/resource-types":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimResourceTypes","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{}}}}}}},"/api/apps/{appId}/scim/schemas/{schemaId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"schemaId","in":"path","schema":{"type":"string"}}],"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimSchema","responses":{"200":{"description":"The SCIM Schema","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}}},"/api/apps/{appId}/scim/schemas":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimSchemas","responses":{"200":{"description":"The SCIM Schema","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}}},"/api/apps/{appId}/scim/service-provider-config":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimServiceProviderConfig","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{}}}}}}},"/api/apps/{appId}/scim/users/{userId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"userId","in":"path","description":"The ID of the member to perform the operation on","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimUser","responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}},"delete":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"deleteAppScimUser","responses":{"204":{"description":"SCIM user"}}},"put":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"updateAppScimUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/scim+json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"SCIM user"}}},"patch":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"patchAppScimUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/scim+json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"SCIM user"}}}},"/api/apps/{appId}/scim/users":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"createAppScimUser","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}},"application/scim+json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"201":{"description":"Integrated SCIM user schema","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}},"get":{"tags":["main","app","scim"],"security":[{"scim":[]}],"operationId":"getAppScimUsers","parameters":[{"name":"count","in":"query","schema":{"type":"number"}},{"name":"startIndex","in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"SCIM user","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/ScimUser"}}}}}}},"/api/apps/{appId}/screenshots/{screenshotId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/screenshotId"}],"get":{"tags":["main","app","screenshot"],"description":"Get a screenshot of an app.","operationId":"getAppScreenshot","responses":{"200":{"description":"The app screenshot"}}},"delete":{"tags":["main","app","screenshot"],"description":"Delete an existing screenshot.","operationId":"deleteAppScreenshot","responses":{"200":{"description":"The screenshot has been successfully deleted."}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/screenshots":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app","screenshot"],"description":"Add one or multiple screenshots of an app.","operationId":"createAppScreenshot","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"screenshots":{"type":"array","description":"Screenshots to showcase in the store","minItems":1,"items":{"type":"string","format":"binary"}},"language":{"type":"string","description":"The language for which the screenshots will be uploaded"}}},"encoding":{"screenshots":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"description":"The screenshots have been successfully created.","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","description":"The ID of the newly created screenshot."}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}/verify":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appOAuth2SecretId"}],"post":{"tags":["main","app","secret","oauth2"],"operationId":"verifyAppOAuth2SecretCode","security":[{"studio":[]},{}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["code","scope","redirectUri","timezone"],"properties":{"code":{"type":"string"},"scope":{"type":"string"},"redirectUri":{"type":"string"},"timezone":{"type":"string"}}}}}},"responses":{"200":{"description":"\n Get a partial app OAuth2 secret\n\n Only public facing values are output on this endpoint.\n ","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"}}}}}}}}},"/api/apps/{appId}/secrets/oauth2/{appOAuth2SecretId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appOAuth2SecretId"}],"get":{"tags":["main","app","secret","oauth2"],"operationId":"getAppOAuth2Secret","responses":{"200":{"description":"\n Get a partial app OAuth2 secret\n\n Only public facing values are output on this endpoint.\n ","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}}},"put":{"tags":["main","app","secret","oauth2"],"operationId":"updateAppOAuth2Secret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated OAuth2 secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}},"delete":{"tags":["main","app","secret","oauth2"],"operationId":"deleteAppOAuth2Secret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted OAuth2 secret."}}}},"/api/apps/{appId}/secrets/oauth2":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app","secret","oauth2"],"operationId":"createAppOAuth2Secret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}},"security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"201":{"description":"A list of the OAuth2 secrets for the app.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}},"get":{"tags":["main","app","secret","oauth2"],"operationId":"getAppOAuth2Secrets","security":[{"studio":[]}],"responses":{"200":{"description":"A list of the OAuth2 secrets for the app.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppOAuth2Secret"}}}}}}},"delete":{"tags":["main","app","secret","oauth2"],"operationId":"deleteAppOAuth2Secrets","security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"204":{"description":"The deleted app OAuth2 secrets."}}}},"/api/apps/{appId}/secrets/saml/{appSamlSecretId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appSamlSecretId"}],"put":{"tags":["main","app","secret","saml"],"operationId":"updateAppSamlSecret","requestBody":{"content":{"application/json":{"schema":{}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated SAML secret.","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["main","app","secret","saml"],"operationId":"deleteAppSamlSecret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted SAML secret."}}}},"/api/apps/{appId}/secrets/saml":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app","secret","saml"],"operationId":"createAppSamlSecret","requestBody":{"content":{"application/json":{"schema":{}}}},"security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"201":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{}}}}}},"get":{"tags":["main","app","secret","saml"],"operationId":"getAppSamlSecrets","security":[{"studio":[]}],"responses":{"200":{"description":"A list of the SAML secrets for the app.","content":{"application/json":{"schema":{"type":"array","items":{}}}}}}},"delete":{"tags":["main","app","secret","saml"],"operationId":"deleteAppSamlSecrets","security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"204":{"description":"The deleted app saml secrets."}}}},"/api/apps/{appId}/secrets/scim":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","secret","scim"],"operationId":"getAppScimSecret","description":"Get app SCIM secret configuration","security":[{"studio":[]}],"responses":{"200":{"description":"The app SCIM configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSecret"}}}}}},"patch":{"tags":["main","app","secret","scim"],"operationId":"updateAppScimSecret","description":"Update app SCIM secret configuration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSecret"}}}},"security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"200":{"description":"The app SCIM configuration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScimSecret"}}}}}}},"/api/apps/{appId}/secrets/service/{serviceSecretId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/serviceSecretId"}],"put":{"tags":["main","app","secret","service"],"operationId":"updateAppServiceSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated app service secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}}}},"delete":{"tags":["main","app","secret","service"],"operationId":"deleteAppServiceSecret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted app service secret."}}}},"/api/apps/{appId}/secrets/service":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app","secret","service"],"operationId":"createAppServiceSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}},"security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"201":{"description":"The created app service secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppServiceSecret"}}}}}},"get":{"tags":["main","app","secret","service"],"operationId":"getAppServiceSecrets","security":[{"studio":[]}],"responses":{"200":{"description":"The list of app service secrets.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppServiceSecret"}}}}}}},"delete":{"tags":["main","app","secret","service"],"operationId":"deleteAppServiceSecrets","security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"204":{"description":"The deleted app service secrets."}}}},"/api/apps/{appId}/secrets/ssl":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","secret","ssl"],"description":"Get the SSL certificate of an app","operationId":"getAppSslSecret","responses":{"200":{"description":"The SSL secret of the app.","$ref":"#/components/schemas/SSLSecret"}},"security":[{"studio":[]}]},"put":{"tags":["main","app","secret","ssl"],"description":"Update the app\u2019s SSL secret","operationId":"updateAppSslSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSLSecret"}}}},"responses":{"200":{"description":"The updated SSL secret.","$ref":"#/components/schemas/SSLSecret"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/secrets/webhook/{webhookSecretId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/webhookSecretId"}],"get":{"tags":["main","app","secret","webhook"],"operationId":"getAppWebhookSecret","security":[{"studio":[]}],"responses":{"200":{"description":"The requested webhook secret.","content":{"application/json":{"schema":{"type":"object","properties":{"secret":{"type":"string"}}}}}}}},"put":{"tags":["main","app","secret","webhook"],"operationId":"updateAppWebhookSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppWebhookSecret"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated app webhook secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppWebhookSecret"}}}}}},"delete":{"tags":["main","app","secret","webhook"],"operationId":"deleteAppWebhookSecret","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted app webhook secret."}}}},"/api/apps/{appId}/secrets/webhook":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["main","app","secret","webhook"],"operationId":"createAppWebhookSecret","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppWebhookSecret"}}}},"security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"201":{"description":"The created app webhook secret.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppWebhookSecret"}}}}}},"get":{"tags":["main","app","secret","webhook"],"operationId":"getAppWebhookSecrets","security":[{"studio":[]}],"responses":{"200":{"description":"The list of app webhook secrets.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppWebhookSecret"}}}}}}}},"/api/apps/{appId}/snapshots/{snapshotId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"name":"snapshotId","in":"path","description":"The ID of the snapshot","required":true,"schema":{"type":"number","description":"The ID of the snapshot."}}],"get":{"tags":["main","app","snapshot"],"description":"Get a single snapshot made of the app.","operationId":"getAppSnapshot","responses":{"200":{"description":"The snapshot","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the snapshot."},"yaml":{"type":"string","description":"The app definition."},"$created":{"type":"string","format":"date-time","description":"The creation date of the snapshot."},"$author":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/User/properties/id"},"name":{"$ref":"#/components/schemas/User/properties/name"}}}}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/snapshots":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","snapshot"],"description":"Get a list of snapshots made of the app.","operationId":"getAppSnapshots","responses":{"200":{"description":"The available snapshots","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"The ID of the snapshot."},"$created":{"type":"string","format":"date-time","description":"The creation date of the snapshot."},"$author":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/User/properties/id"},"name":{"$ref":"#/components/schemas/User/properties/name"}}}}}}}}}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/style/block/@{organizationId}/{blockId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["common","app"],"description":"Get the app style for a block.","operationId":"getAppBlockStyle","responses":{"200":{"description":"The stylesheet associated with this block for this app.","content":{"text/css":{}}}}},"post":{"tags":["main","app","block"],"description":"Upload a block stylesheet for this app.","operationId":"setAppBlockStyle","requestBody":{"description":"The new app block stylesheet.","content":{"application/json":{"schema":{"type":"object","required":["style"],"properties":{"style":{"type":"string"},"force":{"type":"boolean","writeOnly":true,"description":"If this is true, the app lock is ignored."}}}}}},"responses":{"204":{"description":"The block style has been updated successfully."}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/apps/{appId}/style/core":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app"],"description":"Get the core style for this app.","operationId":"getAppCoreStyle","responses":{"200":{"description":"The core stylesheet associated with this app.","content":{"text/css":{}}}}}},"/api/apps/{appId}/style/shared":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app"],"description":"Get the shared style for this app.","operationId":"getAppSharedStyle","responses":{"200":{"description":"The shared stylesheet associated with this app.","content":{"text/css":{}}}}}},"/api/apps/{appId}/subscriptions":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app","subscription"],"parameters":[{"$ref":"#/components/parameters/endpoint"}],"description":"Fetch all subscription settings of an app.","operationId":"getAppSubscription","responses":{"200":{"description":"The subscription settings.","$ref":"#/components/responses/subscriptions"}}},"post":{"tags":["main","app","subscription"],"description":"Subscribe to an app\u2019s push notifications","operationId":"createAppSubscription","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"A serialized PushSubscription object","required":["endpoint","keys"],"properties":{"endpoint":{"type":"string"},"keys":{"type":"object","required":["p256dh","auth"],"properties":{"p256dh":{"type":"string"},"auth":{"type":"string"}}}}}}}},"responses":{"204":{"description":"The subscription has successfully been registered."}},"security":[{"studio":[]},{"app":["openid"]},{}]},"patch":{"tags":["main","app","subscription"],"description":"Subscribe to an app\u2019s push notifications. If value isn\u2019t set it will toggle between subscribing and unsubscribing.","operationId":"updateAppSubscription","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["endpoint","resource","action"],"properties":{"endpoint":{"type":"string","format":"uri"},"resource":{"type":"string"},"action":{"type":"string","enum":["create","update","delete"]},"value":{"type":"boolean"},"resourceId":{"type":"number"}}}}}},"responses":{"204":{"description":"The subscription has successfully been updated."}},"security":[{"studio":[]},{"app":["openid"]},{}]}},"/api/apps/{appId}/variables/{appVariableId}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/appVariableId"}],"put":{"tags":["main","app","variable"],"operationId":"updateAppVariable","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVariable"}}}},"security":[{"studio":[]}],"responses":{"200":{"description":"The updated app variable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVariable"}}}}}},"delete":{"tags":["main","app","variable"],"operationId":"deleteAppVariable","security":[{"studio":[]}],"responses":{"204":{"description":"The deleted app variable."}}}},"/api/apps/{appId}/variables":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["common","app","variable"],"operationId":"getAppVariables","responses":{"200":{"description":"The list of app variables.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppVariable"}}}}}}},"post":{"tags":["main","app","variable"],"operationId":"createAppVariable","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVariable"}}}},"security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"201":{"description":"The created app variable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppVariable"}}}}}},"delete":{"tags":["main","app","variable"],"operationId":"deleteAppVariables","security":[{"studio":[]},{"cli":["apps:write"]}],"responses":{"204":{"description":"The deleted app variables."}}}},"/api/apps/{appId}/webhooks/{webhookName}":{"parameters":[{"$ref":"#/components/parameters/appId"},{"$ref":"#/components/parameters/webhookName"}],"post":{"tags":["main","app","webhook"],"description":"Call a webhook defined in the app","operationId":"callAppWebhook","responses":{"200":{"description":"The webhook was called successfully."}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true}},"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"security":[{"webhook":[]}]}},"/api/apps/{appId}":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"tags":["main","app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get a single app","operationId":"getAppById","responses":{"200":{"description":"The app that matches the given id.","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{}]},"patch":{"tags":["main","app"],"description":"Update parts of an existing app","operationId":"patchApp","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"domain":{"$ref":"#/components/schemas/App/properties/domain"},"path":{"$ref":"#/components/schemas/App/properties/path"},"visibility":{"$ref":"#/components/schemas/App/properties/visibility"},"template":{"$ref":"#/components/schemas/App/properties/template"},"demoMode":{"$ref":"#/components/schemas/App/properties/demoMode"},"force":{"type":"boolean","description":"Whether the locked property should be ignored."},"yaml":{"type":"string","description":"The original YAML definition used to define the app."},"icon":{"type":"string","format":"binary","description":"The app icon."},"maskableIcon":{"type":"string","format":"binary","description":"The app icon."},"iconBackground":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$"},"coreStyle":{"type":"string","description":"The custom style to apply to the core app."},"sharedStyle":{"type":"string","description":"The custom style to apply to all parts of app."},"screenshots":{"type":"array","description":"Screenshots to showcase in the store","items":{"type":"string","format":"binary"}},"readmes":{"type":"array","description":"Readmes to showcase in the store","items":{"type":"string","format":"binary"}},"controllerCode":{"type":"string","description":"Custom app logic as a JavaScript string"},"controllerImplementations":{"type":"string","description":"Appsemble SDK interfaces implementations"},"showAppsembleLogin":{"type":"boolean","description":"Whether the Appsemble login method should be shown."},"showAppsembleOAuth2Login":{"type":"boolean","description":"Whether the Appsemble OAuth2 login method should be shown."},"enableSelfRegistration":{"type":"boolean","description":"Whether new users should be able to register themselves."},"displayAppMemberName":{"$ref":"#/components/schemas/App/properties/displayAppMemberName"},"displayInstallationPrompt":{"$ref":"#/components/schemas/App/properties/displayInstallationPrompt"},"emailName":{"type":"string","description":"The name used for emails."},"emailHost":{"type":"string","description":"The hostname of the SMTP server."},"emailPassword":{"type":"string","description":"The password to use for SMTP authentication. This gets encrypted when stored."},"emailUser":{"type":"string","description":"The username used to authenticate against the SMTP server."},"emailPort":{"type":"string","description":"The port used for the SMTP server."},"emailSecure":{"type":"boolean","description":"Whether TLS is being used."},"containers":{"type":"array","items":{"$ref":"#/components/schemas/ContainerDefinition"}}}},"encoding":{"coreStyle":{"contentType":"text/css"},"sharedStyle":{"contentType":"text/css"},"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"description":"The updated app.","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{"cli":["apps:write"]}]},"delete":{"tags":["main","app"],"description":"Delete an existing app","operationId":"deleteApp","responses":{"204":{"description":"The app was successfully deleted."}},"security":[{"studio":[]},{"cli":["apps:delete"]}]}},"/api/apps/{appId}/auth/email/login":{"post":{"tags":["app","auth","email"],"description":"Login using the Appsemble studio.","operationId":"loginAppMemberWithEmail","responses":{"200":{"description":"Logged in successfully."}},"security":[{"basic":[]}]}},"/api/apps/{appId}/auth/email/register":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app","auth","email"],"description":"Register a new app account using an email address and a password.","operationId":"registerAppMemberWithEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["email","password","timezone"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8},"picture":{"type":"string","format":"binary","description":"The account\u2019s profile picture."},"properties":{"type":"object","additionalProperties":{"type":"string"},"description":"The member\u2019s custom properties."},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]}}}}}},"responses":{"201":{"description":"The account that was created."}}}},"/api/apps/{appId}/auth/email/resend-verification":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app","auth","email"],"description":"Resend the verification code for a registered email.","operationId":"resendAppMemberEmailVerification","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The verification email was sent if an account was found in the database."}},"security":[{"app":["email"]}]}},"/api/apps/{appId}/auth/email/request-password-reset":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app","auth","email"],"description":"Request a reset token for resetting passwords.","operationId":"requestAppMemberPasswordReset","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The request has been received and an email was sent if it exists."}}}},"/api/apps/{appId}/auth/email/reset-password":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app","auth","email"],"description":"Reset a password using a password reset token.","operationId":"resetAppMemberPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password","token"],"properties":{"password":{"type":"string","minLength":8},"token":{"type":"string"}}}}}},"responses":{"204":{"description":"The password has been reset."}}}},"/api/apps/{appId}/auth/email/verify":{"parameters":[{"$ref":"#/components/parameters/appId"}],"post":{"tags":["app","auth","email"],"description":"Verify the email address of a registered user.","operationId":"verifyAppMemberEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string"}}}}}},"responses":{"200":{"description":"The account was successfully verified."}}}},"/api/apps":{"post":{"tags":["main","app"],"description":"Create a new app","operationId":"createApp","parameters":[{"in":"query","name":"dryRun","description":"Validate whether an app could be created without actually creating one. Must be set to \u2018true\u2019.","schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["OrganizationId","yaml"],"properties":{"domain":{"$ref":"#/components/schemas/App/properties/domain"},"path":{"$ref":"#/components/schemas/App/properties/path"},"visibility":{"$ref":"#/components/schemas/App/properties/visibility"},"template":{"$ref":"#/components/schemas/App/properties/template"},"demoMode":{"$ref":"#/components/schemas/App/properties/demoMode"},"yaml":{"type":"string","description":"The original YAML definition used to define the app."},"OrganizationId":{"$ref":"#/components/schemas/Organization/properties/id"},"icon":{"type":"string","format":"binary","description":"The app icon."},"maskableIcon":{"type":"string","format":"binary","description":"The app icon."},"iconBackground":{"type":"string","pattern":"^#[\\dA-Fa-f]{6}$","description":"The background color to use for the maskable icon."},"coreStyle":{"type":"string","description":"The custom style to apply to the core app."},"sharedStyle":{"type":"string","description":"The custom style to apply to all parts of app."},"screenshots":{"type":"array","description":"Screenshots to showcase in the store","items":{"type":"string","format":"binary"}},"readmes":{"type":"array","description":"Readmes to showcase in the store","items":{"type":"string","format":"binary"}},"controllerCode":{"type":"string","description":"Custom app logic as a JavaScript string"},"controllerImplementations":{"type":"string","description":"Appsemble SDK interfaces implementations"}}},"encoding":{"coreStyle":{"contentType":"text/css"},"sharedStyle":{"contentType":"text/css"},"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"},"screenshots":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"description":"The app that was created.","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{"cli":["apps:write"]}]},"get":{"tags":["main","app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get all publically available apps.","operationId":"queryApps","responses":{"200":{"description":"The list of all public apps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}}}},"security":[{"studio":[]},{}]}},"/api/app-templates":{"get":{"tags":["main","app","template"],"description":"Fetch a list of all available templates.","operationId":"getAppTemplates","responses":{"200":{"description":"The list of all available templates.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"template":{"type":"string","description":"The name of the template."},"description":{"type":"string","description":"The description of the template."},"resources":{"type":"boolean","description":"Whether this template supports pre-made resources"}}}}}}}},"security":[{"studio":[]}]},"post":{"tags":["main","app","template"],"description":"Register a new app using a template.","operationId":"createAppFromTemplate","requestBody":{"description":"The template to use for app creation.","content":{"application/json":{"schema":{"type":"object","required":["templateId","organizationId"],"properties":{"templateId":{"type":"number","description":"The ID of the template."},"name":{"$ref":"#/components/schemas/AppDefinition/properties/name"},"description":{"$ref":"#/components/schemas/AppDefinition/properties/description"},"organizationId":{"$ref":"#/components/schemas/Organization/properties/id"},"resources":{"type":"boolean","description":"Include example resources."},"assets":{"type":"boolean","description":"Include example assets."},"variables":{"type":"boolean","description":"Include example variables."},"secrets":{"type":"boolean","description":"Include example secrets."},"visibility":{"$ref":"#/components/schemas/App/properties/visibility"}}}}}},"responses":{"201":{"$ref":"#/components/responses/app"}},"security":[{"studio":[]}]}},"/api/auth/email/login":{"post":{"tags":["main","auth","email"],"description":"Login using the Appsemble studio.","operationId":"loginUserWithEmail","responses":{"200":{"description":"Logged in successfully."}},"security":[{"basic":[]}]}},"/api/auth/email/register":{"post":{"tags":["main","auth","email"],"description":"Register a new studio account using an email address and a password.","operationId":"registerUserWithEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"},"password":{"type":"string","minLength":8},"timezone":{"enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/La_Rioja","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Fort_Nelson","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Monticello","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montserrat","America/Nassau","America/New_York","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Ojinaga","America/Panama","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Whitehorse","America/Winnipeg","America/Yakutat","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Colombo","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Hebron","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Katmandu","Asia/Khandyga","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ulaanbaatar","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/Perth","Australia/Sydney","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Ulyanovsk","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis"]},"subscribed":{"type":"boolean","default":false}}}}}},"responses":{"201":{"description":"The account that was created."}}}},"/api/auth/email/reset-password":{"post":{"tags":["main","auth","email"],"description":"Reset a password using a password reset token.","operationId":"resetUserPassword","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["password","token"],"properties":{"password":{"type":"string","minLength":8},"token":{"type":"string"}}}}}},"responses":{"204":{"description":"The password has been reset."}}}},"/api/auth/email/patch-password":{"post":{"tags":["main","auth","email"],"description":"Update password","operationId":"patchPassword","responses":{"200":{"description":"Password changed."}},"security":[{"studio":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["newPassword","currentPassword"],"properties":{"newPassword":{"type":"string","minLength":8},"currentPassword":{"type":"string"}}}}}}}},"/api/auth/email/resend-verification":{"post":{"tags":["main","auth","email"],"description":"Resend the verification code for a registered email.","operationId":"resendUserEmailVerification","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The verification email was sent if an account was found in the database."}},"security":[{"studio":[]}]}},"/api/auth/email/request-password-reset":{"post":{"tags":["main","auth","email"],"description":"Request a reset token for resetting passwords.","operationId":"requestUserPasswordReset","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The request has been received and an email was sent if it exists."}}}},"/api/auth/email/verify":{"post":{"tags":["main","auth","email"],"description":"Verify the email address of a registered user.","operationId":"verifyUserEmail","requestBody":{"description":"The user account to register.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["token"],"properties":{"token":{"type":"string"}}}}}},"responses":{"200":{"description":"The account was successfully verified."}}}},"/api/auth/oauth2/authorizations/connect":{"post":{"description":"Create an account using an OAuth2 authorization.","tags":["main","auth","oauth2","authorization"],"operationId":"connectOAuth2Authorization","requestBody":{"description":"The OAuth2 client credentials","required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["code","authorizationUrl","timezone"],"properties":{"code":{"type":"string"},"authorizationUrl":{"type":"string"},"timezone":{"type":"string"}}}}}},"responses":{"200":{"description":"An access token response.","content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"studio":[]},{}]}},"/api/auth/oauth2/authorizations/register":{"post":{"tags":["main","auth","oauth2","authorization"],"operationId":"registerOAuth2Authorization","description":"asd","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["authorizationUrl","code"],"properties":{"authorizationUrl":{"type":"string"},"code":{"type":"string"}}}}}},"responses":{"200":{"description":""}}}},"/api/auth/refresh-token":{"post":{"tags":["main","auth"],"description":"Refresh an access token using the Appsemble studio","operationId":"refreshToken","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string","description":"The refresh token to use for refreshing the session."}}}}}},"responses":{"200":{"description":"The token has been refreshed successfully."}}}},"/api/blocks/@{organizationId}/{blockId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["common","block"],"description":"Get a single block","operationId":"getBlock","responses":{"200":{"description":"The latest version of the block that matches the given id.","$ref":"#/components/responses/blockVersion"}}}},"/api/blocks/@{organizationId}/{blockId}/versions":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["common","block","version"],"description":"Retrieves all available versions of a block.","operationId":"getBlockVersions","responses":{"200":{"description":"A list of versions of a block.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockVersion"}}}}}}}},"/api/blocks/@{organizationId}/{blockId}/versions/list":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"}],"get":{"tags":["main","block","version"],"description":"Retrieve a string list of all versions of a block.","operationId":"getBlockVersionsList","responses":{"200":{"description":"String list of all versions of a block.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"}],"get":{"tags":["common","block","version"],"description":"Retrieve a single block version.","operationId":"getBlockVersion","responses":{"200":{"$ref":"#/components/responses/blockVersion"}}},"delete":{"tags":["main","block","version"],"description":"Delete a single block version.","operationId":"deleteBlockVersion","responses":{"204":{"description":"Block version has successfully been deleted"}},"security":[{"cli":["blocks:delete"]}]}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/icon":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"}],"get":{"tags":["common","block","version"],"description":"Get the icon of a block version.","operationId":"getBlockVersionIcon","responses":{"200":{"description":"The icon that represents the block."}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/messages/{language}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"},{"in":"path","name":"language","schema":{"type":"string"},"description":"The language to get messages for.","required":true}],"get":{"tags":["common","block","version","translation"],"description":"Get internationalized messages for a block.","operationId":"getBlockVersionMessages","responses":{"200":{"description":"A key/value mapping of block messages.","content":{"application/json":{"schema":{"type":"object","description":"A key/value mapping of block messages.","additionalProperties":{"type":"string","description":"A translated block message."}}}}}}}},"/api/blocks/@{organizationId}/{blockId}/versions/{blockVersion}/asset":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/blockId"},{"$ref":"#/components/parameters/blockVersion"},{"name":"filename","in":"query","description":"The file name of the block asset to download","schema":{"type":"string"}}],"get":{"tags":["common","block","version","asset"],"description":"Download a single block asset","operationId":"getBlockVersionAsset","responses":{"200":{"description":"The asset that has been requested."}}}},"/api/blocks":{"post":{"tags":["main","block"],"description":"Publish a block.","operationId":"createBlock","requestBody":{"description":"The new block version to publish.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/BlockVersion"}}}},"responses":{"201":{"$ref":"#/components/responses/blockVersion"}},"security":[{"cli":["blocks:write"]}]},"get":{"tags":["common","block"],"description":"Get all block\u2019s latest definitions.","operationId":"queryBlocks","responses":{"200":{"description":"The list of all latest block versions.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockVersion"}}}}}},"security":[{"studio":[]},{}]}},"/api/containers/{appId}/logs/{container}":{"get":{"tags":["container"],"description":"Retrieve the logs related to a companion container","operationId":"getContainerLogs","parameters":[{"name":"appId","schema":{"type":"number"},"description":"Id of the app which defines the companion container","in":"path"},{"name":"container","schema":{"type":"string"},"description":"Name of the companion container to fetch the logs for","in":"path"}],"responses":{"200":{"description":"Logs of the container running in a specific app","content":{"application/json":{"schema":{"type":"array","items":{}}}}}},"security":[{"studio":[]}]}},"/api/health":{"get":{"tags":["main"],"description":"Check whether or not the API is healthy","operationId":"checkHealth","responses":{"200":{"description":"An indication the server is healthy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}},"/api/messages/{language}":{"parameters":[{"$ref":"#/components/parameters/language"}],"get":{"tags":["main","translation"],"description":"Get the Appsemble messages for this language.","operationId":"getStudioMessages","responses":{"200":{"description":"The app messages for the selected language.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMessages"}}}}}}},"/api/messages":{"parameters":[{"name":"context","in":"query","schema":{"type":"string","enum":["studio","app"]}}],"get":{"tags":["common","translation"],"description":"Get a list of all languages with messages.","operationId":"getAppsembleLanguages","responses":{"200":{"description":"The list of supported languages","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/organization-invites/{token}/respond":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"post":{"tags":["main","organization","invite"],"description":"Respond to a given invitation.","operationId":"respondOrganizationInvite","requestBody":{"description":"The response of the invitation.\n\n If response is true, user will join the organization. If response is false, the user declines the invite and the invite is removed.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["response"],"properties":{"response":{"type":"boolean"}}}}}},"responses":{"204":{"description":"The response has been processed."}},"security":[{"studio":[]}]}},"/api/organization-invites/{token}":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"get":{"tags":["main","organization","invite"],"description":"Fetch information about an invite.","operationId":"getOrganizationInvite","responses":{"200":{"description":"An invite response","$ref":"#/components/responses/invite"}}}},"/api/organizations/{organizationId}/app-collections":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["main","organization","app-collection"],"description":"Get a list of app collections for an organization","operationId":"queryOrganizationAppCollections","parameters":[{"name":"organizationId","in":"path","description":"The id of the organization","required":true,"schema":{"$ref":"#/components/schemas/Organization/properties/id"}}],"responses":{"200":{"description":"A list of app collections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppCollection"}}}}}},"security":[{"studio":[]},{}]},"post":{"tags":["main","organization","app-collection"],"description":"Create an app collection","operationId":"createOrganizationAppCollection","requestBody":{"description":"The app collection to create","required":true,"content":{"multipart/form-data":{"schema":{"allOf":[{"$ref":"#/components/schemas/AppCollectionDefinition"},{"required":["name","expertName","expertProfileImage","headerImage"]}]},"encoding":{"expertProfileImage":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"},"headerImage":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"description":"The created app collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppCollection"}}}}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/apps/import":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"post":{"tags":["main","app"],"description":"Import an app from a zip file","operationId":"importApp","requestBody":{"content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"App imported successfully","$ref":"#/components/responses/app"}},"security":[{"studio":[]},{"cli":["apps:write"]}]}},"/api/organizations/{organizationId}/apps":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["main","organization","app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get a list of an organization\u2019s apps. Private apps are excluded unless the user is in the organization.","operationId":"getOrganizationApps","responses":{"200":{"description":"The list of this organization\u2019s apps.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}}}},"security":[{"studio":[]},{}]}},"/api/organizations/{organizationId}/blocks":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["main","organization","block"],"description":"Get a list of an organization\u2019s blocks.","operationId":"getOrganizationBlocks","responses":{"200":{"description":"The list of this organization\u2019s blocks.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BlockVersion"}}}}}},"security":[{"studio":[]},{}]}},"/api/organizations/{organizationId}/icon":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["organization"],"description":"Get the organization icon.","operationId":"getOrganizationIcon","responses":{"200":{"description":"The icon that represents the organization."}}}},"/api/organizations/{organizationId}/invites/resend":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"post":{"tags":["organization"],"description":"Request to resend an invitation.","operationId":"resendOrganizationInvite","requestBody":{"description":"The email of the person to resend the invitation to.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}}}}},"responses":{"204":{"description":"The invite has been sent."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/invites":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["main","organization","invite"],"description":"Get a list of invited organization members.","operationId":"getOrganizationInvites","responses":{"200":{"description":"The list of all invites.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["Member","AppTranslator","AppContentsExplorer","AppContentsManager","AppMemberManager","AppGroupManager","AppGroupMembersManager","AppManager","AppCollectionManager","BlockManager","Maintainer","Owner"]}}}}}}}},"security":[{"studio":[]}]},"post":{"tags":["main","organization","invite"],"description":"Invite a new member to the organization that matches the given id.","operationId":"createOrganizationInvites","requestBody":{"description":"The member to invite.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["email","role"],"properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["Member","AppTranslator","AppContentsExplorer","AppContentsManager","AppMemberManager","AppGroupManager","AppGroupMembersManager","AppManager","AppCollectionManager","BlockManager","Maintainer","Owner"]}}}}}}},"responses":{"201":{"description":"The newly invited member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"studio":[]}]},"delete":{"tags":["main","organization","invite"],"description":"Revoke a member invitation.","operationId":"deleteOrganizationInvite","requestBody":{"description":"The email address to revoke the invite of.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The invitation has been successfully revoked."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/members/{organizationMemberId}/role":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"name":"organizationMemberId","in":"path","description":"The ID of the member","required":true,"schema":{"$ref":"#/components/schemas/User/properties/id"}}],"put":{"tags":["main","organization","member"],"description":"Set the role of the member within the organization.","operationId":"updateOrganizationMemberRole","requestBody":{"description":"The role to set.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["Member","AppTranslator","AppContentsExplorer","AppContentsManager","AppMemberManager","AppGroupManager","AppGroupMembersManager","AppManager","AppCollectionManager","BlockManager","Maintainer","Owner"]}}}}}},"responses":{"200":{"description":"The member\u2019s role has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationMember"}}}}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/members/{organizationMemberId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"},{"name":"organizationMemberId","in":"path","description":"The ID of the member to remove","required":true,"$ref":"#/components/schemas/User/properties/id","schema":{"$ref":"#/components/schemas/User/properties/id"}}],"delete":{"tags":["main","organization","member"],"description":"Remove a member from the organization that matches the given id, or leave the organization if the member id matches the user\u2019s member id","operationId":"removeOrganizationMember","responses":{"204":{"description":"The member has been successfully removed."}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}/members":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["main","organization","member"],"description":"Get a list of organization members.","operationId":"getOrganizationMembers","responses":{"200":{"description":"The list of all members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationMember"}}}}}},"security":[{"studio":[]}]}},"/api/organizations/{organizationId}":{"parameters":[{"$ref":"#/components/parameters/organizationId"}],"get":{"tags":["main","organization"],"description":"Get a single organization.","operationId":"getOrganization","responses":{"200":{"$ref":"#/components/responses/organization"}}},"patch":{"tags":["main","organization"],"description":"Update an organization","operationId":"patchOrganization","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Organization/properties/name"},"description":{"$ref":"#/components/schemas/Organization/properties/description"},"email":{"$ref":"#/components/schemas/Organization/properties/email"},"website":{"$ref":"#/components/schemas/Organization/properties/website"},"icon":{"type":"string","format":"binary","description":"The organization icon."}}},"encoding":{"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"$ref":"#/components/responses/organization"}},"security":[{"studio":[]},{"cli":["organizations:write"]}]},"delete":{"tags":["main","organization"],"description":"Delete an organization.","operationId":"deleteOrganization","responses":{"200":{"description":"successfully deleted organization"}},"security":[{"studio":[]},{}]}},"/api/organizations":{"get":{"tags":["main","organization"],"description":"Fetch the list of organizations.","operationId":"getOrganizations","responses":{"200":{"description":"The list of of organizations","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Organization"}}}}}}},"post":{"tags":["main","organization"],"description":"Create a new organization.","operationId":"createOrganization","requestBody":{"description":"The organization to create","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Organization/properties/id"},"name":{"$ref":"#/components/schemas/Organization/properties/name"},"description":{"$ref":"#/components/schemas/Organization/properties/description"},"email":{"$ref":"#/components/schemas/Organization/properties/email"},"website":{"$ref":"#/components/schemas/Organization/properties/website"},"icon":{"type":"string","format":"binary","description":"The organization icon."}}},"encoding":{"icon":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"201":{"$ref":"#/components/responses/organization"}},"security":[{"studio":[]},{"cli":["organizations:write"]}]}},"/api/ssl":{"get":{"tags":["main"],"description":"Check the SSL certificate status for the given domain names.","operationId":"getSslStatus","parameters":[{"in":"query","name":"domains","required":true,"schema":{"type":"array","items":{"type":"string","format":"hostname"}}}],"responses":{"200":{"description":"A mapping of domain name to their SSL status","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"enum":["error","missing","pending","ready","unknown"]}}}}}}}},"/api/group-invites/{token}/respond":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"post":{"tags":["group-invite"],"description":"Respond to a given invitation.","operationId":"respondGroupInvite","requestBody":{"description":"The response of the invitation.\n\n If response is true, user will join the app. If response is false, the user declines the invite and the invite is removed.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["response"],"properties":{"response":{"type":"boolean"}}}}}},"responses":{"204":{"description":"The response has been processed."}},"security":[{"app":[]}]}},"/api/group-invites/{token}":{"parameters":[{"name":"token","in":"path","description":"The token of the invite.","required":true,"schema":{"type":"string"}}],"get":{"tags":["group-invite"],"description":"Fetch information about an invite.","operationId":"getGroupInvite","responses":{"200":{"description":"An invite response","$ref":"#/components/responses/invite"}}}},"/api/group-members/{groupMemberId}/role":{"parameters":[{"$ref":"#/components/parameters/groupMemberId"}],"put":{"tags":["common","group-member"],"description":"Set the role of a member within a group.","operationId":"updateGroupMemberRole","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"requestBody":{"description":"The role to set.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["role"],"properties":{"role":{"type":"string"}}}}}},"responses":{"200":{"description":"The member\u2019s role has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMember"}}}}},"security":[{"studio":[]},{"app":[]},{"cli":["groups:write"]}]}},"/api/group-members/{groupMemberId}":{"parameters":[{"$ref":"#/components/parameters/groupMemberId"}],"get":{"tags":["common","group-member"],"description":"Get a certain group member from a group","operationId":"getGroupMember","responses":{"200":{"description":"The specified group member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMember"}}}}},"security":[{"studio":[]},{"app":[]}]},"delete":{"tags":["common","group-member"],"description":"Remove a member from a group.","operationId":"deleteGroupMember","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"responses":{"204":{"description":"The group member has been removed successfully."}},"security":[{"studio":[]},{"app":[]},{"cli":["groups:write"]}]}},"/api/groups/{groupId}/invites/resend":{"parameters":[{"$ref":"#/components/parameters/groupId"}],"post":{"tags":["group"],"description":"Request to resend an invitation.","operationId":"resendGroupInvite","requestBody":{"description":"The email of the person to resend the invitation to.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string"}}}}}},"responses":{"204":{"description":"The invite has been sent."}},"security":[{"studio":[]}]}},"/api/groups/{groupId}/invites":{"parameters":[{"name":"groupId","in":"path","description":"The ID of the group","required":true,"schema":{"type":"number","readOnly":true}}],"get":{"tags":["group","invite"],"description":"Get a list of invited group members.","operationId":"getGroupInvites","responses":{"200":{"description":"The list of all invites.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string"}}}}}}}},"security":[{"studio":[]}]},"post":{"tags":["group","invite"],"description":"Invite a new user to a group.","operationId":"createGroupInvites","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"requestBody":{"description":"The group invite to create.","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["email","role"],"properties":{"email":{"type":"string","format":"email","description":"The email address of the user to invite."},"role":{"type":"string","description":"The role to invite the user as."}}}}}}},"responses":{"200":{"description":"The invited member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppMember"}}}}},"security":[{"studio":[]},{"app":["groups:write"]},{"cli":["groups:write"]}]},"delete":{"tags":["group","invite"],"description":"Revoke a group member invitation.","operationId":"deleteGroupInvite","requestBody":{"description":"The email address to revoke the invite of.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"204":{"description":"The invitation has been successfully revoked."}},"security":[{"studio":[]}]}},"/api/groups/{groupId}/members":{"parameters":[{"name":"groupId","in":"path","description":"The ID of the group","required":true,"schema":{"type":"number","readOnly":true}}],"get":{"tags":["common","app","group","members"],"description":"Fetch the members of a group and their roles within the group.","operationId":"getGroupMembers","parameters":[{"$ref":"#/components/parameters/selectedGroupId"}],"responses":{"200":{"description":"The list of all members.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationMember"}}}}}},"security":[{"studio":[]},{"app":["groups:read"]}]}},"/api/groups/{groupId}":{"parameters":[{"name":"groupId","in":"path","description":"The ID of the group","required":true,"schema":{"type":"number","readOnly":true}}],"get":{"tags":["common","group"],"description":"Fetch an existing group.","operationId":"getGroup","responses":{"200":{"description":"The requested group","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}}},"security":[{"studio":[]}]},"patch":{"tags":["common","group"],"description":"Update an existing group.","operationId":"patchGroup","requestBody":{"description":"The group to update.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"annotations":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"responses":{"200":{"description":"The updated group","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}}}}}}},"security":[{"studio":[]},{"cli":["groups:write"]}]},"delete":{"tags":["common","group"],"description":"Delete an existing group.","operationId":"deleteGroup","responses":{"204":{"description":"The group has successfully been deleted."}},"security":[{"studio":[]},{"cli":["groups:write"]}]}},"/api/timezones":{"get":{"tags":["main"],"description":"Get a list of timezones supported by the API","operationId":"getTimezones","responses":{"200":{"description":"A list of timezones supported by the API","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/trainings/completed":{"get":{"description":"Fetch all completed trainings","operationId":"getCompletedTrainings","responses":{"200":{"description":"An array of training IDs that the user has completed","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"security":[{"studio":[]}]},"delete":{"description":"Delete all completed trainings from user","operationId":"resetTrainingProgress","responses":{"204":{"description":"Trainings successfully reset "}},"security":[{"studio":[]}]}},"/api/trainings/completed/{trainingId}":{"post":{"description":"Sets the status of this training to \"completed\" for this user","operationId":"completeTraining","parameters":[{"in":"path","name":"trainingId","schema":{"type":"string"},"required":true,"description":"The ID of the training to complete"}],"responses":{"201":{"description":"Training successfully set to \"completed\""}},"security":[{"studio":[]}]}},"/api/trainings":{"get":{"description":"Fetch all training ids stored on the server","operationId":"getTrainingIds","responses":{"200":{"description":"An array of all training Id's","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/api/users/current/apps/accounts":{"get":{"description":"Get the accounts that have been linked to an app and the user","tags":["main","user","current-user","app","account"],"operationId":"getCurrentUserAppAccounts","security":[{"studio":[]}],"responses":{"200":{"description":"A list of linked accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppAccount"}}}}}}}},"/api/users/current/apps/{appId}/account":{"parameters":[{"$ref":"#/components/parameters/appId"}],"get":{"description":"Get the account that have been linked to the app and the user","tags":["main","user","current-user","app","account"],"operationId":"getCurrentUserAppAccount","security":[{"studio":[]}],"responses":{"200":{"description":"A linked account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAccount"}}}}}},"patch":{"description":"Get the account that have been linked to the app and the user","tags":["main","user","current-user","app","account"],"operationId":"patchCurrentUserAppAccount","security":[{"studio":[]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"picture":{"type":"string","format":"binary","description":"The member\u2019s profile picture."}}},"encoding":{"picture":{"contentType":"image/png,image/jpeg,image/tiff,image/webp"}}}}},"responses":{"200":{"description":"A linked account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppAccount"}}}}}}},"/api/users/current/apps":{"get":{"tags":["main","user","current-user","app"],"parameters":[{"name":"language","schema":{"type":"string"},"description":"The language to include the translations of, if available","in":"query"}],"description":"Get all apps from organizations that the user is in.","operationId":"queryCurrentUserApps","responses":{"200":{"description":"The list of all apps the user is in.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/App"}}}}}},"security":[{"studio":[]}]}},"/api/users/current/auth/oauth2/apps/{appId}/consent/agree":{"post":{"parameters":[{"$ref":"#/components/parameters/appId"}],"description":"Create a new OAuth2 consent.","tags":["main","user","current-user","auth","oauth2"],"operationId":"agreeCurrentUserOAuth2AppConsent","requestBody":{"$ref":"#/components/requestBodies/oauth2Consent"},"responses":{"201":{"$ref":"#/components/responses/oauth2AuthorizationCode"}},"security":[{"studio":[]}]}},"/api/users/current/auth/oauth2/apps/{appId}/consent/verify":{"post":{"parameters":[{"$ref":"#/components/parameters/appId"}],"description":"Verify if the user has previously agreed to the requested OAuth2 consent.","tags":["main","user","current-user","auth","oauth2"],"operationId":"verifyCurrentUserOAuth2AppConsent","requestBody":{"$ref":"#/components/requestBodies/oauth2Consent"},"responses":{"200":{"$ref":"#/components/responses/oauth2AuthorizationCode"}},"security":[{"studio":[]}]}},"/api/users/current/auth/oauth2/authorizations":{"get":{"description":"Get a list of the current user\u2019s OAuth2 authorizations.","tags":["main","user","current-user","auth","oauth2","authorization"],"operationId":"getCurrentUserOAuth2Authorizations","responses":{"200":{"description":"An access token response.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"authorizationUrl":{"type":"string"}}}}}}}},"security":[{"studio":[]}]},"delete":{"description":"Unlink a linked account from the logged in user.","tags":["main","user","current-user","auth","oauth2","authorization"],"operationId":"deleteCurrentUserOAuth2Authorization","parameters":[{"in":"query","name":"authorizationUrl","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The account was unlinked successfully."}},"security":[{"studio":[]}]}},"/api/users/current/auth/oauth2/client-credentials/{clientId}":{"parameters":[{"name":"clientId","in":"path","description":"The client id of the OAuth2 client credentials on which to perform an operation","required":true,"schema":{"type":"string"}}],"delete":{"description":"Revoke the client credentials","tags":["main","user","current-user","auth","oauth2","client-credentials"],"operationId":"deleteCurrentUserOAuth2ClientCredentials","responses":{"204":{"description":"The client credentials have been revoked successfully."}},"security":[{"studio":[]}]}},"/api/users/current/auth/oauth2/client-credentials":{"post":{"description":"Register new OAuth2 client credentials for the authenticated user.","tags":["main","user","current-user","auth","oauth2","client-credentials"],"operationId":"registerCurrentUserOAuth2ClientCredentials","requestBody":{"description":"The OAuth2 client credentials","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2ClientCredentials"}}}},"responses":{"201":{"description":"The newly created client credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2ClientCredentials"}}}}},"security":[{"studio":[]}]},"get":{"description":"Get a list of client credentials for the authenticated user","tags":["main","user","current-user","auth","oauth2","client-credentials"],"operationId":"listCurrentUserOAuth2ClientCredentials","responses":{"200":{"description":"A list of client credentials entities.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OAuth2ClientCredentials"}}}}}},"security":[{"studio":[]}]}},"/api/users/current/emails":{"get":{"tags":["main","user","current-user","email"],"description":"List email addresses registered to logged in user's account.","operationId":"listCurrentUserEmails","responses":{"200":{"description":"The email address has been added successfully.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserEmail"}}}}}},"security":[{"studio":[]}]},"post":{"tags":["main","user","current-user","email"],"description":"Register a new email to logged in user's account.","operationId":"addCurrentUserEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}}},"responses":{"201":{"description":"The email address has been added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}}}},"security":[{"studio":[]}]},"delete":{"tags":["main","user","current-user","email"],"description":"Remove an existing email to logged in user's account.","operationId":"removeCurrentUserEmail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEmail"}}}},"responses":{"204":{"description":"The email address has been removed successfully."}},"security":[{"studio":[]}]}},"/api/users/current/organizations":{"get":{"tags":["main","user","current-user","organization"],"description":"Fetch the logged in user's organizations.","operationId":"getCurrentUserOrganizations","responses":{"200":{"description":"The organizations the logged in user is a member of.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Organization/properties/id"},"name":{"$ref":"#/components/schemas/Organization/properties/name"},"role":{"$ref":"#/components/schemas/OrganizationMember/properties/role"}}}}}}}},"security":[{"studio":[]}]}},"/api/users/current/unsubscribe":{"post":{"tags":["main","user","current-user"],"description":"Unsubscribe a user from the newsletter","operationId":"unsubscribeCurrentUser","responses":{"201":{"description":"Unsubscribed successfully"},"401":{"description":"Invalid or missing admin API secret"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}}}},"/api/users/current":{"get":{"tags":["main","user","current-user"],"description":"Fetch the logged in user's profile.","operationId":"getCurrentUser","responses":{"200":{"description":"The user's profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"studio":[]}]},"put":{"tags":["main","user","current-user"],"description":"Update the logged in user's profile.","operationId":"patchCurrentUser","requestBody":{"required":true,"$ref":"#/components/requestBodies/user"},"responses":{"200":{"description":"The user's profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"security":[{"studio":[]}]}},"/api/users/subscribed":{"get":{"tags":["main","user"],"description":"Get a list of active and verified users subscribed to the appsemble newsletter","operationId":"getSubscribedUsers","responses":{"200":{"description":"List of subscribed users"},"401":{"description":"Invalid or missing admin API secret"}}}}},"tags":[{"name":"account","description":"Operations related to app accounts"},{"name":"app-member","description":"Operations related to app members"},{"name":"app","description":"Operations related to apps"},{"name":"action","description":"Operations related to actions"},{"name":"app-collection","description":"Operations related to app collections"},{"name":"app-definition","description":"Operations related to the app definitions"},{"name":"asset","description":"Operations related to assets"},{"name":"auth","description":"Operations related to authentication"},{"name":"authorization","description":"Operations related to authorizations"},{"name":"block","description":"Operations related to blocks"},{"name":"client-credentials","description":"Operations related to client credentials"},{"name":"common","description":"Operations shared between apps and the studio"},{"name":"current-member","description":"Operations related to the currently logged in user"},{"name":"current-user","description":"Operations related to the currently logged in user"},{"name":"demo-group","description":"Operations related to demo groups"},{"name":"demo-member","description":"Operations related to demo members"},{"name":"email","description":"Operations related to emails"},{"name":"invite","description":"Operations related to invites."},{"name":"main","description":"Operations related to the main api"},{"name":"member","description":"Operations related to members"},{"name":"oauth2","description":"Operations related to oauth2"},{"name":"organization","description":"Operations related to organizations"},{"name":"rating","description":"Operations related to ratings"},{"name":"readme","description":"Operations related to readmes"},{"name":"resource","description":"Operations related to the resources"},{"name":"saml","description":"Operations related to saml"},{"name":"scim","description":"Operations related to scim"},{"name":"screenshot","description":"Operations related to screenshots"},{"name":"secret","description":"Operations related to secrets"},{"name":"service","description":"Operations related to service secrets"},{"name":"snapshot","description":"Operations related to snapshots"},{"name":"ssl","description":"Operations related to ssl"},{"name":"subscription","description":"Operations related to subscriptions"},{"name":"group-member","description":"Operations related to group members"},{"name":"group","description":"Operations related to groups"},{"name":"template","description":"Operations related to templates"},{"name":"training","description":"Operations related to trainings"},{"name":"translation","description":"Operations related to translations"},{"name":"user","description":"Operations related to users."},{"name":"variable","description":"Operations related to app variables."},{"name":"version","description":"Operations related to versions."},{"name":"webhook","description":"Operations related to webhooks."}]}
|
Provide a JSON object that satisfies the schema "AppDefinition". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
AppDefinition
|
schema-store
|
schema_store_10
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"description\":\"BizTalk Server Application Inventory Schema\",\"id\":\"http://schema.management.azure.com/schemas/2017-04-01/BizTalkServerApplicationSchema.json#\",\"properties\":{\"BizTalkAssemblies\":{\"type\":\"array\",\"description\":\"Array of BizTalk Reference Assemblies to be deployed.\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"Filename of the BizTalk Referenced Assembly.\"},\"Path\":{\"type\":\"string\",\"pattern\":\"\\\\w+[\\\\\\\\](\\\\w+\\\\.)*\\\\w+\\\\.dll\",\"description\":\"Relative output filepath for the Referenced Assembly. \\r\\nExample: bins\\\\\\\\bts1.dll\"}}}},\"BindingsFiles\":{\"type\":\"array\",\"description\":\"Array of Binding Files used in Deployment.\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"Filename of the Bindings File.\"},\"Path\":{\"type\":\"string\",\"pattern\":\"\\\\w+[\\\\\\\\](\\\\w+\\\\.)*\\\\w+\\\\.xml\",\"description\":\"Relative output filepath for the Bindings File.\\r\\nExample: bindings\\\\\\\\binding1.xml\"}}}},\"Assemblies\":{\"type\":\"array\",\"description\":\"Array of Reference Assemblies to be deployed.\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"Filename of the Referenced Assembly.\"},\"Path\":{\"type\":\"string\",\"pattern\":\"\\\\w+[\\\\\\\\](\\\\w+\\\\.)*\\\\w+\\\\.dll\",\"description\":\"Relative output filepath for the Unmanaged Referenced Assembly. \\r\\nExample: bins\\\\\\\\bts1.dll\"}}}},\"PreProcessingScripts\":{\"type\":\"array\",\"description\":\"Pre-Processing Scripts used in Deployment.\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"Filename of the Pre Processing Script.\"},\"Path\":{\"type\":\"string\",\"pattern\":\"\\\\w+[\\\\\\\\](\\\\w+\\\\.)*\\\\w+\\\\.\\\\w+\",\"description\":\"Relative output filepath for the Pre Processing Script.\\r\\nExample: bins\\\\\\\\Script1.vbs\"},\"Arguments\":{\"type\":\"string\",\"pattern\":\"\\\\w+(,\\\\w+)*\",\"description\":\"Arguments for the Pre Processing Script .\\r\\nExample: arg1,arg2\"}}}},\"PostProcessingScripts\":{\"type\":\"array\",\"description\":\"Post-Processing Scripts used in Deployment.\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"Filename of the Post Processing Script.\"},\"Path\":{\"type\":\"string\",\"pattern\":\"\\\\w+[\\\\\\\\](\\\\w+\\\\.)*\\\\w+\\\\.\\\\w+\",\"description\":\"Relative output filepath for the Post Processing Script.\\r\\nExample: Script\\\\\\\\Script1.vbs\"},\"Arguments\":{\"type\":\"string\",\"pattern\":\"\\\\w+(,\\\\w+)*\",\"description\":\"Arguments for the Post Processing Script .\\r\\nExample: arg1,arg2\"}}}},\"Files\":{\"type\":\"array\",\"description\":\"File used in Deployment.\",\"items\":{\"type\":\"object\",\"properties\":{\"Name\":{\"type\":\"string\",\"description\":\"Name of the File\"},\"Path\":{\"type\":\"string\",\"pattern\":\"\\\\w+[\\\\\\\\](\\\\w+\\\\.)*\\\\w+\\\\.\\\\w+\",\"description\":\"Relative output filepath for the Files.\\r\\nExample: File\\\\\\\\File.txt\"}}}},\"DeploymentSequence\":{\"type\":\"array\",\"description\":\"Sequence of Binding Files, Reference Assemblies, Pre-Processing and Post-Processing Scripts used in Deployment.\",\"items\":{\"type\":\"string\"}}},\"required\":[\"BizTalkAssemblies\",\"BindingsFiles\",\"DeploymentSequence\"],\"title\":\"BizTalkServerApplicationInventorySchema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"BizTalkServerApplicationInventorySchema\". Here are the required top‑level fields: BizTalkAssemblies, BindingsFiles, DeploymentSequence. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","description":"BizTalk Server Application Inventory Schema","id":"http://schema.management.azure.com/schemas/2017-04-01/BizTalkServerApplicationSchema.json#","properties":{"BizTalkAssemblies":{"type":"array","description":"Array of BizTalk Reference Assemblies to be deployed.","items":{"type":"object","properties":{"Name":{"type":"string","description":"Filename of the BizTalk Referenced Assembly."},"Path":{"type":"string","pattern":"\\w+[\\\\](\\w+\\.)*\\w+\\.dll","description":"Relative output filepath for the Referenced Assembly. \r\nExample: bins\\\\bts1.dll"}}}},"BindingsFiles":{"type":"array","description":"Array of Binding Files used in Deployment.","items":{"type":"object","properties":{"Name":{"type":"string","description":"Filename of the Bindings File."},"Path":{"type":"string","pattern":"\\w+[\\\\](\\w+\\.)*\\w+\\.xml","description":"Relative output filepath for the Bindings File.\r\nExample: bindings\\\\binding1.xml"}}}},"Assemblies":{"type":"array","description":"Array of Reference Assemblies to be deployed.","items":{"type":"object","properties":{"Name":{"type":"string","description":"Filename of the Referenced Assembly."},"Path":{"type":"string","pattern":"\\w+[\\\\](\\w+\\.)*\\w+\\.dll","description":"Relative output filepath for the Unmanaged Referenced Assembly. \r\nExample: bins\\\\bts1.dll"}}}},"PreProcessingScripts":{"type":"array","description":"Pre-Processing Scripts used in Deployment.","items":{"type":"object","properties":{"Name":{"type":"string","description":"Filename of the Pre Processing Script."},"Path":{"type":"string","pattern":"\\w+[\\\\](\\w+\\.)*\\w+\\.\\w+","description":"Relative output filepath for the Pre Processing Script.\r\nExample: bins\\\\Script1.vbs"},"Arguments":{"type":"string","pattern":"\\w+(,\\w+)*","description":"Arguments for the Pre Processing Script .\r\nExample: arg1,arg2"}}}},"PostProcessingScripts":{"type":"array","description":"Post-Processing Scripts used in Deployment.","items":{"type":"object","properties":{"Name":{"type":"string","description":"Filename of the Post Processing Script."},"Path":{"type":"string","pattern":"\\w+[\\\\](\\w+\\.)*\\w+\\.\\w+","description":"Relative output filepath for the Post Processing Script.\r\nExample: Script\\\\Script1.vbs"},"Arguments":{"type":"string","pattern":"\\w+(,\\w+)*","description":"Arguments for the Post Processing Script .\r\nExample: arg1,arg2"}}}},"Files":{"type":"array","description":"File used in Deployment.","items":{"type":"object","properties":{"Name":{"type":"string","description":"Name of the File"},"Path":{"type":"string","pattern":"\\w+[\\\\](\\w+\\.)*\\w+\\.\\w+","description":"Relative output filepath for the Files.\r\nExample: File\\\\File.txt"}}}},"DeploymentSequence":{"type":"array","description":"Sequence of Binding Files, Reference Assemblies, Pre-Processing and Post-Processing Scripts used in Deployment.","items":{"type":"string"}}},"required":["BizTalkAssemblies","BindingsFiles","DeploymentSequence"],"title":"BizTalkServerApplicationInventorySchema","type":"object"}
|
Provide a JSON object that satisfies the schema "BizTalkServerApplicationInventorySchema". Here are the required top‑level fields: BizTalkAssemblies, BindingsFiles, DeploymentSequence. Return only the valid JSON object.
|
BizTalkServerApplicationInventorySchema
|
schema-store
|
schema_store_11
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/Butane-Schema.json\",\"$comment\":\"Sources: https://github.com/Relativ-IT/Butane-Schemas/tree/Release\",\"title\":\"Fedora Coreos Butane Schema\",\"type\":\"object\",\"required\":[\"variant\",\"version\"],\"properties\":{\"variant\":{\"$id\":\"#/properties/variant\",\"type\":\"string\",\"title\":\"variant (string):\",\"description\":\"Used to differentiate configs for different operating systems.\",\"enum\":[\"fcos\",\"flatcar\"],\"default\":\"fcos\"},\"version\":{\"$id\":\"#/properties/version\",\"type\":\"string\",\"title\":\"version (string):\"}},\"allOf\":[{\"oneOf\":[{\"properties\":{\"variant\":{\"const\":\"fcos\"},\"version\":{\"enum\":[\"1.4.0\",\"1.5.0\",\"1.6.0\"],\"default\":\"1.6.0\"}}},{\"properties\":{\"variant\":{\"const\":\"flatcar\"},\"version\":{\"enum\":[\"1.1.0\"],\"default\":\"1.1.0\"}}}]},{\"oneOf\":[{\"allOf\":[{\"properties\":{\"variant\":{\"const\":\"fcos\"},\"version\":{\"const\":\"1.4.0\"}}},{\"$ref\":\"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.4.0/butane-v1.4.0.json\"}]},{\"allOf\":[{\"properties\":{\"variant\":{\"const\":\"fcos\"},\"version\":{\"const\":\"1.5.0\"}}},{\"$ref\":\"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.5.0/butane-v1.5.0.json\"}]},{\"allOf\":[{\"properties\":{\"variant\":{\"const\":\"fcos\"},\"version\":{\"const\":\"1.6.0\"}}},{\"$ref\":\"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.6.0/butane-v1.6.0.json\"}]},{\"allOf\":[{\"properties\":{\"variant\":{\"const\":\"flatcar\"},\"version\":{\"const\":\"1.1.0\"}}},{\"$ref\":\"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/flatcar-v1.1.0/butane-flatcar-v1.1.0.json\"}]}]}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Fedora Coreos Butane Schema\". Here are the required top‑level fields: variant, version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/Butane-Schema.json","$comment":"Sources: https://github.com/Relativ-IT/Butane-Schemas/tree/Release","title":"Fedora Coreos Butane Schema","type":"object","required":["variant","version"],"properties":{"variant":{"$id":"#/properties/variant","type":"string","title":"variant (string):","description":"Used to differentiate configs for different operating systems.","enum":["fcos","flatcar"],"default":"fcos"},"version":{"$id":"#/properties/version","type":"string","title":"version (string):"}},"allOf":[{"oneOf":[{"properties":{"variant":{"const":"fcos"},"version":{"enum":["1.4.0","1.5.0","1.6.0"],"default":"1.6.0"}}},{"properties":{"variant":{"const":"flatcar"},"version":{"enum":["1.1.0"],"default":"1.1.0"}}}]},{"oneOf":[{"allOf":[{"properties":{"variant":{"const":"fcos"},"version":{"const":"1.4.0"}}},{"$ref":"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.4.0/butane-v1.4.0.json"}]},{"allOf":[{"properties":{"variant":{"const":"fcos"},"version":{"const":"1.5.0"}}},{"$ref":"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.5.0/butane-v1.5.0.json"}]},{"allOf":[{"properties":{"variant":{"const":"fcos"},"version":{"const":"1.6.0"}}},{"$ref":"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/v1.6.0/butane-v1.6.0.json"}]},{"allOf":[{"properties":{"variant":{"const":"flatcar"},"version":{"const":"1.1.0"}}},{"$ref":"https://raw.githubusercontent.com/Relativ-IT/Butane-Schemas/Release/flatcar-v1.1.0/butane-flatcar-v1.1.0.json"}]}]}]}
|
Provide a JSON object that satisfies the schema "Fedora Coreos Butane Schema". Here are the required top‑level fields: variant, version. Return only the valid JSON object.
|
Fedora Coreos Butane Schema
|
schema-store
|
schema_store_12
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"title\":\"CKAN JSON Schema\",\"description\":\"Schema for validating CKAN meta files\",\"type\":\"object\",\"properties\":{\"spec_version\":{\"description\":\"Version of the CKAN spec this document uses\",\"oneOf\":[{\"type\":\"integer\",\"description\":\"The integer '1' is special case\",\"minimum\":1,\"maximum\":1},{\"type\":\"string\",\"description\":\"A vx.x string\",\"pattern\":\"^v[0-9]+\\\\.[0-9]+$\"}]},\"name\":{\"description\":\"Human readable name of the mod\",\"type\":\"string\"},\"identifier\":{\"description\":\"Unique identifier for this mod\",\"$ref\":\"#/definitions/identifier\"},\"kind\":{\"description\":\"Package type, defaults to package\",\"enum\":[\"package\",\"metapackage\",\"dlc\"]},\"abstract\":{\"description\":\"Short description of the mod\",\"type\":\"string\"},\"description\":{\"description\":\"Longer description of the mod\",\"type\":\"string\"},\"comment\":{\"description\":\"Free-form comment. Not displayed to users\",\"type\":\"string\"},\"author\":{\"description\":\"Author, or list of authors\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}]},\"download\":{\"description\":\"URL where mod can be downloaded by tools\",\"oneOf\":[{\"type\":\"string\",\"format\":\"uri\"},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uri\"},\"uniqueItems\":true}]},\"download_size\":{\"description\":\"The size of the download in bytes\",\"type\":\"integer\"},\"download_hash\":{\"description\":\"A object of hashes of the downloaded file\",\"type\":\"object\",\"properties\":{\"sha1\":{\"description\":\"SHA1 hash of the file\",\"type\":\"string\"},\"sha256\":{\"description\":\"SHA256 hash of the file\",\"type\":\"string\"}}},\"download_content_type\":{\"description\":\"The content type of the download\",\"type\":\"string\"},\"install_size\":{\"description\":\"The size of the installed files\",\"type\":\"integer\"},\"license\":{\"description\":\"Machine readable license, or array of licenses\",\"$ref\":\"#/definitions/licenses\"},\"version\":{\"description\":\"Version of the mod\",\"$ref\":\"#/definitions/version\"},\"release_status\":{\"description\":\"Optional release status\",\"enum\":[\"stable\",\"testing\",\"development\"]},\"ksp_version\":{\"description\":\"Optional target game version\",\"$ref\":\"#/definitions/ksp_version\"},\"ksp_version_min\":{\"description\":\"Optional minimum game version\",\"$ref\":\"#/definitions/ksp_version\"},\"ksp_version_max\":{\"description\":\"Optional maximum game version\",\"$ref\":\"#/definitions/ksp_version\"},\"ksp_version_strict\":{\"description\":\"Optional enforcement of strict version checks (defaults to false)\",\"type\":\"boolean\"},\"tags\":{\"description\":\"A series of descriptive keywords to provide quick filtering and organization\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^[a-z0-9-]+$\"}},\"localizations\":{\"description\":\"A list of locale strings for which this mod includes localizations\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"depends\":{\"description\":\"Optional list of dependencies\",\"$ref\":\"#/definitions/relationship\"},\"recommends\":{\"description\":\"Optional list of recommended mods\",\"$ref\":\"#/definitions/relationship\"},\"suggests\":{\"description\":\"Optional list of recommended, but not essential mods\",\"$ref\":\"#/definitions/relationship\"},\"supports\":{\"description\":\"Optional list of supported mods\",\"$ref\":\"#/definitions/relationship\"},\"conflicts\":{\"description\":\"Optional list of conflicting mods\",\"$ref\":\"#/definitions/relationship\"},\"provides\":{\"description\":\"A list of virtual packages this mod provides\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/identifier\"},\"uniqueItems\":true},\"replaced_by\":{\"description\":\"Optional pointer to mod that should be selected instead and treated as an update to this mod\",\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"Identifier of the mod\",\"$ref\":\"#/definitions/identifier\"},\"version\":{\"description\":\"Optional version\",\"$ref\":\"#/definitions/version\"},\"min_version\":{\"description\":\"Optional minimum version\",\"$ref\":\"#/definitions/version\"}},\"required\":[\"name\"]},\"resources\":{\"description\":\"Additional resources\",\"type\":\"object\",\"properties\":{\"homepage\":{\"description\":\"Mod homepage\",\"type\":\"string\",\"format\":\"uri\"},\"bugtracker\":{\"description\":\"Mod bugtracker\",\"type\":\"string\",\"format\":\"uri\"},\"discussions\":{\"description\":\"Mod discussions\",\"type\":\"string\",\"format\":\"uri\"},\"license\":{\"description\":\"Mod license\",\"type\":\"string\",\"format\":\"uri\"},\"repository\":{\"description\":\"Mod repository\",\"type\":\"string\",\"format\":\"uri\"},\"ci\":{\"description\":\"Continuous Integration\",\"type\":\"string\",\"format\":\"uri\"},\"spacedock\":{\"description\":\"Project on SpaceDock\",\"type\":\"string\",\"format\":\"uri\"},\"curse\":{\"description\":\"Project on Curse\",\"type\":\"string\",\"format\":\"uri\"},\"manual\":{\"description\":\"Mod's manual\",\"type\":\"string\",\"format\":\"uri\"},\"metanetkan\":{\"description\":\"Mod's remote hosted netkan\",\"type\":\"string\",\"format\":\"uri\"},\"remote-avc\":{\"description\":\"Mod's remote hosted version file\",\"type\":\"string\",\"format\":\"uri\"},\"remote-swinfo\":{\"description\":\"Mod's remote hosted swinfo file\",\"type\":\"string\",\"format\":\"uri\"},\"store\":{\"description\":\"Purchase DLC here\",\"type\":\"string\",\"format\":\"uri\"},\"steamstore\":{\"description\":\"Purchase DLC on Steam here\",\"type\":\"string\",\"format\":\"uri\"},\"gogstore\":{\"description\":\"Purchase DLC on GOG here\",\"type\":\"string\",\"format\":\"uri\"},\"epicstore\":{\"description\":\"Purchase DLC on Epic Games Store here\",\"type\":\"string\",\"format\":\"uri\"}}},\"install\":{\"description\":\"List of install directives\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"file\":{\"description\":\"Path to file to install\",\"type\":\"string\"},\"find\":{\"description\":\"A directory to find for installation\",\"type\":\"string\"},\"find_regexp\":{\"description\":\"A regexp that matches the directory to install\",\"type\":\"string\"},\"find_matches_files\":{\"description\":\"If true, find directives match files as well as directories\",\"type\":\"boolean\"},\"install_to\":{\"description\":\"Where file should be installed to\",\"$ref\":\"#/definitions/install_to\"},\"as\":{\"description\":\"The name to give the matching directory or file when installed\",\"type\":\"string\",\"pattern\":\"^[^\\\\\\\\/]+$\"},\"filter\":{\"description\":\"List of files and directories that should be filtered from the install\",\"$ref\":\"#/definitions/one_or_more_strings\"},\"filter_regexp\":{\"description\":\"List of regexps that should filter files from this install\",\"$ref\":\"#/definitions/one_or_more_strings\"},\"include_only\":{\"description\":\"List of files and directories that should not be excluded from the install\",\"$ref\":\"#/definitions/one_or_more_strings\"},\"include_only_regexp\":{\"description\":\"List of regexps that should include files in this install\",\"$ref\":\"#/definitions/one_or_more_strings\"}},\"not\":{\"anyOf\":[{\"required\":[\"filter\",\"include_only\"]},{\"required\":[\"filter\",\"include_only_regexp\"]},{\"required\":[\"filter_regexp\",\"include_only\"]},{\"required\":[\"filter_regexp\",\"include_only_regexp\"]}]},\"required\":[\"install_to\"],\"oneOf\":[{\"required\":[\"file\"]},{\"required\":[\"find\"]},{\"required\":[\"find_regexp\"]}]}},\"release_date\":{\"description\":\"Optional timestamp when the described version of the mod was released\",\"type\":\"string\",\"format\":\"date-time\"}},\"required\":[\"spec_version\",\"name\",\"author\",\"abstract\",\"identifier\",\"license\",\"version\"],\"oneOf\":[{\"required\":[\"download\"]},{\"properties\":{\"kind\":{\"enum\":[\"metapackage\",\"dlc\"]}},\"not\":{\"required\":[\"download\"]},\"required\":[\"kind\"]}],\"definitions\":{\"identifier\":{\"description\":\"Unique identifier for this mod.\",\"type\":\"string\",\"pattern\":\"^[A-Za-z0-9][A-Za-z0-9-]+$\"},\"version\":{\"description\":\"A version string\",\"type\":\"string\"},\"ksp_version\":{\"description\":\"A game version\",\"type\":\"string\",\"pattern\":\"^(any|[0-9]+(\\\\.[0-9]+(\\\\.[0-9]+)?)?)$\"},\"relationship\":{\"description\":\"A relationship to a list of mods\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"Identifier of the mod\",\"$ref\":\"#/definitions/identifier\"},\"version\":{\"description\":\"Optional version\",\"$ref\":\"#/definitions/version\"},\"min_version\":{\"description\":\"Optional minimum version\",\"$ref\":\"#/definitions/version\"},\"max_version\":{\"description\":\"Optional maximum version\",\"$ref\":\"#/definitions/version\"},\"choice_help_text\":{\"description\":\"Optional help text shown when user has to choose among multiple modules\",\"type\":\"string\"},\"suppress_recommendations\":{\"description\":\"If true, don't check this mod or its dependencies for recommendations or suggestions\",\"type\":\"boolean\"}},\"required\":[\"name\"]},{\"type\":\"object\",\"properties\":{\"any_of\":{\"description\":\"List of modules that can satisfy this relationship\",\"$ref\":\"#/definitions/relationship\"},\"choice_help_text\":{\"description\":\"Optional help text shown when user has to choose among multiple modules\",\"type\":\"string\"}},\"required\":[\"any_of\"]}]}},\"install_to\":{\"description\":\"Where file should be installed to. As of v1.2, GameData may take a path\",\"anyOf\":[{\"description\":\"Spec version 1 targets\",\"enum\":[\"GameData\",\"Ships\",\"GameRoot\",\"Tutorial\",\"Scenarios\"]},{\"description\":\"Spec v1.2 GameData path\",\"type\":\"string\",\"pattern\":\"^GameData/\"},{\"description\":\"Spec v1.12 Ships subfolder paths\",\"type\":\"string\",\"pattern\":\"^Ships/(SPH|VAB|Script)$\"},{\"description\":\"Spec v1.16 thumbs paths\",\"type\":\"string\",\"pattern\":\"^Ships/@thumbs/(SPH|VAB)$\"},{\"description\":\"Spec v1.25 Missions path\",\"type\":\"string\",\"pattern\":\"^Missions\"},{\"description\":\"KSP2 default mods folder\",\"enum\":[\"GameData/Mods\"]},{\"description\":\"KSP2 default mods folder with subfolder\",\"type\":\"string\",\"pattern\":\"^GameData/Mods/\"},{\"description\":\"KSP2 BepInEx plugins folder\",\"type\":\"string\",\"pattern\":\"^BepInEx/plugins$\"}]},\"license\":{\"description\":\"A license.\",\"enum\":[\"public-domain\",\"AFL-3.0\",\"AGPL-3.0\",\"Apache\",\"Apache-1.0\",\"Apache-2.0\",\"APSL-2.0\",\"Artistic\",\"Artistic-1.0\",\"Artistic-2.0\",\"BSD-2-clause\",\"BSD-3-clause\",\"BSD-4-clause\",\"ISC\",\"CC-BY\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-3.0\",\"CC-BY-4.0\",\"CC-BY-SA\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-4.0\",\"CC-BY-NC\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-4.0\",\"CC-BY-NC-SA\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-4.0\",\"CC-BY-NC-ND\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-4.0\",\"CC-BY-ND\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-4.0\",\"CC0\",\"CDDL\",\"CPL\",\"EFL-1.0\",\"EFL-2.0\",\"Expat\",\"MIT\",\"GPL-1.0\",\"GPL-2.0\",\"GPL-3.0\",\"LGPL-2.0\",\"LGPL-2.1\",\"LGPL-3.0\",\"GFDL-1.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GFDL-NIV-1.0\",\"GFDL-NIV-1.1\",\"GFDL-NIV-1.2\",\"GFDL-NIV-1.3\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3c\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"Ms-PL\",\"Ms-RL\",\"Perl\",\"Python-2.0\",\"QPL-1.0\",\"Unlicense\",\"W3C\",\"WTFPL\",\"Zlib\",\"Zope\",\"open-source\",\"restricted\",\"unrestricted\",\"unknown\"]},\"redistributable_license\":{\"description\":\"A license that grants us the right to redistribute.\",\"enum\":[\"public-domain\",\"Apache\",\"Apache-1.0\",\"Apache-2.0\",\"Artistic\",\"Artistic-1.0\",\"Artistic-2.0\",\"BSD-2-clause\",\"BSD-3-clause\",\"BSD-4-clause\",\"ISC\",\"CC-BY\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-3.0\",\"CC-BY-4.0\",\"CC-BY-SA\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-4.0\",\"CC-BY-NC\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-4.0\",\"CC-BY-NC-SA\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-4.0\",\"CC-BY-NC-ND\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-4.0\",\"CC-BY-ND\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-4.0\",\"CC0\",\"CDDL\",\"CPL\",\"EFL-1.0\",\"EFL-2.0\",\"Expat\",\"MIT\",\"GPL-1.0\",\"GPL-2.0\",\"GPL-3.0\",\"LGPL-2.0\",\"LGPL-2.1\",\"LGPL-3.0\",\"GFDL-1.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GFDL-NIV-1.0\",\"GFDL-NIV-1.1\",\"GFDL-NIV-1.2\",\"GFDL-NIV-1.3\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3c\",\"MPL-1.1\",\"MPL-2.0\",\"Perl\",\"Python-2.0\",\"QPL-1.0\",\"W3C\",\"Zlib\",\"Zope\",\"WTFPL\",\"Unlicense\",\"open-source\",\"unrestricted\"]},\"licenses\":{\"description\":\"A license, or array of licenses\",\"anyOf\":[{\"$ref\":\"#/definitions/license\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/license\"},\"uniqueItems\":true}]},\"one_or_more_strings\":{\"description\":\"One or more strings\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"CKAN JSON Schema\". Here are the required top‑level fields: spec_version, name, author, abstract, identifier, license, version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","title":"CKAN JSON Schema","description":"Schema for validating CKAN meta files","type":"object","properties":{"spec_version":{"description":"Version of the CKAN spec this document uses","oneOf":[{"type":"integer","description":"The integer '1' is special case","minimum":1,"maximum":1},{"type":"string","description":"A vx.x string","pattern":"^v[0-9]+\\.[0-9]+$"}]},"name":{"description":"Human readable name of the mod","type":"string"},"identifier":{"description":"Unique identifier for this mod","$ref":"#/definitions/identifier"},"kind":{"description":"Package type, defaults to package","enum":["package","metapackage","dlc"]},"abstract":{"description":"Short description of the mod","type":"string"},"description":{"description":"Longer description of the mod","type":"string"},"comment":{"description":"Free-form comment. Not displayed to users","type":"string"},"author":{"description":"Author, or list of authors","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"uniqueItems":true}]},"download":{"description":"URL where mod can be downloaded by tools","oneOf":[{"type":"string","format":"uri"},{"type":"array","items":{"type":"string","format":"uri"},"uniqueItems":true}]},"download_size":{"description":"The size of the download in bytes","type":"integer"},"download_hash":{"description":"A object of hashes of the downloaded file","type":"object","properties":{"sha1":{"description":"SHA1 hash of the file","type":"string"},"sha256":{"description":"SHA256 hash of the file","type":"string"}}},"download_content_type":{"description":"The content type of the download","type":"string"},"install_size":{"description":"The size of the installed files","type":"integer"},"license":{"description":"Machine readable license, or array of licenses","$ref":"#/definitions/licenses"},"version":{"description":"Version of the mod","$ref":"#/definitions/version"},"release_status":{"description":"Optional release status","enum":["stable","testing","development"]},"ksp_version":{"description":"Optional target game version","$ref":"#/definitions/ksp_version"},"ksp_version_min":{"description":"Optional minimum game version","$ref":"#/definitions/ksp_version"},"ksp_version_max":{"description":"Optional maximum game version","$ref":"#/definitions/ksp_version"},"ksp_version_strict":{"description":"Optional enforcement of strict version checks (defaults to false)","type":"boolean"},"tags":{"description":"A series of descriptive keywords to provide quick filtering and organization","type":"array","items":{"type":"string","pattern":"^[a-z0-9-]+$"}},"localizations":{"description":"A list of locale strings for which this mod includes localizations","type":"array","items":{"type":"string"},"uniqueItems":true},"depends":{"description":"Optional list of dependencies","$ref":"#/definitions/relationship"},"recommends":{"description":"Optional list of recommended mods","$ref":"#/definitions/relationship"},"suggests":{"description":"Optional list of recommended, but not essential mods","$ref":"#/definitions/relationship"},"supports":{"description":"Optional list of supported mods","$ref":"#/definitions/relationship"},"conflicts":{"description":"Optional list of conflicting mods","$ref":"#/definitions/relationship"},"provides":{"description":"A list of virtual packages this mod provides","type":"array","items":{"$ref":"#/definitions/identifier"},"uniqueItems":true},"replaced_by":{"description":"Optional pointer to mod that should be selected instead and treated as an update to this mod","type":"object","properties":{"name":{"description":"Identifier of the mod","$ref":"#/definitions/identifier"},"version":{"description":"Optional version","$ref":"#/definitions/version"},"min_version":{"description":"Optional minimum version","$ref":"#/definitions/version"}},"required":["name"]},"resources":{"description":"Additional resources","type":"object","properties":{"homepage":{"description":"Mod homepage","type":"string","format":"uri"},"bugtracker":{"description":"Mod bugtracker","type":"string","format":"uri"},"discussions":{"description":"Mod discussions","type":"string","format":"uri"},"license":{"description":"Mod license","type":"string","format":"uri"},"repository":{"description":"Mod repository","type":"string","format":"uri"},"ci":{"description":"Continuous Integration","type":"string","format":"uri"},"spacedock":{"description":"Project on SpaceDock","type":"string","format":"uri"},"curse":{"description":"Project on Curse","type":"string","format":"uri"},"manual":{"description":"Mod's manual","type":"string","format":"uri"},"metanetkan":{"description":"Mod's remote hosted netkan","type":"string","format":"uri"},"remote-avc":{"description":"Mod's remote hosted version file","type":"string","format":"uri"},"remote-swinfo":{"description":"Mod's remote hosted swinfo file","type":"string","format":"uri"},"store":{"description":"Purchase DLC here","type":"string","format":"uri"},"steamstore":{"description":"Purchase DLC on Steam here","type":"string","format":"uri"},"gogstore":{"description":"Purchase DLC on GOG here","type":"string","format":"uri"},"epicstore":{"description":"Purchase DLC on Epic Games Store here","type":"string","format":"uri"}}},"install":{"description":"List of install directives","type":"array","items":{"type":"object","properties":{"file":{"description":"Path to file to install","type":"string"},"find":{"description":"A directory to find for installation","type":"string"},"find_regexp":{"description":"A regexp that matches the directory to install","type":"string"},"find_matches_files":{"description":"If true, find directives match files as well as directories","type":"boolean"},"install_to":{"description":"Where file should be installed to","$ref":"#/definitions/install_to"},"as":{"description":"The name to give the matching directory or file when installed","type":"string","pattern":"^[^\\\\/]+$"},"filter":{"description":"List of files and directories that should be filtered from the install","$ref":"#/definitions/one_or_more_strings"},"filter_regexp":{"description":"List of regexps that should filter files from this install","$ref":"#/definitions/one_or_more_strings"},"include_only":{"description":"List of files and directories that should not be excluded from the install","$ref":"#/definitions/one_or_more_strings"},"include_only_regexp":{"description":"List of regexps that should include files in this install","$ref":"#/definitions/one_or_more_strings"}},"not":{"anyOf":[{"required":["filter","include_only"]},{"required":["filter","include_only_regexp"]},{"required":["filter_regexp","include_only"]},{"required":["filter_regexp","include_only_regexp"]}]},"required":["install_to"],"oneOf":[{"required":["file"]},{"required":["find"]},{"required":["find_regexp"]}]}},"release_date":{"description":"Optional timestamp when the described version of the mod was released","type":"string","format":"date-time"}},"required":["spec_version","name","author","abstract","identifier","license","version"],"oneOf":[{"required":["download"]},{"properties":{"kind":{"enum":["metapackage","dlc"]}},"not":{"required":["download"]},"required":["kind"]}],"definitions":{"identifier":{"description":"Unique identifier for this mod.","type":"string","pattern":"^[A-Za-z0-9][A-Za-z0-9-]+$"},"version":{"description":"A version string","type":"string"},"ksp_version":{"description":"A game version","type":"string","pattern":"^(any|[0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)$"},"relationship":{"description":"A relationship to a list of mods","type":"array","items":{"oneOf":[{"type":"object","properties":{"name":{"description":"Identifier of the mod","$ref":"#/definitions/identifier"},"version":{"description":"Optional version","$ref":"#/definitions/version"},"min_version":{"description":"Optional minimum version","$ref":"#/definitions/version"},"max_version":{"description":"Optional maximum version","$ref":"#/definitions/version"},"choice_help_text":{"description":"Optional help text shown when user has to choose among multiple modules","type":"string"},"suppress_recommendations":{"description":"If true, don't check this mod or its dependencies for recommendations or suggestions","type":"boolean"}},"required":["name"]},{"type":"object","properties":{"any_of":{"description":"List of modules that can satisfy this relationship","$ref":"#/definitions/relationship"},"choice_help_text":{"description":"Optional help text shown when user has to choose among multiple modules","type":"string"}},"required":["any_of"]}]}},"install_to":{"description":"Where file should be installed to. As of v1.2, GameData may take a path","anyOf":[{"description":"Spec version 1 targets","enum":["GameData","Ships","GameRoot","Tutorial","Scenarios"]},{"description":"Spec v1.2 GameData path","type":"string","pattern":"^GameData/"},{"description":"Spec v1.12 Ships subfolder paths","type":"string","pattern":"^Ships/(SPH|VAB|Script)$"},{"description":"Spec v1.16 thumbs paths","type":"string","pattern":"^Ships/@thumbs/(SPH|VAB)$"},{"description":"Spec v1.25 Missions path","type":"string","pattern":"^Missions"},{"description":"KSP2 default mods folder","enum":["GameData/Mods"]},{"description":"KSP2 default mods folder with subfolder","type":"string","pattern":"^GameData/Mods/"},{"description":"KSP2 BepInEx plugins folder","type":"string","pattern":"^BepInEx/plugins$"}]},"license":{"description":"A license.","enum":["public-domain","AFL-3.0","AGPL-3.0","Apache","Apache-1.0","Apache-2.0","APSL-2.0","Artistic","Artistic-1.0","Artistic-2.0","BSD-2-clause","BSD-3-clause","BSD-4-clause","ISC","CC-BY","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-3.0","CC-BY-4.0","CC-BY-SA","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-4.0","CC-BY-NC","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-4.0","CC-BY-NC-SA","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-4.0","CC-BY-NC-ND","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-4.0","CC-BY-ND","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-4.0","CC0","CDDL","CPL","EFL-1.0","EFL-2.0","Expat","MIT","GPL-1.0","GPL-2.0","GPL-3.0","LGPL-2.0","LGPL-2.1","LGPL-3.0","GFDL-1.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GFDL-NIV-1.0","GFDL-NIV-1.1","GFDL-NIV-1.2","GFDL-NIV-1.3","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3c","MPL-1.0","MPL-1.1","MPL-2.0","Ms-PL","Ms-RL","Perl","Python-2.0","QPL-1.0","Unlicense","W3C","WTFPL","Zlib","Zope","open-source","restricted","unrestricted","unknown"]},"redistributable_license":{"description":"A license that grants us the right to redistribute.","enum":["public-domain","Apache","Apache-1.0","Apache-2.0","Artistic","Artistic-1.0","Artistic-2.0","BSD-2-clause","BSD-3-clause","BSD-4-clause","ISC","CC-BY","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-3.0","CC-BY-4.0","CC-BY-SA","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-4.0","CC-BY-NC","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-4.0","CC-BY-NC-SA","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-4.0","CC-BY-NC-ND","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-4.0","CC-BY-ND","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-4.0","CC0","CDDL","CPL","EFL-1.0","EFL-2.0","Expat","MIT","GPL-1.0","GPL-2.0","GPL-3.0","LGPL-2.0","LGPL-2.1","LGPL-3.0","GFDL-1.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GFDL-NIV-1.0","GFDL-NIV-1.1","GFDL-NIV-1.2","GFDL-NIV-1.3","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3c","MPL-1.1","MPL-2.0","Perl","Python-2.0","QPL-1.0","W3C","Zlib","Zope","WTFPL","Unlicense","open-source","unrestricted"]},"licenses":{"description":"A license, or array of licenses","anyOf":[{"$ref":"#/definitions/license"},{"type":"array","items":{"$ref":"#/definitions/license"},"uniqueItems":true}]},"one_or_more_strings":{"description":"One or more strings","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"},"uniqueItems":true}]}}}
|
Provide a JSON object that satisfies the schema "CKAN JSON Schema". Here are the required top‑level fields: spec_version, name, author, abstract, identifier, license, version. Return only the valid JSON object.
|
CKAN JSON Schema
|
schema-store
|
schema_store_13
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://cveproject.github.io/cve-schema/schema/CVE_Record_Format.json\",\"title\":\"CVE JSON record format\",\"description\":\"cve-schema specifies the CVE JSON record format. This is the blueprint for a rich set of JSON data that can be submitted by CVE Numbering Authorities (CNAs) and Authorized Data Publishers (ADPs) to describe a CVE Record. Some examples of CVE Record data include CVE ID number, affected product(s), affected version(s), and public references. While those specific items are required when assigning a CVE, there are many other optional data in the schema that can be used to enrich CVE Records for community benefit. Learn more about the CVE program at [the official website](https://cve.mitre.org). This CVE JSON record format is defined using JSON Schema. Learn more about JSON Schema [here](https://json-schema.org/).\",\"definitions\":{\"uriType\":{\"description\":\"A universal resource identifier (URI), according to [RFC 3986](https://tools.ietf.org/html/rfc3986).\",\"type\":\"string\",\"format\":\"uri\",\"minLength\":1,\"maxLength\":2048},\"uuidType\":{\"description\":\"A version 4 (random) universally unique identifier (UUID) as defined by [RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.3).\",\"type\":\"string\",\"pattern\":\"^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$\"},\"reference\":{\"type\":\"object\",\"required\":[\"url\"],\"properties\":{\"url\":{\"description\":\"The uniform resource locator (URL), according to [RFC 3986](https://tools.ietf.org/html/rfc3986#section-1.1.3), that can be used to retrieve the referenced resource.\",\"$ref\":\"#/definitions/uriType\"},\"name\":{\"description\":\"User created name for the reference, often the title of the page.\",\"type\":\"string\",\"maxLength\":512,\"minLength\":1},\"tags\":{\"description\":\"An array of one or more tags that describe the resource referenced by 'url'.\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"oneOf\":[{\"$ref\":\"#/definitions/tagExtension\"},{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://cve.mitre.org/cve/v5_00/tags/reference/\",\"type\":\"string\",\"description\":\"broken-link: The reference link is returning a 404 error, or the site is no longer online.\\n\\ncustomer-entitlement: Similar to Privileges Required, but specific to references that require non-public/paid access for customers of the particular vendor.\\n\\nexploit: Reference contains an in-depth/detailed description of steps to exploit a vulnerability OR the reference contains any legitimate Proof of Concept (PoC) code or exploit kit.\\n\\ngovernment-resource: All reference links that are from a government agency or organization should be given the Government Resource tag.\\n\\nissue-tracking: The reference is a post from a bug tracking tool such as MantisBT, Bugzilla, JIRA, Github Issues, etc...\\n\\nmailing-list: The reference is from a mailing list -- often specific to a product or vendor.\\n\\nmitigation: The reference contains information on steps to mitigate against the vulnerability in the event a patch can't be applied or is unavailable or for EOL product situations.\\n\\nnot-applicable: The reference link is not applicable to the vulnerability and was likely associated by MITRE accidentally (should be used sparingly).\\n\\npatch: The reference contains an update to the software that fixes the vulnerability.\\n\\npermissions-required: The reference link provided is blocked by a logon page. If credentials are required to see any information this tag must be applied.\\n\\nmedia-coverage: The reference is from a media outlet such as a newspaper, magazine, social media, or weblog. This tag is not intended to apply to any individual's personal social media account. It is strictly intended for public media entities.\\n\\nproduct: A reference appropriate for describing a product for the purpose of CPE or SWID.\\n\\nrelated: A reference that is for a related (but not the same) vulnerability.\\n\\nrelease-notes: The reference is in the format of a vendor or open source project's release notes or change log.\\n\\nsignature: The reference contains a method to detect or prevent the presence or exploitation of the vulnerability.\\n\\ntechnical-description: The reference contains in-depth technical information about a vulnerability and its exploitation process, typically in the form of a presentation or whitepaper.\\n\\nthird-party-advisory: Advisory is from an organization that is not the vulnerable product's vendor/publisher/maintainer.\\n\\nvendor-advisory: Advisory is from the vendor/publisher/maintainer of the product or the parent organization.\\n\\nvdb-entry: VDBs are loosely defined as sites that provide information about this vulnerability, such as advisories, with identifiers. Included VDBs are free to access, substantially public, and have broad scope and coverage (not limited to a single vendor or research organization). See: https://www.first.org/global/sigs/vrdx/vdb-catalog\",\"enum\":[\"broken-link\",\"customer-entitlement\",\"exploit\",\"government-resource\",\"issue-tracking\",\"mailing-list\",\"mitigation\",\"not-applicable\",\"patch\",\"permissions-required\",\"media-coverage\",\"product\",\"related\",\"release-notes\",\"signature\",\"technical-description\",\"third-party-advisory\",\"vendor-advisory\",\"vdb-entry\"]}]}}},\"additionalProperties\":false},\"cveId\":{\"type\":\"string\",\"pattern\":\"^CVE-[0-9]{4}-[0-9]{4,19}$\"},\"cpe22and23\":{\"type\":\"string\",\"description\":\"Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format\",\"pattern\":\"([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9._\\\\-~%]*){0,6})|(cpe:2\\\\.3:[aho*\\\\-](:(((\\\\?*|\\\\*?)([a-zA-Z0-9\\\\-._]|(\\\\\\\\[\\\\\\\\*?!\\\"#$%&'()+,/:;<=>@\\\\[\\\\]\\\\^`{|}~]))+(\\\\?*|\\\\*?))|[*\\\\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[*\\\\-]))(:(((\\\\?*|\\\\*?)([a-zA-Z0-9\\\\-._]|(\\\\\\\\[\\\\\\\\*?!\\\"#$%&'()+,/:;<=>@\\\\[\\\\]\\\\^`{|}~]))+(\\\\?*|\\\\*?))|[*\\\\-])){4})\",\"minLength\":1,\"maxLength\":2048},\"cpe23\":{\"type\":\"string\",\"description\":\"Common Platform Enumeration (CPE) Name in 2.3 format\",\"pattern\":\"(cpe:2\\\\.3:[aho*\\\\-](:(((\\\\?*|\\\\*?)([a-zA-Z0-9\\\\-._]|(\\\\\\\\[\\\\\\\\*?!\\\"#$%&'()+,/:;<=>@\\\\[\\\\]\\\\^`{|}~]))+(\\\\?*|\\\\*?))|[*\\\\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[*\\\\-]))(:(((\\\\?*|\\\\*?)([a-zA-Z0-9\\\\-._]|(\\\\\\\\[\\\\\\\\*?!\\\"#$%&'()+,/:;<=>@\\\\[\\\\]\\\\^`{|}~]))+(\\\\?*|\\\\*?))|[*\\\\-])){4})\",\"minLength\":1,\"maxLength\":2048},\"orgId\":{\"description\":\"A UUID for an organization participating in the CVE program. This UUID can be used to lookup the organization record in the user registry service.\",\"$ref\":\"#/definitions/uuidType\"},\"userId\":{\"description\":\"A UUID for a user participating in the CVE program. This UUID can be used to lookup the user record in the user registry service.\",\"$ref\":\"#/definitions/uuidType\"},\"shortName\":{\"description\":\"A 2-32 character name that can be used to complement an organization's UUID.\",\"type\":\"string\",\"minLength\":2,\"maxLength\":32},\"datestamp\":{\"description\":\"Date/time format based on RFC3339 and ISO ISO8601.\",\"type\":\"string\",\"format\":\"date\",\"pattern\":\"^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30))$\"},\"timestamp\":{\"type\":\"string\",\"description\":\"Date/time format based on RFC3339 and ISO ISO8601, with an optional timezone in the format 'yyyy-MM-ddTHH:mm:ss[+-]ZH:ZM'. If timezone offset is not given, GMT (+00:00) is assumed.\",\"pattern\":\"^(((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30)))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})?$\"},\"version\":{\"description\":\"A single version of a product, as expressed in its own version numbering scheme.\",\"type\":\"string\",\"minLength\":1,\"maxLength\":1024},\"status\":{\"description\":\"The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.\",\"type\":\"string\",\"enum\":[\"affected\",\"unaffected\",\"unknown\"]},\"product\":{\"type\":\"object\",\"description\":\"Provides information about the set of products and services affected by this vulnerability.\",\"allOf\":[{\"anyOf\":[{\"required\":[\"vendor\",\"product\"]},{\"required\":[\"collectionURL\",\"packageName\"]}]},{\"anyOf\":[{\"required\":[\"versions\"]},{\"required\":[\"defaultStatus\"]}]}],\"properties\":{\"vendor\":{\"type\":\"string\",\"description\":\"Name of the organization, project, community, individual, or user that created or maintains this product or hosted service. Can be 'N/A' if none of those apply. When collectionURL and packageName are used, this field may optionally represent the user or account within the package collection associated with the package.\",\"minLength\":1,\"maxLength\":512},\"product\":{\"type\":\"string\",\"description\":\"Name of the affected product.\",\"minLength\":1,\"maxLength\":2048},\"collectionURL\":{\"description\":\"URL identifying a package collection (determines the meaning of packageName).\",\"$ref\":\"#/definitions/uriType\",\"examples\":[\"https://access.redhat.com/downloads/content/package-browser\",\"https://addons.mozilla.org\",\"https://addons.thunderbird.net\",\"https://anaconda.org/anaconda/repo\",\"https://app.vagrantup.com/boxes/search\",\"https://apps.apple.com\",\"https://archlinux.org/packages\",\"https://atmospherejs.meteor.com\",\"https://atom.io/packages\",\"https://bitbucket.org\",\"https://bower.io\",\"https://brew.sh/\",\"https://chocolatey.org/packages\",\"https://chrome.google.com/webstore\",\"https://clojars.org\",\"https://cocoapods.org\",\"https://code.dlang.org\",\"https://conan.io/center\",\"https://cpan.org/modules\",\"https://cran.r-project.org\",\"https://crates.io\",\"https://ctan.org/pkg\",\"https://drupal.org\",\"https://exchange.adobe.com\",\"https://forge.puppet.com/modules\",\"https://github.com\",\"https://gitlab.com/explore\",\"https://golang.org/pkg\",\"https://guix.gnu.org/packages\",\"https://hackage.haskell.org\",\"https://helm.sh\",\"https://hub.docker.com\",\"https://juliahub.com\",\"https://lib.haxe.org\",\"https://luarocks.org\",\"https://marketplace.visualstudio.com\",\"https://melpa.org\",\"https://microsoft.com/en-us/store/apps\",\"https://nimble.directory\",\"https://nuget.org/packages\",\"https://opam.ocaml.org/packages\",\"https://openwrt.org/packages/index\",\"https://package.elm-lang.org\",\"https://packagecontrol.io\",\"https://packages.debian.org\",\"https://packages.gentoo.org\",\"https://packagist.org\",\"https://pear.php.net/packages.php\",\"https://pecl.php.net\",\"https://platformio.org/lib\",\"https://play.google.com/store\",\"https://plugins.gradle.org\",\"https://projects.eclipse.org\",\"https://pub.dev\",\"https://pypi.python.org\",\"https://registry.npmjs.org\",\"https://registry.terraform.io\",\"https://repo.hex.pm\",\"https://repo.maven.apache.org/maven2\",\"https://rubygems.org\",\"https://search.nixos.org/packages\",\"https://sourceforge.net\",\"https://wordpress.org/plugins\"]},\"packageName\":{\"type\":\"string\",\"description\":\"Name or identifier of the affected software package as used in the package collection.\",\"minLength\":1,\"maxLength\":2048},\"cpes\":{\"type\":\"array\",\"description\":\"Affected products defined by CPE. This is an array of CPE values (vulnerable and not), we use an array so that we can make multiple statements about the same version and they are separate (if we used a JSON object we'd essentially be keying on the CPE name and they would have to overlap). Also, this allows things like cveDataVersion or cveDescription to be applied directly to the product entry. This also allows more complex statements such as \\\"Product X between versions 10.2 and 10.8\\\" to be put in a machine-readable format. As well since multiple statements can be used multiple branches of the same product can be defined here. NOTE: Consider using the newer cpeApplicability block for defining CPE data using the CPE Applicability Language which includes more options for defining CPE Names.\",\"uniqueItems\":true,\"items\":{\"title\":\"CPE Name\",\"description\":\"Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format\",\"$ref\":\"#/definitions/cpe22and23\"}},\"modules\":{\"type\":\"array\",\"description\":\"A list of the affected components, features, modules, sub-components, sub-products, APIs, commands, utilities, programs, or functionalities (optional).\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"description\":\"Name of the affected component, feature, module, sub-component, sub-product, API, command, utility, program, or functionality (optional).\",\"minLength\":1,\"maxLength\":4096}},\"programFiles\":{\"type\":\"array\",\"description\":\"A list of the affected source code files (optional).\",\"uniqueItems\":true,\"items\":{\"description\":\"Name or path or location of the affected source code file.\",\"type\":\"string\",\"minLength\":1,\"maxLength\":1024}},\"programRoutines\":{\"type\":\"array\",\"description\":\"A list of the affected source code functions, methods, subroutines, or procedures (optional).\",\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"An object describing program routine.\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the affected source code file, function, method, subroutine, or procedure.\",\"minLength\":1,\"maxLength\":4096}},\"additionalProperties\":false}},\"platforms\":{\"title\":\"Platforms\",\"description\":\"List of specific platforms if the vulnerability is only relevant in the context of these platforms (optional). Platforms may include execution environments, operating systems, virtualization technologies, hardware models, or computing architectures. The lack of this field or an empty array implies that the other fields are applicable to all relevant platforms.\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"examples\":[\"iOS\",\"Android\",\"Windows\",\"macOS\",\"x86\",\"ARM\",\"64 bit\",\"Big Endian\",\"iPad\",\"Chromebook\",\"Docker\",\"Model T\"],\"maxLength\":1024}},\"repo\":{\"description\":\"The URL of the source code repository, for informational purposes and/or to resolve git hash version ranges.\",\"$ref\":\"#/definitions/uriType\"},\"defaultStatus\":{\"description\":\"The default status for versions that are not otherwise listed in the versions list. If not specified, defaultStatus defaults to 'unknown'. Versions or defaultStatus may be omitted, but not both.\",\"$ref\":\"#/definitions/status\"},\"versions\":{\"type\":\"array\",\"description\":\"Set of product versions or version ranges related to the vulnerability. The versions satisfy the CNA Rules [8.1.2 requirement](https://cve.mitre.org/cve/cna/rules.html#section_8-1_cve_entry_information_requirements). Versions or defaultStatus may be omitted, but not both.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"A single version or a range of versions, with vulnerability status.\\n\\nAn entry with only 'version' and 'status' indicates the status of a single version.\\n\\nOtherwise, an entry describes a range; it must include the 'versionType' property, to define the version numbering semantics in use, and 'limit', to indicate the non-inclusive upper limit of the range. The object describes the status for versions V such that 'version' <= V and V < 'limit', using the <= and < semantics defined for the specific kind of 'versionType'. Status changes within the range can be specified by an optional 'changes' list.\\n\\nThe algorithm to decide the status specified for a version V is:\\n\\n\\tfor entry in product.versions {\\n\\t\\tif entry.lessThan is not present and entry.lessThanOrEqual is not present and v == entry.version {\\n\\t\\t\\treturn entry.status\\n\\t\\t}\\n\\t\\tif (entry.lessThan is present and entry.version <= v and v < entry.lessThan) or\\n\\t\\t (entry.lessThanOrEqual is present and entry.version <= v and v <= entry.lessThanOrEqual) { // <= and < defined by entry.versionType\\n\\t\\t\\tstatus = entry.status\\n\\t\\t\\tfor change in entry.changes {\\n\\t\\t\\t\\tif change.at <= v {\\n\\t\\t\\t\\t\\tstatus = change.status\\n\\t\\t\\t\\t}\\n\\t\\t\\t}\\n\\t\\t\\treturn status\\n\\t\\t}\\n\\t}\\n\\treturn product.defaultStatus\\n\\n.\",\"oneOf\":[{\"required\":[\"version\",\"status\"],\"maxProperties\":2},{\"required\":[\"version\",\"status\",\"versionType\"],\"maxProperties\":3},{\"required\":[\"version\",\"status\",\"versionType\",\"lessThan\"]},{\"required\":[\"version\",\"status\",\"versionType\",\"lessThanOrEqual\"]}],\"properties\":{\"version\":{\"description\":\"The single version being described, or the version at the start of the range. By convention, typically 0 denotes the earliest possible version.\",\"$ref\":\"#/definitions/version\"},\"status\":{\"description\":\"The vulnerability status for the version or range of versions. For a range, the status may be refined by the 'changes' list.\",\"$ref\":\"#/definitions/status\"},\"versionType\":{\"type\":\"string\",\"description\":\"The version numbering system used for specifying the range. This defines the exact semantics of the comparison (less-than) operation on versions, which is required to understand the range itself. 'Custom' indicates that the version type is unspecified and should be avoided whenever possible. It is included primarily for use in conversion of older data files.\",\"minLength\":1,\"maxLength\":128,\"examples\":[\"custom\",\"git\",\"maven\",\"python\",\"rpm\",\"semver\"]},\"lessThan\":{\"description\":\"The non-inclusive upper limit of the range. This is the least version NOT in the range. The usual version syntax is expanded to allow a pattern to end in an asterisk `(*)`, indicating an arbitrarily large number in the version ordering. For example, `{version: 1.0 lessThan: 1.*}` would describe the entire 1.X branch for most range kinds, and `{version: 2.0, lessThan: *}` describes all versions starting at 2.0, including 3.0, 5.1, and so on. Only one of lessThan and lessThanOrEqual should be specified.\",\"$ref\":\"#/definitions/version\"},\"lessThanOrEqual\":{\"description\":\"The inclusive upper limit of the range. This is the greatest version contained in the range. Only one of lessThan and lessThanOrEqual should be specified. For example, `{version: 1.0, lessThanOrEqual: 1.3}` covers all versions from 1.0 up to and including 1.3.\",\"$ref\":\"#/definitions/version\"},\"changes\":{\"type\":\"array\",\"description\":\"A list of status changes that take place during the range. The array should be sorted in increasing order by the 'at' field, according to the versionType, but clients must re-sort the list themselves rather than assume it is sorted.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"The start of a single status change during the range.\",\"required\":[\"at\",\"status\"],\"additionalProperties\":false,\"properties\":{\"at\":{\"description\":\"The version at which a status change occurs.\",\"$ref\":\"#/definitions/version\"},\"status\":{\"description\":\"The new status in the range starting at the given version.\",\"$ref\":\"#/definitions/status\"}}}}},\"additionalProperties\":false}}}},\"dataType\":{\"description\":\"Indicates the type of information represented in the JSON instance.\",\"type\":\"string\",\"enum\":[\"CVE_RECORD\"]},\"dataVersion\":{\"description\":\"The version of the CVE schema used for validating this record. Used to support multiple versions of this format.\",\"type\":\"string\",\"pattern\":\"^5\\\\.(0|[1-9][0-9]*)(\\\\.(0|[1-9][0-9]*))?$\",\"default\":\"5.1.1\"},\"cveMetadataPublished\":{\"description\":\"This is meta data about the CVE ID such as the CVE ID, who requested it, who assigned it, when it was requested, the current state (PUBLISHED, REJECTED, etc.) and so on. These fields are controlled by the CVE Services.\",\"type\":\"object\",\"required\":[\"cveId\",\"assignerOrgId\",\"state\"],\"properties\":{\"cveId\":{\"description\":\"The CVE identifier that this record pertains to.\",\"$ref\":\"#/definitions/cveId\"},\"assignerOrgId\":{\"$ref\":\"#/definitions/orgId\",\"description\":\"The UUID for the organization to which the CVE ID was originally assigned. This UUID can be used to lookup the organization record in the user registry service.\"},\"assignerShortName\":{\"$ref\":\"#/definitions/shortName\",\"description\":\"The short name for the organization to which the CVE ID was originally assigned.\"},\"requesterUserId\":{\"$ref\":\"#/definitions/userId\",\"description\":\"The user that requested the CVE identifier.\"},\"dateUpdated\":{\"description\":\"The date/time the record was last updated.\",\"$ref\":\"#/definitions/timestamp\"},\"serial\":{\"type\":\"integer\",\"minimum\":1,\"description\":\"The system of record causes this to start at 1, and increment by 1 each time a submission from a data provider changes this CVE Record. The incremented value moves to the Rejected schema upon a PUBLISHED->REJECTED transition, and moves to the Published schema upon a REJECTED->PUBLISHED transition.\"},\"dateReserved\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"The date/time this CVE ID was reserved in the CVE automation workgroup services system. Disclaimer: This date reflects when the CVE ID was reserved, and does not necessarily indicate when this vulnerability was discovered, shared with the affected vendor, publicly disclosed, or updated in CVE.\"},\"datePublished\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"The date/time the CVE Record was first published in the CVE List.\"},\"state\":{\"description\":\"State of CVE - PUBLISHED, REJECTED.\",\"type\":\"string\",\"enum\":[\"PUBLISHED\"]}},\"additionalProperties\":false},\"cveMetadataRejected\":{\"type\":\"object\",\"description\":\"This is meta data about the CVE ID such as the CVE ID, who requested it, who assigned it, when it was requested, the current state (PUBLISHED, REJECTED, etc.) and so on. These fields are controlled by the CVE Services.\",\"required\":[\"cveId\",\"assignerOrgId\",\"state\"],\"properties\":{\"cveId\":{\"description\":\"The CVE identifier that this record pertains to.\",\"$ref\":\"#/definitions/cveId\"},\"assignerOrgId\":{\"$ref\":\"#/definitions/orgId\",\"description\":\"The UUID for the organization to which the CVE ID was originally assigned.\"},\"assignerShortName\":{\"$ref\":\"#/definitions/shortName\",\"description\":\"The short name for the organization to which the CVE ID was originally assigned.\"},\"serial\":{\"type\":\"integer\",\"minimum\":1,\"description\":\"The system of record causes this to start at 1, and increment by 1 each time a submission from a data provider changes this CVE Record. The incremented value moves to the Rejected schema upon a PUBLISHED->REJECTED transition, and moves to the Published schema upon a REJECTED->PUBLISHED transition.\"},\"dateUpdated\":{\"description\":\"The date/time the record was last updated.\",\"$ref\":\"#/definitions/timestamp\"},\"datePublished\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"The date/time the CVE Record was first published in the CVE List.\"},\"dateRejected\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"The date/time the CVE ID was rejected.\"},\"state\":{\"type\":\"string\",\"description\":\"State of CVE - PUBLISHED, REJECTED.\",\"enum\":[\"REJECTED\"]},\"dateReserved\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"The date/time this CVE ID was reserved in the CVE automation workgroup services system. Disclaimer: This date reflects when the CVE ID was reserved, and does not necessarily indicate when this vulnerability was discovered, shared with the affected vendor, publicly disclosed, or updated in CVE.\"}},\"additionalProperties\":false},\"providerMetadata\":{\"type\":\"object\",\"description\":\"Details related to the information container provider (CNA or ADP).\",\"properties\":{\"orgId\":{\"$ref\":\"#/definitions/orgId\",\"description\":\"The container provider's organizational UUID.\"},\"shortName\":{\"$ref\":\"#/definitions/shortName\",\"description\":\"The container provider's organizational short name.\"},\"dateUpdated\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"Timestamp to be set by the system of record at time of submission. If dateUpdated is provided to the system of record it will be replaced by the current timestamp at the time of submission.\"}},\"required\":[\"orgId\"],\"additionalProperties\":false},\"cpeApplicabilityElement\":{\"description\":\"Affected products defined using an implementation of the CPE Applicability Language, mostly copied/forked from the NIST NVD CVE API v2.0 schema (optional). An operator property allows AND or OR logic between CPEs or combinations of CPEs. The negate and vulnerable Boolean properties allow CPEs to be inverted and/or defined as vulnerable or not. Multiple version fields are provided for capturing ranges of products when defining a CPE Match String Range. NOTE: When defining a cpeApplicability block, it is recommended that it align with (as much as possible) the product data provided within the affected block.\",\"properties\":{\"operator\":{\"type\":\"string\",\"enum\":[\"AND\",\"OR\"]},\"negate\":{\"type\":\"boolean\"},\"nodes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/cpe_node\"}}},\"required\":[\"nodes\"]},\"cpe_node\":{\"description\":\"Defines a CPE configuration node in an applicability statement.\",\"properties\":{\"operator\":{\"type\":\"string\",\"enum\":[\"AND\",\"OR\"]},\"negate\":{\"type\":\"boolean\"},\"cpeMatch\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/cpe_match\"}}},\"required\":[\"operator\",\"cpeMatch\"]},\"cpe_match\":{\"description\":\"CPE match string or range\",\"type\":\"object\",\"properties\":{\"vulnerable\":{\"type\":\"boolean\"},\"criteria\":{\"$ref\":\"#/definitions/cpe23\"},\"matchCriteriaId\":{\"$ref\":\"#/definitions/uuidType\"},\"versionStartExcluding\":{\"$ref\":\"#/definitions/version\"},\"versionStartIncluding\":{\"$ref\":\"#/definitions/version\"},\"versionEndExcluding\":{\"$ref\":\"#/definitions/version\"},\"versionEndIncluding\":{\"$ref\":\"#/definitions/version\"}},\"required\":[\"vulnerable\",\"criteria\"],\"additionalProperties\":false},\"cnaPublishedContainer\":{\"description\":\"An object containing the vulnerability information provided by a CVE Numbering Authority (CNA) for a published CVE ID. There can only be one CNA container per CVE record since there can only be one assigning CNA. The CNA container must include the required information defined in the CVE Rules, which includes a product, version, problem type, prose description, and a reference.\",\"type\":\"object\",\"properties\":{\"providerMetadata\":{\"$ref\":\"#/definitions/providerMetadata\"},\"dateAssigned\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"The date/time this CVE ID was associated with a vulnerability by a CNA.\"},\"datePublic\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"If known, the date/time the vulnerability was disclosed publicly.\"},\"title\":{\"type\":\"string\",\"description\":\"A title, headline, or a brief phrase summarizing the CVE record. Eg., Buffer overflow in Example Soft.\",\"minLength\":1,\"maxLength\":256},\"descriptions\":{\"$ref\":\"#/definitions/descriptions\"},\"affected\":{\"$ref\":\"#/definitions/affected\"},\"cpeApplicability\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/cpeApplicabilityElement\"}},\"problemTypes\":{\"$ref\":\"#/definitions/problemTypes\"},\"references\":{\"$ref\":\"#/definitions/references\"},\"impacts\":{\"$ref\":\"#/definitions/impacts\"},\"metrics\":{\"$ref\":\"#/definitions/metrics\"},\"configurations\":{\"$ref\":\"#/definitions/configurations\"},\"workarounds\":{\"$ref\":\"#/definitions/workarounds\"},\"solutions\":{\"$ref\":\"#/definitions/solutions\"},\"exploits\":{\"$ref\":\"#/definitions/exploits\"},\"timeline\":{\"$ref\":\"#/definitions/timeline\"},\"credits\":{\"$ref\":\"#/definitions/credits\"},\"source\":{\"$ref\":\"#/definitions/source\"},\"tags\":{\"$ref\":\"#/definitions/cnaTags\"},\"taxonomyMappings\":{\"$ref\":\"#/definitions/taxonomyMappings\"}},\"required\":[\"providerMetadata\",\"descriptions\",\"affected\",\"references\"],\"patternProperties\":{\"^x_[^.]*$\":{}},\"$comment\":\"The character . is restricted in names allowed by patternProperties to work-around naming limitations in some common implementations.\",\"additionalProperties\":false},\"cnaRejectedContainer\":{\"description\":\"An object containing the vulnerability information provided by a CVE Numbering Authority (CNA) for a rejected CVE ID. There can only be one CNA container per CVE record since there can only be one assigning CNA.\",\"type\":\"object\",\"properties\":{\"providerMetadata\":{\"$ref\":\"#/definitions/providerMetadata\"},\"rejectedReasons\":{\"description\":\"Reasons for rejecting this CVE Record.\",\"$ref\":\"#/definitions/descriptions\"},\"replacedBy\":{\"type\":\"array\",\"description\":\"Contains an array of CVE IDs that this CVE ID was rejected in favor of because this CVE ID was assigned to the vulnerabilities.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/cveId\"}}},\"required\":[\"providerMetadata\",\"rejectedReasons\"],\"patternProperties\":{\"^x_[^.]*$\":{}},\"$comment\":\"The character . is restricted in names allowed by patternProperties to work-around naming limitations in some common implementations.\",\"additionalProperties\":false},\"adpContainer\":{\"description\":\"An object containing the vulnerability information provided by an Authorized Data Publisher (ADP). Since multiple ADPs can provide information for a CVE ID, an ADP container must indicate which ADP is the source of the information in the object.\",\"type\":\"object\",\"properties\":{\"providerMetadata\":{\"$ref\":\"#/definitions/providerMetadata\"},\"datePublic\":{\"$ref\":\"#/definitions/timestamp\",\"description\":\"If known, the date/time the vulnerability was disclosed publicly.\"},\"title\":{\"type\":\"string\",\"description\":\"A title, headline, or a brief phrase summarizing the information in an ADP container.\",\"minLength\":1,\"maxLength\":256},\"descriptions\":{\"$ref\":\"#/definitions/descriptions\"},\"affected\":{\"$ref\":\"#/definitions/affected\"},\"cpeApplicability\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/cpeApplicabilityElement\"}},\"problemTypes\":{\"$ref\":\"#/definitions/problemTypes\"},\"references\":{\"$ref\":\"#/definitions/references\"},\"impacts\":{\"$ref\":\"#/definitions/impacts\"},\"metrics\":{\"$ref\":\"#/definitions/metrics\"},\"configurations\":{\"$ref\":\"#/definitions/configurations\"},\"workarounds\":{\"$ref\":\"#/definitions/workarounds\"},\"solutions\":{\"$ref\":\"#/definitions/solutions\"},\"exploits\":{\"$ref\":\"#/definitions/exploits\"},\"timeline\":{\"$ref\":\"#/definitions/timeline\"},\"credits\":{\"$ref\":\"#/definitions/credits\"},\"source\":{\"$ref\":\"#/definitions/source\"},\"tags\":{\"$ref\":\"#/definitions/adpTags\"},\"taxonomyMappings\":{\"$ref\":\"#/definitions/taxonomyMappings\"}},\"required\":[\"providerMetadata\"],\"minProperties\":2,\"patternProperties\":{\"^x_[^.]*$\":{}},\"$comment\":\"The character . is restricted in names allowed by patternProperties to work-around naming limitations in some common implementations.\",\"additionalProperties\":false},\"affected\":{\"type\":\"array\",\"description\":\"List of affected products.\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/product\"}},\"description\":{\"type\":\"object\",\"description\":\"Text in a particular language with optional alternate markup or formatted representation (e.g., Markdown) or embedded media.\",\"properties\":{\"lang\":{\"$ref\":\"#/definitions/language\"},\"value\":{\"type\":\"string\",\"description\":\"Plain text description.\",\"minLength\":1,\"maxLength\":4096},\"supportingMedia\":{\"type\":\"array\",\"title\":\"Supporting media\",\"description\":\"Supporting media data for the description such as markdown, diagrams, .. (optional). Similar to RFC 2397 each media object has three main parts: media type, media data value, and an optional boolean flag to indicate if the media data is base64 encoded.\",\"uniqueItems\":true,\"minItems\":1,\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"Media type\",\"minLength\":1,\"maxLength\":256,\"description\":\"RFC2046 compliant IANA Media type for eg., text/markdown, text/html.\",\"examples\":[\"text/markdown\",\"text/html\",\"image/png\",\"image/svg\",\"audio/mp3\"]},\"base64\":{\"type\":\"boolean\",\"title\":\"Encoding\",\"description\":\"If true then the value field contains the media data encoded in base64. If false then the value field contains the UTF-8 media content.\",\"default\":false},\"value\":{\"type\":\"string\",\"description\":\"Supporting media content, up to 16K. If base64 is true, this field stores base64 encoded data.\",\"minLength\":1,\"maxLength\":16384}},\"required\":[\"type\",\"value\"],\"additionalProperties\":false}}},\"required\":[\"lang\",\"value\"],\"additionalProperties\":false},\"englishLanguageDescription\":{\"type\":\"object\",\"description\":\"A description with lang set to an English language (en, en_US, en_UK, and so on).\",\"properties\":{\"lang\":{\"$ref\":\"#/definitions/englishLanguage\"}},\"required\":[\"lang\"],\"$comment\":\"Cannot use additionalProperties: false here, as this prevents the other properties used by /definitions/description.\"},\"descriptions\":{\"type\":\"array\",\"description\":\"A list of multi-lingual descriptions of the vulnerability. E.g., [PROBLEMTYPE] in [COMPONENT] in [VENDOR] [PRODUCT] [VERSION] on [PLATFORMS] allows [ATTACKER] to [IMPACT] via [VECTOR]. OR [COMPONENT] in [VENDOR] [PRODUCT] [VERSION] [ROOT CAUSE], which allows [ATTACKER] to [IMPACT] via [VECTOR].\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/description\"},\"contains\":{\"$ref\":\"#/definitions/englishLanguageDescription\"}},\"problemTypes\":{\"type\":\"array\",\"description\":\"This is problem type information (e.g. CWE identifier). Must contain: At least one entry, can be text, OWASP, CWE, please note that while only one is required you can use more than one (or indeed all three) as long as they are correct). (CNA requirement: [PROBLEMTYPE]).\",\"items\":{\"type\":\"object\",\"required\":[\"descriptions\"],\"properties\":{\"descriptions\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"lang\",\"description\"],\"properties\":{\"lang\":{\"$ref\":\"#/definitions/language\"},\"description\":{\"type\":\"string\",\"description\":\"Text description of problemType, or title from CWE or OWASP.\",\"minLength\":1,\"maxLength\":4096},\"cweId\":{\"type\":\"string\",\"description\":\"CWE ID of the CWE that best describes this problemType entry.\",\"minLength\":5,\"maxLength\":9,\"pattern\":\"^CWE-[1-9][0-9]*$\"},\"type\":{\"type\":\"string\",\"description\":\"Problemtype source, text, OWASP, CWE, etc.,\",\"minLength\":1,\"maxLength\":128},\"references\":{\"$ref\":\"#/definitions/references\"}},\"additionalProperties\":false},\"minItems\":1,\"uniqueItems\":true}},\"additionalProperties\":false},\"minItems\":1,\"uniqueItems\":true},\"references\":{\"type\":\"array\",\"description\":\"This is reference data in the form of URLs or file objects (uuencoded and embedded within the JSON file, exact format to be decided, e.g. we may require a compressed format so the objects require unpacking before they are \\\"dangerous\\\").\",\"items\":{\"$ref\":\"#/definitions/reference\"},\"minItems\":1,\"maxItems\":512,\"uniqueItems\":true},\"impacts\":{\"type\":\"array\",\"description\":\"Collection of impacts of this vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"This is impact type information (e.g. a text description.\",\"required\":[\"descriptions\"],\"properties\":{\"capecId\":{\"type\":\"string\",\"description\":\"CAPEC ID that best relates to this impact.\",\"minLength\":7,\"maxLength\":11,\"pattern\":\"^CAPEC-[1-9][0-9]{0,4}$\"},\"descriptions\":{\"description\":\"Prose description of the impact scenario. At a minimum provide the description given by CAPEC.\",\"$ref\":\"#/definitions/descriptions\"}},\"additionalProperties\":false}},\"metrics\":{\"type\":\"array\",\"description\":\"Collection of impact scores with attribution.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"This is impact type information (e.g. a text description, CVSSv2, CVSSv3, CVSSV4, etc.). Must contain: At least one entry, can be text, CVSSv2, CVSSv3, others may be added.\",\"anyOf\":[{\"required\":[\"cvssV4_0\"]},{\"required\":[\"cvssV3_1\"]},{\"required\":[\"cvssV3_0\"]},{\"required\":[\"cvssV2_0\"]},{\"required\":[\"other\"]}],\"properties\":{\"format\":{\"type\":\"string\",\"description\":\"Name of the scoring format. This provides a bit of future proofing. Additional properties are not prohibited, so this will support the inclusion of proprietary formats. It also provides an easy future conversion mechanism when future score formats become part of the schema. example: cvssV44, format = 'cvssV44', other = cvssV4_4 JSON object. In the future, the other properties can be converted to score properties when they become part of the schema.\",\"minLength\":1,\"maxLength\":64},\"scenarios\":{\"type\":\"array\",\"description\":\"Description of the scenarios this metrics object applies to. If no specific scenario is given, GENERAL is used as the default and applies when no more specific metric matches.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"properties\":{\"lang\":{\"$ref\":\"#/definitions/language\"},\"value\":{\"type\":\"string\",\"default\":\"GENERAL\",\"description\":\"Description of the scenario this metrics object applies to. If no specific scenario is given, GENERAL is used as the default and applies when no more specific metric matches.\",\"minLength\":1,\"maxLength\":4096}},\"required\":[\"lang\",\"value\"],\"additionalProperties\":false}},\"cvssV4_0\":{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"JSON Schema for Common Vulnerability Scoring System version 4.0\",\"type\":\"object\",\"definitions\":{\"attackVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT\",\"LOCAL\",\"PHYSICAL\"]},\"modifiedAttackVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT\",\"LOCAL\",\"PHYSICAL\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"attackComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\"]},\"modifiedAttackComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"attackRequirementsType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PRESENT\"]},\"modifiedAttackRequirementsType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PRESENT\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"privilegesRequiredType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NONE\"]},\"modifiedPrivilegesRequiredType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NONE\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"userInteractionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PASSIVE\",\"ACTIVE\"]},\"modifiedUserInteractionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PASSIVE\",\"ACTIVE\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"vulnCiaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\"]},\"modifiedVulnCiaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"subCiaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\"]},\"modifiedSubCType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"modifiedSubIaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\",\"SAFETY\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"exploitMaturityType\":{\"type\":\"string\",\"enum\":[\"UNREPORTED\",\"PROOF_OF_CONCEPT\",\"ATTACKED\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"ciaRequirementType\":{\"type\":\"string\",\"enum\":[\"LOW\",\"MEDIUM\",\"HIGH\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"safetyType\":{\"type\":\"string\",\"enum\":[\"NEGLIGIBLE\",\"PRESENT\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"automatableType\":{\"type\":\"string\",\"enum\":[\"NO\",\"YES\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"recoveryType\":{\"type\":\"string\",\"enum\":[\"AUTOMATIC\",\"USER\",\"IRRECOVERABLE\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"valueDensityType\":{\"type\":\"string\",\"enum\":[\"DIFFUSE\",\"CONCENTRATED\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"vulnerabilityResponseEffortType\":{\"type\":\"string\",\"enum\":[\"LOW\",\"MODERATE\",\"HIGH\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"providerUrgencyType\":{\"type\":\"string\",\"enum\":[\"CLEAR\",\"GREEN\",\"AMBER\",\"RED\",\"NOT_DEFINED\"],\"default\":\"NOT_DEFINED\"},\"scoreType\":{\"type\":\"number\",\"enum\":[0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9,7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9,9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},\"noneScoreType\":{\"type\":\"number\",\"minimum\":0,\"maximum\":0},\"lowScoreType\":{\"type\":\"number\",\"enum\":[0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9]},\"mediumScoreType\":{\"type\":\"number\",\"enum\":[4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9]},\"highScoreType\":{\"type\":\"number\",\"enum\":[7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9]},\"criticalScoreType\":{\"type\":\"number\",\"enum\":[9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},\"severityType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"MEDIUM\",\"HIGH\",\"CRITICAL\"]},\"noneSeverityType\":{\"const\":\"NONE\"},\"lowSeverityType\":{\"const\":\"LOW\"},\"mediumSeverityType\":{\"const\":\"MEDIUM\"},\"highSeverityType\":{\"const\":\"HIGH\"},\"criticalSeverityType\":{\"const\":\"CRITICAL\"}},\"properties\":{\"version\":{\"description\":\"CVSS Version\",\"type\":\"string\",\"enum\":[\"4.0\"]},\"vectorString\":{\"type\":\"string\",\"pattern\":\"^CVSS:4[.]0/AV:[NALP]/AC:[LH]/AT:[NP]/PR:[NLH]/UI:[NPA]/VC:[HLN]/VI:[HLN]/VA:[HLN]/SC:[HLN]/SI:[HLN]/SA:[HLN](/E:[XAPU])?(/CR:[XHML])?(/IR:[XHML])?(/AR:[XHML])?(/MAV:[XNALP])?(/MAC:[XLH])?(/MAT:[XNP])?(/MPR:[XNLH])?(/MUI:[XNPA])?(/MVC:[XNLH])?(/MVI:[XNLH])?(/MVA:[XNLH])?(/MSC:[XNLH])?(/MSI:[XNLHS])?(/MSA:[XNLHS])?(/S:[XNP])?(/AU:[XNY])?(/R:[XAUI])?(/V:[XDC])?(/RE:[XLMH])?(/U:(X|Clear|Green|Amber|Red))?$\"},\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/scoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/severityType\"},\"attackVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/attackVectorType\"},\"attackComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/attackComplexityType\"},\"attackRequirements\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/attackRequirementsType\"},\"privilegesRequired\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/privilegesRequiredType\"},\"userInteraction\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/userInteractionType\"},\"vulnConfidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnCiaType\"},\"vulnIntegrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnCiaType\"},\"vulnAvailabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnCiaType\"},\"subConfidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/subCiaType\"},\"subIntegrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/subCiaType\"},\"subAvailabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/subCiaType\"},\"exploitMaturity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/exploitMaturityType\"},\"confidentialityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/ciaRequirementType\"},\"integrityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/ciaRequirementType\"},\"availabilityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/ciaRequirementType\"},\"modifiedAttackVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedAttackVectorType\"},\"modifiedAttackComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedAttackComplexityType\"},\"modifiedAttackRequirements\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedAttackRequirementsType\"},\"modifiedPrivilegesRequired\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedPrivilegesRequiredType\"},\"modifiedUserInteraction\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedUserInteractionType\"},\"modifiedVulnConfidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedVulnCiaType\"},\"modifiedVulnIntegrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedVulnCiaType\"},\"modifiedVulnAvailabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedVulnCiaType\"},\"modifiedSubConfidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedSubCType\"},\"modifiedSubIntegrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedSubIaType\"},\"modifiedSubAvailabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedSubIaType\"},\"Safety\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/safetyType\"},\"Automatable\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/automatableType\"},\"Recovery\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/recoveryType\"},\"valueDensity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/valueDensityType\"},\"vulnerabilityResponseEffort\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnerabilityResponseEffortType\"},\"providerUrgency\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/providerUrgencyType\"}},\"allOf\":[{\"anyOf\":[{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/highScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/highSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalSeverityType\"}}}]},{\"anyOf\":[{\"properties\":{\"threatScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneScoreType\"},\"threatSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneSeverityType\"}}},{\"properties\":{\"threatScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowScoreType\"},\"threatSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowSeverityType\"}}},{\"properties\":{\"threatScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumScoreType\"},\"threatSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumSeverityType\"}}},{\"properties\":{\"threatScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/highScoreType\"},\"threatSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/highSeverityType\"}}},{\"properties\":{\"threatScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalScoreType\"},\"threatSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalSeverityType\"}}}]},{\"anyOf\":[{\"properties\":{\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneScoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneSeverityType\"}}},{\"properties\":{\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowScoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowSeverityType\"}}},{\"properties\":{\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumScoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumSeverityType\"}}},{\"properties\":{\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/highScoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/highSeverityType\"}}},{\"properties\":{\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalScoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalSeverityType\"}}}]}],\"required\":[\"version\",\"vectorString\",\"baseScore\",\"baseSeverity\"],\"additionalProperties\":false},\"cvssV3_1\":{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"JSON Schema for Common Vulnerability Scoring System version 3.1\",\"type\":\"object\",\"definitions\":{\"attackVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT_NETWORK\",\"LOCAL\",\"PHYSICAL\"]},\"modifiedAttackVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT_NETWORK\",\"LOCAL\",\"PHYSICAL\",\"NOT_DEFINED\"]},\"attackComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\"]},\"modifiedAttackComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NOT_DEFINED\"]},\"privilegesRequiredType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NONE\"]},\"modifiedPrivilegesRequiredType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NONE\",\"NOT_DEFINED\"]},\"userInteractionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"REQUIRED\"]},\"modifiedUserInteractionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"REQUIRED\",\"NOT_DEFINED\"]},\"scopeType\":{\"type\":\"string\",\"enum\":[\"UNCHANGED\",\"CHANGED\"]},\"modifiedScopeType\":{\"type\":\"string\",\"enum\":[\"UNCHANGED\",\"CHANGED\",\"NOT_DEFINED\"]},\"ciaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\"]},\"modifiedCiaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\",\"NOT_DEFINED\"]},\"exploitCodeMaturityType\":{\"type\":\"string\",\"enum\":[\"UNPROVEN\",\"PROOF_OF_CONCEPT\",\"FUNCTIONAL\",\"HIGH\",\"NOT_DEFINED\"]},\"remediationLevelType\":{\"type\":\"string\",\"enum\":[\"OFFICIAL_FIX\",\"TEMPORARY_FIX\",\"WORKAROUND\",\"UNAVAILABLE\",\"NOT_DEFINED\"]},\"confidenceType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"REASONABLE\",\"CONFIRMED\",\"NOT_DEFINED\"]},\"ciaRequirementType\":{\"type\":\"string\",\"enum\":[\"LOW\",\"MEDIUM\",\"HIGH\",\"NOT_DEFINED\"]},\"scoreType\":{\"type\":\"number\",\"enum\":[0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9,7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9,9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},\"severityType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"MEDIUM\",\"HIGH\",\"CRITICAL\"]},\"noneScoreType\":{\"type\":\"number\",\"minimum\":0,\"maximum\":0},\"lowScoreType\":{\"type\":\"number\",\"enum\":[0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9]},\"mediumScoreType\":{\"type\":\"number\",\"enum\":[4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9]},\"highScoreType\":{\"type\":\"number\",\"enum\":[7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9]},\"criticalScoreType\":{\"type\":\"number\",\"enum\":[9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},\"noneSeverityType\":{\"const\":\"NONE\"},\"lowSeverityType\":{\"const\":\"LOW\"},\"mediumSeverityType\":{\"const\":\"MEDIUM\"},\"highSeverityType\":{\"const\":\"HIGH\"},\"criticalSeverityType\":{\"const\":\"CRITICAL\"}},\"properties\":{\"version\":{\"description\":\"CVSS Version\",\"type\":\"string\",\"enum\":[\"3.1\"]},\"vectorString\":{\"type\":\"string\",\"pattern\":\"^CVSS:3[.]1/((AV:[NALP]|AC:[LH]|PR:[NLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])/)*(AV:[NALP]|AC:[LH]|PR:[NLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])$\"},\"attackVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/attackVectorType\"},\"attackComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/attackComplexityType\"},\"privilegesRequired\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/privilegesRequiredType\"},\"userInteraction\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/userInteractionType\"},\"scope\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/scopeType\"},\"confidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaType\"},\"integrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaType\"},\"availabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaType\"},\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/scoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/severityType\"},\"exploitCodeMaturity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/exploitCodeMaturityType\"},\"remediationLevel\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/remediationLevelType\"},\"reportConfidence\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/confidenceType\"},\"temporalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/scoreType\"},\"temporalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/severityType\"},\"confidentialityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaRequirementType\"},\"integrityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaRequirementType\"},\"availabilityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaRequirementType\"},\"modifiedAttackVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedAttackVectorType\"},\"modifiedAttackComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedAttackComplexityType\"},\"modifiedPrivilegesRequired\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedPrivilegesRequiredType\"},\"modifiedUserInteraction\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedUserInteractionType\"},\"modifiedScope\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedScopeType\"},\"modifiedConfidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedCiaType\"},\"modifiedIntegrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedCiaType\"},\"modifiedAvailabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedCiaType\"},\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/scoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/severityType\"}},\"anyOf\":[{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/noneScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/noneSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/lowScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/lowSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/mediumScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/mediumSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/highScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/highSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/criticalScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_1/definitions/criticalSeverityType\"}}}],\"required\":[\"version\",\"vectorString\",\"baseScore\",\"baseSeverity\"],\"additionalProperties\":false},\"cvssV3_0\":{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"JSON Schema for Common Vulnerability Scoring System version 3.0\",\"type\":\"object\",\"definitions\":{\"attackVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT_NETWORK\",\"LOCAL\",\"PHYSICAL\"]},\"modifiedAttackVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT_NETWORK\",\"LOCAL\",\"PHYSICAL\",\"NOT_DEFINED\"]},\"attackComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\"]},\"modifiedAttackComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NOT_DEFINED\"]},\"privilegesRequiredType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NONE\"]},\"modifiedPrivilegesRequiredType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"LOW\",\"NONE\",\"NOT_DEFINED\"]},\"userInteractionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"REQUIRED\"]},\"modifiedUserInteractionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"REQUIRED\",\"NOT_DEFINED\"]},\"scopeType\":{\"type\":\"string\",\"enum\":[\"UNCHANGED\",\"CHANGED\"]},\"modifiedScopeType\":{\"type\":\"string\",\"enum\":[\"UNCHANGED\",\"CHANGED\",\"NOT_DEFINED\"]},\"ciaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\"]},\"modifiedCiaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"HIGH\",\"NOT_DEFINED\"]},\"exploitCodeMaturityType\":{\"type\":\"string\",\"enum\":[\"UNPROVEN\",\"PROOF_OF_CONCEPT\",\"FUNCTIONAL\",\"HIGH\",\"NOT_DEFINED\"]},\"remediationLevelType\":{\"type\":\"string\",\"enum\":[\"OFFICIAL_FIX\",\"TEMPORARY_FIX\",\"WORKAROUND\",\"UNAVAILABLE\",\"NOT_DEFINED\"]},\"confidenceType\":{\"type\":\"string\",\"enum\":[\"UNKNOWN\",\"REASONABLE\",\"CONFIRMED\",\"NOT_DEFINED\"]},\"ciaRequirementType\":{\"type\":\"string\",\"enum\":[\"LOW\",\"MEDIUM\",\"HIGH\",\"NOT_DEFINED\"]},\"scoreType\":{\"type\":\"number\",\"enum\":[0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9,7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9,9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},\"noneScoreType\":{\"type\":\"number\",\"minimum\":0,\"maximum\":0},\"lowScoreType\":{\"type\":\"number\",\"enum\":[0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9]},\"mediumScoreType\":{\"type\":\"number\",\"enum\":[4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9]},\"highScoreType\":{\"type\":\"number\",\"enum\":[7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9]},\"criticalScoreType\":{\"type\":\"number\",\"enum\":[9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},\"severityType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"MEDIUM\",\"HIGH\",\"CRITICAL\"]},\"noneSeverityType\":{\"const\":\"NONE\"},\"lowSeverityType\":{\"const\":\"LOW\"},\"mediumSeverityType\":{\"const\":\"MEDIUM\"},\"highSeverityType\":{\"const\":\"HIGH\"},\"criticalSeverityType\":{\"const\":\"CRITICAL\"}},\"properties\":{\"version\":{\"description\":\"CVSS Version\",\"type\":\"string\",\"enum\":[\"3.0\"]},\"vectorString\":{\"type\":\"string\",\"pattern\":\"^CVSS:3[.]0/((AV:[NALP]|AC:[LH]|PR:[UNLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XUNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])/)*(AV:[NALP]|AC:[LH]|PR:[UNLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XUNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])$\"},\"attackVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/attackVectorType\"},\"attackComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/attackComplexityType\"},\"privilegesRequired\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/privilegesRequiredType\"},\"userInteraction\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/userInteractionType\"},\"scope\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/scopeType\"},\"confidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaType\"},\"integrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaType\"},\"availabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaType\"},\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/scoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/severityType\"},\"exploitCodeMaturity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/exploitCodeMaturityType\"},\"remediationLevel\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/remediationLevelType\"},\"reportConfidence\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/confidenceType\"},\"temporalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/scoreType\"},\"temporalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/severityType\"},\"confidentialityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaRequirementType\"},\"integrityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaRequirementType\"},\"availabilityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaRequirementType\"},\"modifiedAttackVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedAttackVectorType\"},\"modifiedAttackComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedAttackComplexityType\"},\"modifiedPrivilegesRequired\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedPrivilegesRequiredType\"},\"modifiedUserInteraction\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedUserInteractionType\"},\"modifiedScope\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedScopeType\"},\"modifiedConfidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedCiaType\"},\"modifiedIntegrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedCiaType\"},\"modifiedAvailabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedCiaType\"},\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/scoreType\"},\"environmentalSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/severityType\"}},\"anyOf\":[{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/noneScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/noneSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/lowScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/lowSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/mediumScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/mediumSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/highScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/highSeverityType\"}}},{\"properties\":{\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/criticalScoreType\"},\"baseSeverity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV3_0/definitions/criticalSeverityType\"}}}],\"required\":[\"version\",\"vectorString\",\"baseScore\",\"baseSeverity\"],\"additionalProperties\":false},\"cvssV2_0\":{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"title\":\"JSON Schema for Common Vulnerability Scoring System version 2.0\",\"type\":\"object\",\"definitions\":{\"accessVectorType\":{\"type\":\"string\",\"enum\":[\"NETWORK\",\"ADJACENT_NETWORK\",\"LOCAL\"]},\"accessComplexityType\":{\"type\":\"string\",\"enum\":[\"HIGH\",\"MEDIUM\",\"LOW\"]},\"authenticationType\":{\"type\":\"string\",\"enum\":[\"MULTIPLE\",\"SINGLE\",\"NONE\"]},\"ciaType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"PARTIAL\",\"COMPLETE\"]},\"exploitabilityType\":{\"type\":\"string\",\"enum\":[\"UNPROVEN\",\"PROOF_OF_CONCEPT\",\"FUNCTIONAL\",\"HIGH\",\"NOT_DEFINED\"]},\"remediationLevelType\":{\"type\":\"string\",\"enum\":[\"OFFICIAL_FIX\",\"TEMPORARY_FIX\",\"WORKAROUND\",\"UNAVAILABLE\",\"NOT_DEFINED\"]},\"reportConfidenceType\":{\"type\":\"string\",\"enum\":[\"UNCONFIRMED\",\"UNCORROBORATED\",\"CONFIRMED\",\"NOT_DEFINED\"]},\"collateralDamagePotentialType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"LOW_MEDIUM\",\"MEDIUM_HIGH\",\"HIGH\",\"NOT_DEFINED\"]},\"targetDistributionType\":{\"type\":\"string\",\"enum\":[\"NONE\",\"LOW\",\"MEDIUM\",\"HIGH\",\"NOT_DEFINED\"]},\"ciaRequirementType\":{\"type\":\"string\",\"enum\":[\"LOW\",\"MEDIUM\",\"HIGH\",\"NOT_DEFINED\"]},\"scoreType\":{\"type\":\"number\",\"minimum\":0,\"maximum\":10}},\"properties\":{\"version\":{\"description\":\"CVSS Version\",\"type\":\"string\",\"enum\":[\"2.0\"]},\"vectorString\":{\"type\":\"string\",\"pattern\":\"^((AV:[NAL]|AC:[LMH]|Au:[MSN]|[CIA]:[NPC]|E:(U|POC|F|H|ND)|RL:(OF|TF|W|U|ND)|RC:(UC|UR|C|ND)|CDP:(N|L|LM|MH|H|ND)|TD:(N|L|M|H|ND)|[CIA]R:(L|M|H|ND))/)*(AV:[NAL]|AC:[LMH]|Au:[MSN]|[CIA]:[NPC]|E:(U|POC|F|H|ND)|RL:(OF|TF|W|U|ND)|RC:(UC|UR|C|ND)|CDP:(N|L|LM|MH|H|ND)|TD:(N|L|M|H|ND)|[CIA]R:(L|M|H|ND))$\"},\"accessVector\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/accessVectorType\"},\"accessComplexity\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/accessComplexityType\"},\"authentication\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/authenticationType\"},\"confidentialityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaType\"},\"integrityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaType\"},\"availabilityImpact\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaType\"},\"baseScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/scoreType\"},\"exploitability\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/exploitabilityType\"},\"remediationLevel\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/remediationLevelType\"},\"reportConfidence\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/reportConfidenceType\"},\"temporalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/scoreType\"},\"collateralDamagePotential\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/collateralDamagePotentialType\"},\"targetDistribution\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/targetDistributionType\"},\"confidentialityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaRequirementType\"},\"integrityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaRequirementType\"},\"availabilityRequirement\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaRequirementType\"},\"environmentalScore\":{\"$ref\":\"#/definitions/metrics/items/properties/cvssV2_0/definitions/scoreType\"}},\"required\":[\"version\",\"vectorString\",\"baseScore\"],\"additionalProperties\":false},\"other\":{\"type\":\"object\",\"description\":\"A non-standard impact description, may be prose or JSON block.\",\"required\":[\"type\",\"content\"],\"properties\":{\"type\":{\"description\":\"Name of the non-standard impact metrics format used.\",\"type\":\"string\",\"minLength\":1,\"maxLength\":128},\"content\":{\"type\":\"object\",\"$comment\":\"additionalProperties are allowed here, since this construct supports arbitrary JSON.\",\"description\":\"JSON object not covered by another metrics format.\",\"minProperties\":1}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"configurations\":{\"type\":\"array\",\"description\":\"Configurations required for exploiting this vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/description\"}},\"workarounds\":{\"type\":\"array\",\"description\":\"Workarounds and mitigations for this vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/description\"}},\"solutions\":{\"type\":\"array\",\"description\":\"Information about solutions or remediations available for this vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/description\"}},\"exploits\":{\"type\":\"array\",\"description\":\"Information about exploits of the vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/description\"}},\"timeline\":{\"type\":\"array\",\"description\":\"This is timeline information for significant events about this vulnerability or changes to the CVE Record.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"required\":[\"time\",\"lang\",\"value\"],\"properties\":{\"time\":{\"description\":\"Timestamp representing when the event in the timeline occurred. The timestamp format is based on RFC3339 and ISO ISO8601, with an optional timezone. yyyy-MM-ddTHH:mm:ss[+-]ZH:ZM - if the timezone offset is not given, GMT (+00:00) is assumed.\",\"$ref\":\"#/definitions/timestamp\"},\"lang\":{\"description\":\"The language used in the description of the event. The language field is included so that CVE Records can support translations. The value must be a BCP 47 language code.\",\"$ref\":\"#/definitions/language\"},\"value\":{\"description\":\"A summary of the event.\",\"type\":\"string\",\"minLength\":1,\"maxLength\":4096}},\"additionalProperties\":false}},\"credits\":{\"type\":\"array\",\"description\":\"Statements acknowledging specific people, organizations, or tools recognizing the work done in researching, discovering, remediating or helping with activities related to this CVE.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"properties\":{\"lang\":{\"description\":\"The language used when describing the credits. The language field is included so that CVE Records can support translations. The value must be a BCP 47 language code.\",\"$ref\":\"#/definitions/language\"},\"value\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":4096},\"user\":{\"description\":\"UUID of the user being credited if present in the CVE User Registry (optional). This UUID can be used to lookup the user record in the user registry service.\",\"$ref\":\"#/definitions/uuidType\"},\"type\":{\"type\":\"string\",\"description\":\"Type or role of the entity being credited (optional). finder: identifies the vulnerability.\\nreporter: notifies the vendor of the vulnerability to a CNA.\\nanalyst: validates the vulnerability to ensure accuracy or severity.\\ncoordinator: facilitates the coordinated response process.\\nremediation developer: prepares a code change or other remediation plans.\\nremediation reviewer: reviews vulnerability remediation plans or code changes for effectiveness and completeness.\\nremediation verifier: tests and verifies the vulnerability or its remediation.\\ntool: names of tools used in vulnerability discovery or identification.\\nsponsor: supports the vulnerability identification or remediation activities.\",\"default\":\"finder\",\"enum\":[\"finder\",\"reporter\",\"analyst\",\"coordinator\",\"remediation developer\",\"remediation reviewer\",\"remediation verifier\",\"tool\",\"sponsor\",\"other\"]}},\"additionalProperties\":false,\"required\":[\"lang\",\"value\"]}},\"source\":{\"type\":\"object\",\"description\":\"This is the source information (who discovered it, who researched it, etc.) and optionally a chain of CNA information (e.g. the originating CNA and subsequent parent CNAs who have processed it before it arrives at the MITRE root).\\n Must contain: IF this is in the root level it MUST contain a CNA_chain entry, IF this source entry is NOT in the root (e.g. it is part of a vendor statement) then it must contain at least one type of data entry.\",\"minProperties\":1},\"language\":{\"type\":\"string\",\"description\":\"BCP 47 language code, language-region.\",\"default\":\"en\",\"pattern\":\"^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$\"},\"englishLanguage\":{\"type\":\"string\",\"description\":\"BCP 47 language code, language-region, required to be English.\",\"pattern\":\"^en([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$\"},\"taxonomyMappings\":{\"type\":\"array\",\"description\":\"List of taxonomy items related to the vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"A taxonomy mapping object identifies the taxonomy by a name and version (eg., ATT&CK v13.1, CVSS 3.1, CWE 4.12) along with a list of relations relevant to this CVE.\",\"required\":[\"taxonomyName\",\"taxonomyRelations\"],\"properties\":{\"taxonomyName\":{\"type\":\"string\",\"description\":\"The name of the taxonomy, eg., ATT&CK, D3FEND, CWE, CVSS\",\"minLength\":1,\"maxLength\":128},\"taxonomyVersion\":{\"type\":\"string\",\"description\":\"The version of taxonomy the identifiers come from.\",\"minLength\":1,\"maxLength\":128},\"taxonomyRelations\":{\"type\":\"array\",\"description\":\"List of relationships to the taxonomy for the vulnerability.\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"description\":\"A relationship between the taxonomy and the CVE or two taxonomy items.\",\"required\":[\"taxonomyId\",\"relationshipName\",\"relationshipValue\"],\"properties\":{\"taxonomyId\":{\"type\":\"string\",\"description\":\"Identifier of the item in the taxonomy. Used as the subject of the relationship.\",\"minLength\":1,\"maxLength\":2048},\"relationshipName\":{\"type\":\"string\",\"description\":\"A description of the relationship.\",\"minLength\":1,\"maxLength\":128},\"relationshipValue\":{\"type\":\"string\",\"description\":\"The target of the relationship. Can be the CVE ID or another taxonomy identifier.\",\"minLength\":1,\"maxLength\":2048}},\"additionalProperties\":false}}},\"additionalProperties\":false}},\"tagExtension\":{\"type\":\"string\",\"minLength\":2,\"maxLength\":128,\"pattern\":\"^x_.*$\",\"$comment\":\"These values are not used as JSON property names, so there is not a need to work-around property naming limitations in some common implementations.\"},\"cnaTags\":{\"type\":\"array\",\"description\":\"Tags provided by a CNA describing the CVE Record.\",\"uniqueItems\":true,\"minItems\":1,\"items\":{\"oneOf\":[{\"$ref\":\"#/definitions/tagExtension\"},{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://cve.mitre.org/cve/v5_00/tags/cna/\",\"type\":\"string\",\"description\":\"exclusively-hosted-service: All known software and/or hardware affected by this CVE Record is known to exist only in the affected hosted service. If the vulnerability affects both hosted and on-prem software and/or hardware, then the tag should not be used.\\n\\nunsupported-when-assigned: Used by the assigning CNA to indicate that when a request for a CVE assignment was received, the product was already end-of-life (EOL) or a product or specific version was deemed not to be supported by the vendor. This tag should only be applied to a CVE Record when all affected products or version lines referenced in the CVE-Record are EOL.\\n\\ndisputed: When one party disagrees with another party's assertion that a particular issue in software is a vulnerability, a CVE Record assigned to that issue may be tagged as being 'disputed'.\",\"enum\":[\"unsupported-when-assigned\",\"exclusively-hosted-service\",\"disputed\"]}]}},\"adpTags\":{\"type\":\"array\",\"description\":\"Tags provided by an ADP describing the CVE Record.\",\"uniqueItems\":true,\"minItems\":1,\"items\":{\"oneOf\":[{\"$ref\":\"#/definitions/tagExtension\"},{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://cve.mitre.org/cve/v5_00/tags/adp/\",\"type\":\"string\",\"description\":\"disputed: When one party disagrees with another party's assertion that a particular issue in software is a vulnerability, a CVE Record assigned to that issue may be tagged as being 'disputed'.\",\"enum\":[\"disputed\"]}]}}},\"oneOf\":[{\"title\":\"Published\",\"description\":\"When a CNA populates the data associated with a CVE ID as a CVE Record, the state of the CVE Record is Published.\",\"type\":\"object\",\"properties\":{\"dataType\":{\"$ref\":\"#/definitions/dataType\"},\"dataVersion\":{\"$ref\":\"#/definitions/dataVersion\"},\"cveMetadata\":{\"$ref\":\"#/definitions/cveMetadataPublished\"},\"containers\":{\"description\":\"A set of structures (called containers) used to store vulnerability information related to a specific CVE ID provided by a specific organization participating in the CVE program. Each container includes information provided by a different source.\\n\\nAt a minimum, a 'cna' container containing the vulnerability information provided by the CNA who initially assigned the CVE ID must be included.\\n\\nThere can only be one 'cna' container, as there can only be one assigning CNA. However, there can be multiple 'adp' containers, allowing multiple organizations participating in the CVE program to add additional information related to the vulnerability. For the most part, the 'cna' and 'adp' containers contain the same properties. The main differences are the source of the information. The 'cna' container requires the CNA to include certain fields, while the 'adp' container does not.\",\"type\":\"object\",\"properties\":{\"cna\":{\"$ref\":\"#/definitions/cnaPublishedContainer\"},\"adp\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/adpContainer\"},\"minItems\":1,\"uniqueItems\":true}},\"required\":[\"cna\"],\"additionalProperties\":false}},\"required\":[\"dataType\",\"dataVersion\",\"cveMetadata\",\"containers\"],\"additionalProperties\":false},{\"title\":\"Rejected\",\"description\":\"If the CVE ID and associated CVE Record should no longer be used, the CVE Record is placed in the Rejected state. A Rejected CVE Record remains on the CVE List so that users can know when it is invalid.\",\"type\":\"object\",\"properties\":{\"dataType\":{\"$ref\":\"#/definitions/dataType\"},\"dataVersion\":{\"$ref\":\"#/definitions/dataVersion\"},\"cveMetadata\":{\"$ref\":\"#/definitions/cveMetadataRejected\"},\"containers\":{\"description\":\"A set of structures (called containers) used to store vulnerability information related to a specific CVE ID provided by a specific organization participating in the CVE program. Each container includes information provided by a different source.\\n\\nAt minimum, a 'cna' container containing the vulnerability information provided by the CNA who initially assigned the CVE ID must be included.\\n\\nThere can only be one 'cna' container, as there can only be one assigning CNA.\",\"type\":\"object\",\"properties\":{\"cna\":{\"$ref\":\"#/definitions/cnaRejectedContainer\"}},\"required\":[\"cna\"],\"additionalProperties\":false}},\"required\":[\"dataType\",\"dataVersion\",\"cveMetadata\",\"containers\"],\"additionalProperties\":false}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"CVE JSON record format\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://cveproject.github.io/cve-schema/schema/CVE_Record_Format.json","title":"CVE JSON record format","description":"cve-schema specifies the CVE JSON record format. This is the blueprint for a rich set of JSON data that can be submitted by CVE Numbering Authorities (CNAs) and Authorized Data Publishers (ADPs) to describe a CVE Record. Some examples of CVE Record data include CVE ID number, affected product(s), affected version(s), and public references. While those specific items are required when assigning a CVE, there are many other optional data in the schema that can be used to enrich CVE Records for community benefit. Learn more about the CVE program at [the official website](https://cve.mitre.org). This CVE JSON record format is defined using JSON Schema. Learn more about JSON Schema [here](https://json-schema.org/).","definitions":{"uriType":{"description":"A universal resource identifier (URI), according to [RFC 3986](https://tools.ietf.org/html/rfc3986).","type":"string","format":"uri","minLength":1,"maxLength":2048},"uuidType":{"description":"A version 4 (random) universally unique identifier (UUID) as defined by [RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.3).","type":"string","pattern":"^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$"},"reference":{"type":"object","required":["url"],"properties":{"url":{"description":"The uniform resource locator (URL), according to [RFC 3986](https://tools.ietf.org/html/rfc3986#section-1.1.3), that can be used to retrieve the referenced resource.","$ref":"#/definitions/uriType"},"name":{"description":"User created name for the reference, often the title of the page.","type":"string","maxLength":512,"minLength":1},"tags":{"description":"An array of one or more tags that describe the resource referenced by 'url'.","type":"array","minItems":1,"uniqueItems":true,"items":{"oneOf":[{"$ref":"#/definitions/tagExtension"},{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://cve.mitre.org/cve/v5_00/tags/reference/","type":"string","description":"broken-link: The reference link is returning a 404 error, or the site is no longer online.\n\ncustomer-entitlement: Similar to Privileges Required, but specific to references that require non-public/paid access for customers of the particular vendor.\n\nexploit: Reference contains an in-depth/detailed description of steps to exploit a vulnerability OR the reference contains any legitimate Proof of Concept (PoC) code or exploit kit.\n\ngovernment-resource: All reference links that are from a government agency or organization should be given the Government Resource tag.\n\nissue-tracking: The reference is a post from a bug tracking tool such as MantisBT, Bugzilla, JIRA, Github Issues, etc...\n\nmailing-list: The reference is from a mailing list -- often specific to a product or vendor.\n\nmitigation: The reference contains information on steps to mitigate against the vulnerability in the event a patch can't be applied or is unavailable or for EOL product situations.\n\nnot-applicable: The reference link is not applicable to the vulnerability and was likely associated by MITRE accidentally (should be used sparingly).\n\npatch: The reference contains an update to the software that fixes the vulnerability.\n\npermissions-required: The reference link provided is blocked by a logon page. If credentials are required to see any information this tag must be applied.\n\nmedia-coverage: The reference is from a media outlet such as a newspaper, magazine, social media, or weblog. This tag is not intended to apply to any individual's personal social media account. It is strictly intended for public media entities.\n\nproduct: A reference appropriate for describing a product for the purpose of CPE or SWID.\n\nrelated: A reference that is for a related (but not the same) vulnerability.\n\nrelease-notes: The reference is in the format of a vendor or open source project's release notes or change log.\n\nsignature: The reference contains a method to detect or prevent the presence or exploitation of the vulnerability.\n\ntechnical-description: The reference contains in-depth technical information about a vulnerability and its exploitation process, typically in the form of a presentation or whitepaper.\n\nthird-party-advisory: Advisory is from an organization that is not the vulnerable product's vendor/publisher/maintainer.\n\nvendor-advisory: Advisory is from the vendor/publisher/maintainer of the product or the parent organization.\n\nvdb-entry: VDBs are loosely defined as sites that provide information about this vulnerability, such as advisories, with identifiers. Included VDBs are free to access, substantially public, and have broad scope and coverage (not limited to a single vendor or research organization). See: https://www.first.org/global/sigs/vrdx/vdb-catalog","enum":["broken-link","customer-entitlement","exploit","government-resource","issue-tracking","mailing-list","mitigation","not-applicable","patch","permissions-required","media-coverage","product","related","release-notes","signature","technical-description","third-party-advisory","vendor-advisory","vdb-entry"]}]}}},"additionalProperties":false},"cveId":{"type":"string","pattern":"^CVE-[0-9]{4}-[0-9]{4,19}$"},"cpe22and23":{"type":"string","description":"Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format","pattern":"([c][pP][eE]:/[AHOaho]?(:[A-Za-z0-9._\\-~%]*){0,6})|(cpe:2\\.3:[aho*\\-](:(((\\?*|\\*?)([a-zA-Z0-9\\-._]|(\\\\[\\\\*?!\"#$%&'()+,/:;<=>@\\[\\]\\^`{|}~]))+(\\?*|\\*?))|[*\\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[*\\-]))(:(((\\?*|\\*?)([a-zA-Z0-9\\-._]|(\\\\[\\\\*?!\"#$%&'()+,/:;<=>@\\[\\]\\^`{|}~]))+(\\?*|\\*?))|[*\\-])){4})","minLength":1,"maxLength":2048},"cpe23":{"type":"string","description":"Common Platform Enumeration (CPE) Name in 2.3 format","pattern":"(cpe:2\\.3:[aho*\\-](:(((\\?*|\\*?)([a-zA-Z0-9\\-._]|(\\\\[\\\\*?!\"#$%&'()+,/:;<=>@\\[\\]\\^`{|}~]))+(\\?*|\\*?))|[*\\-])){5}(:(([a-zA-Z]{2,3}(-([a-zA-Z]{2}|[0-9]{3}))?)|[*\\-]))(:(((\\?*|\\*?)([a-zA-Z0-9\\-._]|(\\\\[\\\\*?!\"#$%&'()+,/:;<=>@\\[\\]\\^`{|}~]))+(\\?*|\\*?))|[*\\-])){4})","minLength":1,"maxLength":2048},"orgId":{"description":"A UUID for an organization participating in the CVE program. This UUID can be used to lookup the organization record in the user registry service.","$ref":"#/definitions/uuidType"},"userId":{"description":"A UUID for a user participating in the CVE program. This UUID can be used to lookup the user record in the user registry service.","$ref":"#/definitions/uuidType"},"shortName":{"description":"A 2-32 character name that can be used to complement an organization's UUID.","type":"string","minLength":2,"maxLength":32},"datestamp":{"description":"Date/time format based on RFC3339 and ISO ISO8601.","type":"string","format":"date","pattern":"^((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30))$"},"timestamp":{"type":"string","description":"Date/time format based on RFC3339 and ISO ISO8601, with an optional timezone in the format 'yyyy-MM-ddTHH:mm:ss[+-]ZH:ZM'. If timezone offset is not given, GMT (+00:00) is assumed.","pattern":"^(((2000|2400|2800|(19|2[0-9](0[48]|[2468][048]|[13579][26])))-02-29)|(((19|2[0-9])[0-9]{2})-02-(0[1-9]|1[0-9]|2[0-8]))|(((19|2[0-9])[0-9]{2})-(0[13578]|10|12)-(0[1-9]|[12][0-9]|3[01]))|(((19|2[0-9])[0-9]{2})-(0[469]|11)-(0[1-9]|[12][0-9]|30)))T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\\.[0-9]+)?(Z|[+-][0-9]{2}:[0-9]{2})?$"},"version":{"description":"A single version of a product, as expressed in its own version numbering scheme.","type":"string","minLength":1,"maxLength":1024},"status":{"description":"The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.","type":"string","enum":["affected","unaffected","unknown"]},"product":{"type":"object","description":"Provides information about the set of products and services affected by this vulnerability.","allOf":[{"anyOf":[{"required":["vendor","product"]},{"required":["collectionURL","packageName"]}]},{"anyOf":[{"required":["versions"]},{"required":["defaultStatus"]}]}],"properties":{"vendor":{"type":"string","description":"Name of the organization, project, community, individual, or user that created or maintains this product or hosted service. Can be 'N/A' if none of those apply. When collectionURL and packageName are used, this field may optionally represent the user or account within the package collection associated with the package.","minLength":1,"maxLength":512},"product":{"type":"string","description":"Name of the affected product.","minLength":1,"maxLength":2048},"collectionURL":{"description":"URL identifying a package collection (determines the meaning of packageName).","$ref":"#/definitions/uriType","examples":["https://access.redhat.com/downloads/content/package-browser","https://addons.mozilla.org","https://addons.thunderbird.net","https://anaconda.org/anaconda/repo","https://app.vagrantup.com/boxes/search","https://apps.apple.com","https://archlinux.org/packages","https://atmospherejs.meteor.com","https://atom.io/packages","https://bitbucket.org","https://bower.io","https://brew.sh/","https://chocolatey.org/packages","https://chrome.google.com/webstore","https://clojars.org","https://cocoapods.org","https://code.dlang.org","https://conan.io/center","https://cpan.org/modules","https://cran.r-project.org","https://crates.io","https://ctan.org/pkg","https://drupal.org","https://exchange.adobe.com","https://forge.puppet.com/modules","https://github.com","https://gitlab.com/explore","https://golang.org/pkg","https://guix.gnu.org/packages","https://hackage.haskell.org","https://helm.sh","https://hub.docker.com","https://juliahub.com","https://lib.haxe.org","https://luarocks.org","https://marketplace.visualstudio.com","https://melpa.org","https://microsoft.com/en-us/store/apps","https://nimble.directory","https://nuget.org/packages","https://opam.ocaml.org/packages","https://openwrt.org/packages/index","https://package.elm-lang.org","https://packagecontrol.io","https://packages.debian.org","https://packages.gentoo.org","https://packagist.org","https://pear.php.net/packages.php","https://pecl.php.net","https://platformio.org/lib","https://play.google.com/store","https://plugins.gradle.org","https://projects.eclipse.org","https://pub.dev","https://pypi.python.org","https://registry.npmjs.org","https://registry.terraform.io","https://repo.hex.pm","https://repo.maven.apache.org/maven2","https://rubygems.org","https://search.nixos.org/packages","https://sourceforge.net","https://wordpress.org/plugins"]},"packageName":{"type":"string","description":"Name or identifier of the affected software package as used in the package collection.","minLength":1,"maxLength":2048},"cpes":{"type":"array","description":"Affected products defined by CPE. This is an array of CPE values (vulnerable and not), we use an array so that we can make multiple statements about the same version and they are separate (if we used a JSON object we'd essentially be keying on the CPE name and they would have to overlap). Also, this allows things like cveDataVersion or cveDescription to be applied directly to the product entry. This also allows more complex statements such as \"Product X between versions 10.2 and 10.8\" to be put in a machine-readable format. As well since multiple statements can be used multiple branches of the same product can be defined here. NOTE: Consider using the newer cpeApplicability block for defining CPE data using the CPE Applicability Language which includes more options for defining CPE Names.","uniqueItems":true,"items":{"title":"CPE Name","description":"Common Platform Enumeration (CPE) Name in either 2.2 or 2.3 format","$ref":"#/definitions/cpe22and23"}},"modules":{"type":"array","description":"A list of the affected components, features, modules, sub-components, sub-products, APIs, commands, utilities, programs, or functionalities (optional).","uniqueItems":true,"items":{"type":"string","description":"Name of the affected component, feature, module, sub-component, sub-product, API, command, utility, program, or functionality (optional).","minLength":1,"maxLength":4096}},"programFiles":{"type":"array","description":"A list of the affected source code files (optional).","uniqueItems":true,"items":{"description":"Name or path or location of the affected source code file.","type":"string","minLength":1,"maxLength":1024}},"programRoutines":{"type":"array","description":"A list of the affected source code functions, methods, subroutines, or procedures (optional).","uniqueItems":true,"items":{"type":"object","description":"An object describing program routine.","required":["name"],"properties":{"name":{"type":"string","description":"Name of the affected source code file, function, method, subroutine, or procedure.","minLength":1,"maxLength":4096}},"additionalProperties":false}},"platforms":{"title":"Platforms","description":"List of specific platforms if the vulnerability is only relevant in the context of these platforms (optional). Platforms may include execution environments, operating systems, virtualization technologies, hardware models, or computing architectures. The lack of this field or an empty array implies that the other fields are applicable to all relevant platforms.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string","examples":["iOS","Android","Windows","macOS","x86","ARM","64 bit","Big Endian","iPad","Chromebook","Docker","Model T"],"maxLength":1024}},"repo":{"description":"The URL of the source code repository, for informational purposes and/or to resolve git hash version ranges.","$ref":"#/definitions/uriType"},"defaultStatus":{"description":"The default status for versions that are not otherwise listed in the versions list. If not specified, defaultStatus defaults to 'unknown'. Versions or defaultStatus may be omitted, but not both.","$ref":"#/definitions/status"},"versions":{"type":"array","description":"Set of product versions or version ranges related to the vulnerability. The versions satisfy the CNA Rules [8.1.2 requirement](https://cve.mitre.org/cve/cna/rules.html#section_8-1_cve_entry_information_requirements). Versions or defaultStatus may be omitted, but not both.","minItems":1,"uniqueItems":true,"items":{"type":"object","description":"A single version or a range of versions, with vulnerability status.\n\nAn entry with only 'version' and 'status' indicates the status of a single version.\n\nOtherwise, an entry describes a range; it must include the 'versionType' property, to define the version numbering semantics in use, and 'limit', to indicate the non-inclusive upper limit of the range. The object describes the status for versions V such that 'version' <= V and V < 'limit', using the <= and < semantics defined for the specific kind of 'versionType'. Status changes within the range can be specified by an optional 'changes' list.\n\nThe algorithm to decide the status specified for a version V is:\n\n\tfor entry in product.versions {\n\t\tif entry.lessThan is not present and entry.lessThanOrEqual is not present and v == entry.version {\n\t\t\treturn entry.status\n\t\t}\n\t\tif (entry.lessThan is present and entry.version <= v and v < entry.lessThan) or\n\t\t (entry.lessThanOrEqual is present and entry.version <= v and v <= entry.lessThanOrEqual) { // <= and < defined by entry.versionType\n\t\t\tstatus = entry.status\n\t\t\tfor change in entry.changes {\n\t\t\t\tif change.at <= v {\n\t\t\t\t\tstatus = change.status\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn status\n\t\t}\n\t}\n\treturn product.defaultStatus\n\n.","oneOf":[{"required":["version","status"],"maxProperties":2},{"required":["version","status","versionType"],"maxProperties":3},{"required":["version","status","versionType","lessThan"]},{"required":["version","status","versionType","lessThanOrEqual"]}],"properties":{"version":{"description":"The single version being described, or the version at the start of the range. By convention, typically 0 denotes the earliest possible version.","$ref":"#/definitions/version"},"status":{"description":"The vulnerability status for the version or range of versions. For a range, the status may be refined by the 'changes' list.","$ref":"#/definitions/status"},"versionType":{"type":"string","description":"The version numbering system used for specifying the range. This defines the exact semantics of the comparison (less-than) operation on versions, which is required to understand the range itself. 'Custom' indicates that the version type is unspecified and should be avoided whenever possible. It is included primarily for use in conversion of older data files.","minLength":1,"maxLength":128,"examples":["custom","git","maven","python","rpm","semver"]},"lessThan":{"description":"The non-inclusive upper limit of the range. This is the least version NOT in the range. The usual version syntax is expanded to allow a pattern to end in an asterisk `(*)`, indicating an arbitrarily large number in the version ordering. For example, `{version: 1.0 lessThan: 1.*}` would describe the entire 1.X branch for most range kinds, and `{version: 2.0, lessThan: *}` describes all versions starting at 2.0, including 3.0, 5.1, and so on. Only one of lessThan and lessThanOrEqual should be specified.","$ref":"#/definitions/version"},"lessThanOrEqual":{"description":"The inclusive upper limit of the range. This is the greatest version contained in the range. Only one of lessThan and lessThanOrEqual should be specified. For example, `{version: 1.0, lessThanOrEqual: 1.3}` covers all versions from 1.0 up to and including 1.3.","$ref":"#/definitions/version"},"changes":{"type":"array","description":"A list of status changes that take place during the range. The array should be sorted in increasing order by the 'at' field, according to the versionType, but clients must re-sort the list themselves rather than assume it is sorted.","minItems":1,"uniqueItems":true,"items":{"type":"object","description":"The start of a single status change during the range.","required":["at","status"],"additionalProperties":false,"properties":{"at":{"description":"The version at which a status change occurs.","$ref":"#/definitions/version"},"status":{"description":"The new status in the range starting at the given version.","$ref":"#/definitions/status"}}}}},"additionalProperties":false}}}},"dataType":{"description":"Indicates the type of information represented in the JSON instance.","type":"string","enum":["CVE_RECORD"]},"dataVersion":{"description":"The version of the CVE schema used for validating this record. Used to support multiple versions of this format.","type":"string","pattern":"^5\\.(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))?$","default":"5.1.1"},"cveMetadataPublished":{"description":"This is meta data about the CVE ID such as the CVE ID, who requested it, who assigned it, when it was requested, the current state (PUBLISHED, REJECTED, etc.) and so on. These fields are controlled by the CVE Services.","type":"object","required":["cveId","assignerOrgId","state"],"properties":{"cveId":{"description":"The CVE identifier that this record pertains to.","$ref":"#/definitions/cveId"},"assignerOrgId":{"$ref":"#/definitions/orgId","description":"The UUID for the organization to which the CVE ID was originally assigned. This UUID can be used to lookup the organization record in the user registry service."},"assignerShortName":{"$ref":"#/definitions/shortName","description":"The short name for the organization to which the CVE ID was originally assigned."},"requesterUserId":{"$ref":"#/definitions/userId","description":"The user that requested the CVE identifier."},"dateUpdated":{"description":"The date/time the record was last updated.","$ref":"#/definitions/timestamp"},"serial":{"type":"integer","minimum":1,"description":"The system of record causes this to start at 1, and increment by 1 each time a submission from a data provider changes this CVE Record. The incremented value moves to the Rejected schema upon a PUBLISHED->REJECTED transition, and moves to the Published schema upon a REJECTED->PUBLISHED transition."},"dateReserved":{"$ref":"#/definitions/timestamp","description":"The date/time this CVE ID was reserved in the CVE automation workgroup services system. Disclaimer: This date reflects when the CVE ID was reserved, and does not necessarily indicate when this vulnerability was discovered, shared with the affected vendor, publicly disclosed, or updated in CVE."},"datePublished":{"$ref":"#/definitions/timestamp","description":"The date/time the CVE Record was first published in the CVE List."},"state":{"description":"State of CVE - PUBLISHED, REJECTED.","type":"string","enum":["PUBLISHED"]}},"additionalProperties":false},"cveMetadataRejected":{"type":"object","description":"This is meta data about the CVE ID such as the CVE ID, who requested it, who assigned it, when it was requested, the current state (PUBLISHED, REJECTED, etc.) and so on. These fields are controlled by the CVE Services.","required":["cveId","assignerOrgId","state"],"properties":{"cveId":{"description":"The CVE identifier that this record pertains to.","$ref":"#/definitions/cveId"},"assignerOrgId":{"$ref":"#/definitions/orgId","description":"The UUID for the organization to which the CVE ID was originally assigned."},"assignerShortName":{"$ref":"#/definitions/shortName","description":"The short name for the organization to which the CVE ID was originally assigned."},"serial":{"type":"integer","minimum":1,"description":"The system of record causes this to start at 1, and increment by 1 each time a submission from a data provider changes this CVE Record. The incremented value moves to the Rejected schema upon a PUBLISHED->REJECTED transition, and moves to the Published schema upon a REJECTED->PUBLISHED transition."},"dateUpdated":{"description":"The date/time the record was last updated.","$ref":"#/definitions/timestamp"},"datePublished":{"$ref":"#/definitions/timestamp","description":"The date/time the CVE Record was first published in the CVE List."},"dateRejected":{"$ref":"#/definitions/timestamp","description":"The date/time the CVE ID was rejected."},"state":{"type":"string","description":"State of CVE - PUBLISHED, REJECTED.","enum":["REJECTED"]},"dateReserved":{"$ref":"#/definitions/timestamp","description":"The date/time this CVE ID was reserved in the CVE automation workgroup services system. Disclaimer: This date reflects when the CVE ID was reserved, and does not necessarily indicate when this vulnerability was discovered, shared with the affected vendor, publicly disclosed, or updated in CVE."}},"additionalProperties":false},"providerMetadata":{"type":"object","description":"Details related to the information container provider (CNA or ADP).","properties":{"orgId":{"$ref":"#/definitions/orgId","description":"The container provider's organizational UUID."},"shortName":{"$ref":"#/definitions/shortName","description":"The container provider's organizational short name."},"dateUpdated":{"$ref":"#/definitions/timestamp","description":"Timestamp to be set by the system of record at time of submission. If dateUpdated is provided to the system of record it will be replaced by the current timestamp at the time of submission."}},"required":["orgId"],"additionalProperties":false},"cpeApplicabilityElement":{"description":"Affected products defined using an implementation of the CPE Applicability Language, mostly copied/forked from the NIST NVD CVE API v2.0 schema (optional). An operator property allows AND or OR logic between CPEs or combinations of CPEs. The negate and vulnerable Boolean properties allow CPEs to be inverted and/or defined as vulnerable or not. Multiple version fields are provided for capturing ranges of products when defining a CPE Match String Range. NOTE: When defining a cpeApplicability block, it is recommended that it align with (as much as possible) the product data provided within the affected block.","properties":{"operator":{"type":"string","enum":["AND","OR"]},"negate":{"type":"boolean"},"nodes":{"type":"array","items":{"$ref":"#/definitions/cpe_node"}}},"required":["nodes"]},"cpe_node":{"description":"Defines a CPE configuration node in an applicability statement.","properties":{"operator":{"type":"string","enum":["AND","OR"]},"negate":{"type":"boolean"},"cpeMatch":{"type":"array","items":{"$ref":"#/definitions/cpe_match"}}},"required":["operator","cpeMatch"]},"cpe_match":{"description":"CPE match string or range","type":"object","properties":{"vulnerable":{"type":"boolean"},"criteria":{"$ref":"#/definitions/cpe23"},"matchCriteriaId":{"$ref":"#/definitions/uuidType"},"versionStartExcluding":{"$ref":"#/definitions/version"},"versionStartIncluding":{"$ref":"#/definitions/version"},"versionEndExcluding":{"$ref":"#/definitions/version"},"versionEndIncluding":{"$ref":"#/definitions/version"}},"required":["vulnerable","criteria"],"additionalProperties":false},"cnaPublishedContainer":{"description":"An object containing the vulnerability information provided by a CVE Numbering Authority (CNA) for a published CVE ID. There can only be one CNA container per CVE record since there can only be one assigning CNA. The CNA container must include the required information defined in the CVE Rules, which includes a product, version, problem type, prose description, and a reference.","type":"object","properties":{"providerMetadata":{"$ref":"#/definitions/providerMetadata"},"dateAssigned":{"$ref":"#/definitions/timestamp","description":"The date/time this CVE ID was associated with a vulnerability by a CNA."},"datePublic":{"$ref":"#/definitions/timestamp","description":"If known, the date/time the vulnerability was disclosed publicly."},"title":{"type":"string","description":"A title, headline, or a brief phrase summarizing the CVE record. Eg., Buffer overflow in Example Soft.","minLength":1,"maxLength":256},"descriptions":{"$ref":"#/definitions/descriptions"},"affected":{"$ref":"#/definitions/affected"},"cpeApplicability":{"type":"array","items":{"$ref":"#/definitions/cpeApplicabilityElement"}},"problemTypes":{"$ref":"#/definitions/problemTypes"},"references":{"$ref":"#/definitions/references"},"impacts":{"$ref":"#/definitions/impacts"},"metrics":{"$ref":"#/definitions/metrics"},"configurations":{"$ref":"#/definitions/configurations"},"workarounds":{"$ref":"#/definitions/workarounds"},"solutions":{"$ref":"#/definitions/solutions"},"exploits":{"$ref":"#/definitions/exploits"},"timeline":{"$ref":"#/definitions/timeline"},"credits":{"$ref":"#/definitions/credits"},"source":{"$ref":"#/definitions/source"},"tags":{"$ref":"#/definitions/cnaTags"},"taxonomyMappings":{"$ref":"#/definitions/taxonomyMappings"}},"required":["providerMetadata","descriptions","affected","references"],"patternProperties":{"^x_[^.]*$":{}},"$comment":"The character . is restricted in names allowed by patternProperties to work-around naming limitations in some common implementations.","additionalProperties":false},"cnaRejectedContainer":{"description":"An object containing the vulnerability information provided by a CVE Numbering Authority (CNA) for a rejected CVE ID. There can only be one CNA container per CVE record since there can only be one assigning CNA.","type":"object","properties":{"providerMetadata":{"$ref":"#/definitions/providerMetadata"},"rejectedReasons":{"description":"Reasons for rejecting this CVE Record.","$ref":"#/definitions/descriptions"},"replacedBy":{"type":"array","description":"Contains an array of CVE IDs that this CVE ID was rejected in favor of because this CVE ID was assigned to the vulnerabilities.","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/cveId"}}},"required":["providerMetadata","rejectedReasons"],"patternProperties":{"^x_[^.]*$":{}},"$comment":"The character . is restricted in names allowed by patternProperties to work-around naming limitations in some common implementations.","additionalProperties":false},"adpContainer":{"description":"An object containing the vulnerability information provided by an Authorized Data Publisher (ADP). Since multiple ADPs can provide information for a CVE ID, an ADP container must indicate which ADP is the source of the information in the object.","type":"object","properties":{"providerMetadata":{"$ref":"#/definitions/providerMetadata"},"datePublic":{"$ref":"#/definitions/timestamp","description":"If known, the date/time the vulnerability was disclosed publicly."},"title":{"type":"string","description":"A title, headline, or a brief phrase summarizing the information in an ADP container.","minLength":1,"maxLength":256},"descriptions":{"$ref":"#/definitions/descriptions"},"affected":{"$ref":"#/definitions/affected"},"cpeApplicability":{"type":"array","items":{"$ref":"#/definitions/cpeApplicabilityElement"}},"problemTypes":{"$ref":"#/definitions/problemTypes"},"references":{"$ref":"#/definitions/references"},"impacts":{"$ref":"#/definitions/impacts"},"metrics":{"$ref":"#/definitions/metrics"},"configurations":{"$ref":"#/definitions/configurations"},"workarounds":{"$ref":"#/definitions/workarounds"},"solutions":{"$ref":"#/definitions/solutions"},"exploits":{"$ref":"#/definitions/exploits"},"timeline":{"$ref":"#/definitions/timeline"},"credits":{"$ref":"#/definitions/credits"},"source":{"$ref":"#/definitions/source"},"tags":{"$ref":"#/definitions/adpTags"},"taxonomyMappings":{"$ref":"#/definitions/taxonomyMappings"}},"required":["providerMetadata"],"minProperties":2,"patternProperties":{"^x_[^.]*$":{}},"$comment":"The character . is restricted in names allowed by patternProperties to work-around naming limitations in some common implementations.","additionalProperties":false},"affected":{"type":"array","description":"List of affected products.","minItems":1,"items":{"$ref":"#/definitions/product"}},"description":{"type":"object","description":"Text in a particular language with optional alternate markup or formatted representation (e.g., Markdown) or embedded media.","properties":{"lang":{"$ref":"#/definitions/language"},"value":{"type":"string","description":"Plain text description.","minLength":1,"maxLength":4096},"supportingMedia":{"type":"array","title":"Supporting media","description":"Supporting media data for the description such as markdown, diagrams, .. (optional). Similar to RFC 2397 each media object has three main parts: media type, media data value, and an optional boolean flag to indicate if the media data is base64 encoded.","uniqueItems":true,"minItems":1,"items":{"type":"object","properties":{"type":{"type":"string","title":"Media type","minLength":1,"maxLength":256,"description":"RFC2046 compliant IANA Media type for eg., text/markdown, text/html.","examples":["text/markdown","text/html","image/png","image/svg","audio/mp3"]},"base64":{"type":"boolean","title":"Encoding","description":"If true then the value field contains the media data encoded in base64. If false then the value field contains the UTF-8 media content.","default":false},"value":{"type":"string","description":"Supporting media content, up to 16K. If base64 is true, this field stores base64 encoded data.","minLength":1,"maxLength":16384}},"required":["type","value"],"additionalProperties":false}}},"required":["lang","value"],"additionalProperties":false},"englishLanguageDescription":{"type":"object","description":"A description with lang set to an English language (en, en_US, en_UK, and so on).","properties":{"lang":{"$ref":"#/definitions/englishLanguage"}},"required":["lang"],"$comment":"Cannot use additionalProperties: false here, as this prevents the other properties used by /definitions/description."},"descriptions":{"type":"array","description":"A list of multi-lingual descriptions of the vulnerability. E.g., [PROBLEMTYPE] in [COMPONENT] in [VENDOR] [PRODUCT] [VERSION] on [PLATFORMS] allows [ATTACKER] to [IMPACT] via [VECTOR]. OR [COMPONENT] in [VENDOR] [PRODUCT] [VERSION] [ROOT CAUSE], which allows [ATTACKER] to [IMPACT] via [VECTOR].","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/description"},"contains":{"$ref":"#/definitions/englishLanguageDescription"}},"problemTypes":{"type":"array","description":"This is problem type information (e.g. CWE identifier). Must contain: At least one entry, can be text, OWASP, CWE, please note that while only one is required you can use more than one (or indeed all three) as long as they are correct). (CNA requirement: [PROBLEMTYPE]).","items":{"type":"object","required":["descriptions"],"properties":{"descriptions":{"type":"array","items":{"type":"object","required":["lang","description"],"properties":{"lang":{"$ref":"#/definitions/language"},"description":{"type":"string","description":"Text description of problemType, or title from CWE or OWASP.","minLength":1,"maxLength":4096},"cweId":{"type":"string","description":"CWE ID of the CWE that best describes this problemType entry.","minLength":5,"maxLength":9,"pattern":"^CWE-[1-9][0-9]*$"},"type":{"type":"string","description":"Problemtype source, text, OWASP, CWE, etc.,","minLength":1,"maxLength":128},"references":{"$ref":"#/definitions/references"}},"additionalProperties":false},"minItems":1,"uniqueItems":true}},"additionalProperties":false},"minItems":1,"uniqueItems":true},"references":{"type":"array","description":"This is reference data in the form of URLs or file objects (uuencoded and embedded within the JSON file, exact format to be decided, e.g. we may require a compressed format so the objects require unpacking before they are \"dangerous\").","items":{"$ref":"#/definitions/reference"},"minItems":1,"maxItems":512,"uniqueItems":true},"impacts":{"type":"array","description":"Collection of impacts of this vulnerability.","minItems":1,"uniqueItems":true,"items":{"type":"object","description":"This is impact type information (e.g. a text description.","required":["descriptions"],"properties":{"capecId":{"type":"string","description":"CAPEC ID that best relates to this impact.","minLength":7,"maxLength":11,"pattern":"^CAPEC-[1-9][0-9]{0,4}$"},"descriptions":{"description":"Prose description of the impact scenario. At a minimum provide the description given by CAPEC.","$ref":"#/definitions/descriptions"}},"additionalProperties":false}},"metrics":{"type":"array","description":"Collection of impact scores with attribution.","minItems":1,"uniqueItems":true,"items":{"type":"object","description":"This is impact type information (e.g. a text description, CVSSv2, CVSSv3, CVSSV4, etc.). Must contain: At least one entry, can be text, CVSSv2, CVSSv3, others may be added.","anyOf":[{"required":["cvssV4_0"]},{"required":["cvssV3_1"]},{"required":["cvssV3_0"]},{"required":["cvssV2_0"]},{"required":["other"]}],"properties":{"format":{"type":"string","description":"Name of the scoring format. This provides a bit of future proofing. Additional properties are not prohibited, so this will support the inclusion of proprietary formats. It also provides an easy future conversion mechanism when future score formats become part of the schema. example: cvssV44, format = 'cvssV44', other = cvssV4_4 JSON object. In the future, the other properties can be converted to score properties when they become part of the schema.","minLength":1,"maxLength":64},"scenarios":{"type":"array","description":"Description of the scenarios this metrics object applies to. If no specific scenario is given, GENERAL is used as the default and applies when no more specific metric matches.","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"lang":{"$ref":"#/definitions/language"},"value":{"type":"string","default":"GENERAL","description":"Description of the scenario this metrics object applies to. If no specific scenario is given, GENERAL is used as the default and applies when no more specific metric matches.","minLength":1,"maxLength":4096}},"required":["lang","value"],"additionalProperties":false}},"cvssV4_0":{"$schema":"http://json-schema.org/draft-07/schema#","title":"JSON Schema for Common Vulnerability Scoring System version 4.0","type":"object","definitions":{"attackVectorType":{"type":"string","enum":["NETWORK","ADJACENT","LOCAL","PHYSICAL"]},"modifiedAttackVectorType":{"type":"string","enum":["NETWORK","ADJACENT","LOCAL","PHYSICAL","NOT_DEFINED"],"default":"NOT_DEFINED"},"attackComplexityType":{"type":"string","enum":["HIGH","LOW"]},"modifiedAttackComplexityType":{"type":"string","enum":["HIGH","LOW","NOT_DEFINED"],"default":"NOT_DEFINED"},"attackRequirementsType":{"type":"string","enum":["NONE","PRESENT"]},"modifiedAttackRequirementsType":{"type":"string","enum":["NONE","PRESENT","NOT_DEFINED"],"default":"NOT_DEFINED"},"privilegesRequiredType":{"type":"string","enum":["HIGH","LOW","NONE"]},"modifiedPrivilegesRequiredType":{"type":"string","enum":["HIGH","LOW","NONE","NOT_DEFINED"],"default":"NOT_DEFINED"},"userInteractionType":{"type":"string","enum":["NONE","PASSIVE","ACTIVE"]},"modifiedUserInteractionType":{"type":"string","enum":["NONE","PASSIVE","ACTIVE","NOT_DEFINED"],"default":"NOT_DEFINED"},"vulnCiaType":{"type":"string","enum":["NONE","LOW","HIGH"]},"modifiedVulnCiaType":{"type":"string","enum":["NONE","LOW","HIGH","NOT_DEFINED"],"default":"NOT_DEFINED"},"subCiaType":{"type":"string","enum":["NONE","LOW","HIGH"]},"modifiedSubCType":{"type":"string","enum":["NONE","LOW","HIGH","NOT_DEFINED"],"default":"NOT_DEFINED"},"modifiedSubIaType":{"type":"string","enum":["NONE","LOW","HIGH","SAFETY","NOT_DEFINED"],"default":"NOT_DEFINED"},"exploitMaturityType":{"type":"string","enum":["UNREPORTED","PROOF_OF_CONCEPT","ATTACKED","NOT_DEFINED"],"default":"NOT_DEFINED"},"ciaRequirementType":{"type":"string","enum":["LOW","MEDIUM","HIGH","NOT_DEFINED"],"default":"NOT_DEFINED"},"safetyType":{"type":"string","enum":["NEGLIGIBLE","PRESENT","NOT_DEFINED"],"default":"NOT_DEFINED"},"automatableType":{"type":"string","enum":["NO","YES","NOT_DEFINED"],"default":"NOT_DEFINED"},"recoveryType":{"type":"string","enum":["AUTOMATIC","USER","IRRECOVERABLE","NOT_DEFINED"],"default":"NOT_DEFINED"},"valueDensityType":{"type":"string","enum":["DIFFUSE","CONCENTRATED","NOT_DEFINED"],"default":"NOT_DEFINED"},"vulnerabilityResponseEffortType":{"type":"string","enum":["LOW","MODERATE","HIGH","NOT_DEFINED"],"default":"NOT_DEFINED"},"providerUrgencyType":{"type":"string","enum":["CLEAR","GREEN","AMBER","RED","NOT_DEFINED"],"default":"NOT_DEFINED"},"scoreType":{"type":"number","enum":[0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9,7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9,9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},"noneScoreType":{"type":"number","minimum":0,"maximum":0},"lowScoreType":{"type":"number","enum":[0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9]},"mediumScoreType":{"type":"number","enum":[4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9]},"highScoreType":{"type":"number","enum":[7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9]},"criticalScoreType":{"type":"number","enum":[9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},"severityType":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH","CRITICAL"]},"noneSeverityType":{"const":"NONE"},"lowSeverityType":{"const":"LOW"},"mediumSeverityType":{"const":"MEDIUM"},"highSeverityType":{"const":"HIGH"},"criticalSeverityType":{"const":"CRITICAL"}},"properties":{"version":{"description":"CVSS Version","type":"string","enum":["4.0"]},"vectorString":{"type":"string","pattern":"^CVSS:4[.]0/AV:[NALP]/AC:[LH]/AT:[NP]/PR:[NLH]/UI:[NPA]/VC:[HLN]/VI:[HLN]/VA:[HLN]/SC:[HLN]/SI:[HLN]/SA:[HLN](/E:[XAPU])?(/CR:[XHML])?(/IR:[XHML])?(/AR:[XHML])?(/MAV:[XNALP])?(/MAC:[XLH])?(/MAT:[XNP])?(/MPR:[XNLH])?(/MUI:[XNPA])?(/MVC:[XNLH])?(/MVI:[XNLH])?(/MVA:[XNLH])?(/MSC:[XNLH])?(/MSI:[XNLHS])?(/MSA:[XNLHS])?(/S:[XNP])?(/AU:[XNY])?(/R:[XAUI])?(/V:[XDC])?(/RE:[XLMH])?(/U:(X|Clear|Green|Amber|Red))?$"},"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/scoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/severityType"},"attackVector":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/attackVectorType"},"attackComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/attackComplexityType"},"attackRequirements":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/attackRequirementsType"},"privilegesRequired":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/privilegesRequiredType"},"userInteraction":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/userInteractionType"},"vulnConfidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnCiaType"},"vulnIntegrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnCiaType"},"vulnAvailabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnCiaType"},"subConfidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/subCiaType"},"subIntegrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/subCiaType"},"subAvailabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/subCiaType"},"exploitMaturity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/exploitMaturityType"},"confidentialityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/ciaRequirementType"},"integrityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/ciaRequirementType"},"availabilityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/ciaRequirementType"},"modifiedAttackVector":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedAttackVectorType"},"modifiedAttackComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedAttackComplexityType"},"modifiedAttackRequirements":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedAttackRequirementsType"},"modifiedPrivilegesRequired":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedPrivilegesRequiredType"},"modifiedUserInteraction":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedUserInteractionType"},"modifiedVulnConfidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedVulnCiaType"},"modifiedVulnIntegrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedVulnCiaType"},"modifiedVulnAvailabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedVulnCiaType"},"modifiedSubConfidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedSubCType"},"modifiedSubIntegrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedSubIaType"},"modifiedSubAvailabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/modifiedSubIaType"},"Safety":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/safetyType"},"Automatable":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/automatableType"},"Recovery":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/recoveryType"},"valueDensity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/valueDensityType"},"vulnerabilityResponseEffort":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/vulnerabilityResponseEffortType"},"providerUrgency":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/providerUrgencyType"}},"allOf":[{"anyOf":[{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/highScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/highSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalSeverityType"}}}]},{"anyOf":[{"properties":{"threatScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneScoreType"},"threatSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneSeverityType"}}},{"properties":{"threatScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowScoreType"},"threatSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowSeverityType"}}},{"properties":{"threatScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumScoreType"},"threatSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumSeverityType"}}},{"properties":{"threatScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/highScoreType"},"threatSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/highSeverityType"}}},{"properties":{"threatScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalScoreType"},"threatSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalSeverityType"}}}]},{"anyOf":[{"properties":{"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneScoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/noneSeverityType"}}},{"properties":{"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowScoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/lowSeverityType"}}},{"properties":{"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumScoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/mediumSeverityType"}}},{"properties":{"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/highScoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/highSeverityType"}}},{"properties":{"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalScoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV4_0/definitions/criticalSeverityType"}}}]}],"required":["version","vectorString","baseScore","baseSeverity"],"additionalProperties":false},"cvssV3_1":{"$schema":"http://json-schema.org/draft-07/schema#","title":"JSON Schema for Common Vulnerability Scoring System version 3.1","type":"object","definitions":{"attackVectorType":{"type":"string","enum":["NETWORK","ADJACENT_NETWORK","LOCAL","PHYSICAL"]},"modifiedAttackVectorType":{"type":"string","enum":["NETWORK","ADJACENT_NETWORK","LOCAL","PHYSICAL","NOT_DEFINED"]},"attackComplexityType":{"type":"string","enum":["HIGH","LOW"]},"modifiedAttackComplexityType":{"type":"string","enum":["HIGH","LOW","NOT_DEFINED"]},"privilegesRequiredType":{"type":"string","enum":["HIGH","LOW","NONE"]},"modifiedPrivilegesRequiredType":{"type":"string","enum":["HIGH","LOW","NONE","NOT_DEFINED"]},"userInteractionType":{"type":"string","enum":["NONE","REQUIRED"]},"modifiedUserInteractionType":{"type":"string","enum":["NONE","REQUIRED","NOT_DEFINED"]},"scopeType":{"type":"string","enum":["UNCHANGED","CHANGED"]},"modifiedScopeType":{"type":"string","enum":["UNCHANGED","CHANGED","NOT_DEFINED"]},"ciaType":{"type":"string","enum":["NONE","LOW","HIGH"]},"modifiedCiaType":{"type":"string","enum":["NONE","LOW","HIGH","NOT_DEFINED"]},"exploitCodeMaturityType":{"type":"string","enum":["UNPROVEN","PROOF_OF_CONCEPT","FUNCTIONAL","HIGH","NOT_DEFINED"]},"remediationLevelType":{"type":"string","enum":["OFFICIAL_FIX","TEMPORARY_FIX","WORKAROUND","UNAVAILABLE","NOT_DEFINED"]},"confidenceType":{"type":"string","enum":["UNKNOWN","REASONABLE","CONFIRMED","NOT_DEFINED"]},"ciaRequirementType":{"type":"string","enum":["LOW","MEDIUM","HIGH","NOT_DEFINED"]},"scoreType":{"type":"number","enum":[0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9,7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9,9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},"severityType":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH","CRITICAL"]},"noneScoreType":{"type":"number","minimum":0,"maximum":0},"lowScoreType":{"type":"number","enum":[0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9]},"mediumScoreType":{"type":"number","enum":[4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9]},"highScoreType":{"type":"number","enum":[7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9]},"criticalScoreType":{"type":"number","enum":[9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},"noneSeverityType":{"const":"NONE"},"lowSeverityType":{"const":"LOW"},"mediumSeverityType":{"const":"MEDIUM"},"highSeverityType":{"const":"HIGH"},"criticalSeverityType":{"const":"CRITICAL"}},"properties":{"version":{"description":"CVSS Version","type":"string","enum":["3.1"]},"vectorString":{"type":"string","pattern":"^CVSS:3[.]1/((AV:[NALP]|AC:[LH]|PR:[NLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])/)*(AV:[NALP]|AC:[LH]|PR:[NLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])$"},"attackVector":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/attackVectorType"},"attackComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/attackComplexityType"},"privilegesRequired":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/privilegesRequiredType"},"userInteraction":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/userInteractionType"},"scope":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/scopeType"},"confidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaType"},"integrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaType"},"availabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaType"},"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/scoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/severityType"},"exploitCodeMaturity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/exploitCodeMaturityType"},"remediationLevel":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/remediationLevelType"},"reportConfidence":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/confidenceType"},"temporalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/scoreType"},"temporalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/severityType"},"confidentialityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaRequirementType"},"integrityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaRequirementType"},"availabilityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/ciaRequirementType"},"modifiedAttackVector":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedAttackVectorType"},"modifiedAttackComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedAttackComplexityType"},"modifiedPrivilegesRequired":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedPrivilegesRequiredType"},"modifiedUserInteraction":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedUserInteractionType"},"modifiedScope":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedScopeType"},"modifiedConfidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedCiaType"},"modifiedIntegrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedCiaType"},"modifiedAvailabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/modifiedCiaType"},"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/scoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/severityType"}},"anyOf":[{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/noneScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/noneSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/lowScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/lowSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/mediumScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/mediumSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/highScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/highSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/criticalScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_1/definitions/criticalSeverityType"}}}],"required":["version","vectorString","baseScore","baseSeverity"],"additionalProperties":false},"cvssV3_0":{"$schema":"http://json-schema.org/draft-07/schema#","title":"JSON Schema for Common Vulnerability Scoring System version 3.0","type":"object","definitions":{"attackVectorType":{"type":"string","enum":["NETWORK","ADJACENT_NETWORK","LOCAL","PHYSICAL"]},"modifiedAttackVectorType":{"type":"string","enum":["NETWORK","ADJACENT_NETWORK","LOCAL","PHYSICAL","NOT_DEFINED"]},"attackComplexityType":{"type":"string","enum":["HIGH","LOW"]},"modifiedAttackComplexityType":{"type":"string","enum":["HIGH","LOW","NOT_DEFINED"]},"privilegesRequiredType":{"type":"string","enum":["HIGH","LOW","NONE"]},"modifiedPrivilegesRequiredType":{"type":"string","enum":["HIGH","LOW","NONE","NOT_DEFINED"]},"userInteractionType":{"type":"string","enum":["NONE","REQUIRED"]},"modifiedUserInteractionType":{"type":"string","enum":["NONE","REQUIRED","NOT_DEFINED"]},"scopeType":{"type":"string","enum":["UNCHANGED","CHANGED"]},"modifiedScopeType":{"type":"string","enum":["UNCHANGED","CHANGED","NOT_DEFINED"]},"ciaType":{"type":"string","enum":["NONE","LOW","HIGH"]},"modifiedCiaType":{"type":"string","enum":["NONE","LOW","HIGH","NOT_DEFINED"]},"exploitCodeMaturityType":{"type":"string","enum":["UNPROVEN","PROOF_OF_CONCEPT","FUNCTIONAL","HIGH","NOT_DEFINED"]},"remediationLevelType":{"type":"string","enum":["OFFICIAL_FIX","TEMPORARY_FIX","WORKAROUND","UNAVAILABLE","NOT_DEFINED"]},"confidenceType":{"type":"string","enum":["UNKNOWN","REASONABLE","CONFIRMED","NOT_DEFINED"]},"ciaRequirementType":{"type":"string","enum":["LOW","MEDIUM","HIGH","NOT_DEFINED"]},"scoreType":{"type":"number","enum":[0,0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9,7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9,9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},"noneScoreType":{"type":"number","minimum":0,"maximum":0},"lowScoreType":{"type":"number","enum":[0.1,0.2,0.3,0.4,0.5,0.6,0.7,0.8,0.9,1,1.1,1.2,1.3,1.4,1.5,1.6,1.7,1.8,1.9,2,2.1,2.2,2.3,2.4,2.5,2.6,2.7,2.8,2.9,3,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9]},"mediumScoreType":{"type":"number","enum":[4,4.1,4.2,4.3,4.4,4.5,4.6,4.7,4.8,4.9,5,5.1,5.2,5.3,5.4,5.5,5.6,5.7,5.8,5.9,6,6.1,6.2,6.3,6.4,6.5,6.6,6.7,6.8,6.9]},"highScoreType":{"type":"number","enum":[7,7.1,7.2,7.3,7.4,7.5,7.6,7.7,7.8,7.9,8,8.1,8.2,8.3,8.4,8.5,8.6,8.7,8.8,8.9]},"criticalScoreType":{"type":"number","enum":[9,9.1,9.2,9.3,9.4,9.5,9.6,9.7,9.8,9.9,10]},"severityType":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH","CRITICAL"]},"noneSeverityType":{"const":"NONE"},"lowSeverityType":{"const":"LOW"},"mediumSeverityType":{"const":"MEDIUM"},"highSeverityType":{"const":"HIGH"},"criticalSeverityType":{"const":"CRITICAL"}},"properties":{"version":{"description":"CVSS Version","type":"string","enum":["3.0"]},"vectorString":{"type":"string","pattern":"^CVSS:3[.]0/((AV:[NALP]|AC:[LH]|PR:[UNLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XUNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])/)*(AV:[NALP]|AC:[LH]|PR:[UNLH]|UI:[NR]|S:[UC]|[CIA]:[NLH]|E:[XUPFH]|RL:[XOTWU]|RC:[XURC]|[CIA]R:[XLMH]|MAV:[XNALP]|MAC:[XLH]|MPR:[XUNLH]|MUI:[XNR]|MS:[XUC]|M[CIA]:[XNLH])$"},"attackVector":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/attackVectorType"},"attackComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/attackComplexityType"},"privilegesRequired":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/privilegesRequiredType"},"userInteraction":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/userInteractionType"},"scope":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/scopeType"},"confidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaType"},"integrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaType"},"availabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaType"},"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/scoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/severityType"},"exploitCodeMaturity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/exploitCodeMaturityType"},"remediationLevel":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/remediationLevelType"},"reportConfidence":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/confidenceType"},"temporalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/scoreType"},"temporalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/severityType"},"confidentialityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaRequirementType"},"integrityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaRequirementType"},"availabilityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/ciaRequirementType"},"modifiedAttackVector":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedAttackVectorType"},"modifiedAttackComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedAttackComplexityType"},"modifiedPrivilegesRequired":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedPrivilegesRequiredType"},"modifiedUserInteraction":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedUserInteractionType"},"modifiedScope":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedScopeType"},"modifiedConfidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedCiaType"},"modifiedIntegrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedCiaType"},"modifiedAvailabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/modifiedCiaType"},"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/scoreType"},"environmentalSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/severityType"}},"anyOf":[{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/noneScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/noneSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/lowScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/lowSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/mediumScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/mediumSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/highScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/highSeverityType"}}},{"properties":{"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/criticalScoreType"},"baseSeverity":{"$ref":"#/definitions/metrics/items/properties/cvssV3_0/definitions/criticalSeverityType"}}}],"required":["version","vectorString","baseScore","baseSeverity"],"additionalProperties":false},"cvssV2_0":{"$schema":"http://json-schema.org/draft-04/schema#","title":"JSON Schema for Common Vulnerability Scoring System version 2.0","type":"object","definitions":{"accessVectorType":{"type":"string","enum":["NETWORK","ADJACENT_NETWORK","LOCAL"]},"accessComplexityType":{"type":"string","enum":["HIGH","MEDIUM","LOW"]},"authenticationType":{"type":"string","enum":["MULTIPLE","SINGLE","NONE"]},"ciaType":{"type":"string","enum":["NONE","PARTIAL","COMPLETE"]},"exploitabilityType":{"type":"string","enum":["UNPROVEN","PROOF_OF_CONCEPT","FUNCTIONAL","HIGH","NOT_DEFINED"]},"remediationLevelType":{"type":"string","enum":["OFFICIAL_FIX","TEMPORARY_FIX","WORKAROUND","UNAVAILABLE","NOT_DEFINED"]},"reportConfidenceType":{"type":"string","enum":["UNCONFIRMED","UNCORROBORATED","CONFIRMED","NOT_DEFINED"]},"collateralDamagePotentialType":{"type":"string","enum":["NONE","LOW","LOW_MEDIUM","MEDIUM_HIGH","HIGH","NOT_DEFINED"]},"targetDistributionType":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH","NOT_DEFINED"]},"ciaRequirementType":{"type":"string","enum":["LOW","MEDIUM","HIGH","NOT_DEFINED"]},"scoreType":{"type":"number","minimum":0,"maximum":10}},"properties":{"version":{"description":"CVSS Version","type":"string","enum":["2.0"]},"vectorString":{"type":"string","pattern":"^((AV:[NAL]|AC:[LMH]|Au:[MSN]|[CIA]:[NPC]|E:(U|POC|F|H|ND)|RL:(OF|TF|W|U|ND)|RC:(UC|UR|C|ND)|CDP:(N|L|LM|MH|H|ND)|TD:(N|L|M|H|ND)|[CIA]R:(L|M|H|ND))/)*(AV:[NAL]|AC:[LMH]|Au:[MSN]|[CIA]:[NPC]|E:(U|POC|F|H|ND)|RL:(OF|TF|W|U|ND)|RC:(UC|UR|C|ND)|CDP:(N|L|LM|MH|H|ND)|TD:(N|L|M|H|ND)|[CIA]R:(L|M|H|ND))$"},"accessVector":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/accessVectorType"},"accessComplexity":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/accessComplexityType"},"authentication":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/authenticationType"},"confidentialityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaType"},"integrityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaType"},"availabilityImpact":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaType"},"baseScore":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/scoreType"},"exploitability":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/exploitabilityType"},"remediationLevel":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/remediationLevelType"},"reportConfidence":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/reportConfidenceType"},"temporalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/scoreType"},"collateralDamagePotential":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/collateralDamagePotentialType"},"targetDistribution":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/targetDistributionType"},"confidentialityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaRequirementType"},"integrityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaRequirementType"},"availabilityRequirement":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/ciaRequirementType"},"environmentalScore":{"$ref":"#/definitions/metrics/items/properties/cvssV2_0/definitions/scoreType"}},"required":["version","vectorString","baseScore"],"additionalProperties":false},"other":{"type":"object","description":"A non-standard impact description, may be prose or JSON block.","required":["type","content"],"properties":{"type":{"description":"Name of the non-standard impact metrics format used.","type":"string","minLength":1,"maxLength":128},"content":{"type":"object","$comment":"additionalProperties are allowed here, since this construct supports arbitrary JSON.","description":"JSON object not covered by another metrics format.","minProperties":1}},"additionalProperties":false}},"additionalProperties":false}},"configurations":{"type":"array","description":"Configurations required for exploiting this vulnerability.","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/description"}},"workarounds":{"type":"array","description":"Workarounds and mitigations for this vulnerability.","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/description"}},"solutions":{"type":"array","description":"Information about solutions or remediations available for this vulnerability.","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/description"}},"exploits":{"type":"array","description":"Information about exploits of the vulnerability.","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/description"}},"timeline":{"type":"array","description":"This is timeline information for significant events about this vulnerability or changes to the CVE Record.","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["time","lang","value"],"properties":{"time":{"description":"Timestamp representing when the event in the timeline occurred. The timestamp format is based on RFC3339 and ISO ISO8601, with an optional timezone. yyyy-MM-ddTHH:mm:ss[+-]ZH:ZM - if the timezone offset is not given, GMT (+00:00) is assumed.","$ref":"#/definitions/timestamp"},"lang":{"description":"The language used in the description of the event. The language field is included so that CVE Records can support translations. The value must be a BCP 47 language code.","$ref":"#/definitions/language"},"value":{"description":"A summary of the event.","type":"string","minLength":1,"maxLength":4096}},"additionalProperties":false}},"credits":{"type":"array","description":"Statements acknowledging specific people, organizations, or tools recognizing the work done in researching, discovering, remediating or helping with activities related to this CVE.","minItems":1,"uniqueItems":true,"items":{"type":"object","properties":{"lang":{"description":"The language used when describing the credits. The language field is included so that CVE Records can support translations. The value must be a BCP 47 language code.","$ref":"#/definitions/language"},"value":{"type":"string","minLength":1,"maxLength":4096},"user":{"description":"UUID of the user being credited if present in the CVE User Registry (optional). This UUID can be used to lookup the user record in the user registry service.","$ref":"#/definitions/uuidType"},"type":{"type":"string","description":"Type or role of the entity being credited (optional). finder: identifies the vulnerability.\nreporter: notifies the vendor of the vulnerability to a CNA.\nanalyst: validates the vulnerability to ensure accuracy or severity.\ncoordinator: facilitates the coordinated response process.\nremediation developer: prepares a code change or other remediation plans.\nremediation reviewer: reviews vulnerability remediation plans or code changes for effectiveness and completeness.\nremediation verifier: tests and verifies the vulnerability or its remediation.\ntool: names of tools used in vulnerability discovery or identification.\nsponsor: supports the vulnerability identification or remediation activities.","default":"finder","enum":["finder","reporter","analyst","coordinator","remediation developer","remediation reviewer","remediation verifier","tool","sponsor","other"]}},"additionalProperties":false,"required":["lang","value"]}},"source":{"type":"object","description":"This is the source information (who discovered it, who researched it, etc.) and optionally a chain of CNA information (e.g. the originating CNA and subsequent parent CNAs who have processed it before it arrives at the MITRE root).\n Must contain: IF this is in the root level it MUST contain a CNA_chain entry, IF this source entry is NOT in the root (e.g. it is part of a vendor statement) then it must contain at least one type of data entry.","minProperties":1},"language":{"type":"string","description":"BCP 47 language code, language-region.","default":"en","pattern":"^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$"},"englishLanguage":{"type":"string","description":"BCP 47 language code, language-region, required to be English.","pattern":"^en([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$"},"taxonomyMappings":{"type":"array","description":"List of taxonomy items related to the vulnerability.","minItems":1,"uniqueItems":true,"items":{"type":"object","description":"A taxonomy mapping object identifies the taxonomy by a name and version (eg., ATT&CK v13.1, CVSS 3.1, CWE 4.12) along with a list of relations relevant to this CVE.","required":["taxonomyName","taxonomyRelations"],"properties":{"taxonomyName":{"type":"string","description":"The name of the taxonomy, eg., ATT&CK, D3FEND, CWE, CVSS","minLength":1,"maxLength":128},"taxonomyVersion":{"type":"string","description":"The version of taxonomy the identifiers come from.","minLength":1,"maxLength":128},"taxonomyRelations":{"type":"array","description":"List of relationships to the taxonomy for the vulnerability.","minItems":1,"uniqueItems":true,"items":{"type":"object","description":"A relationship between the taxonomy and the CVE or two taxonomy items.","required":["taxonomyId","relationshipName","relationshipValue"],"properties":{"taxonomyId":{"type":"string","description":"Identifier of the item in the taxonomy. Used as the subject of the relationship.","minLength":1,"maxLength":2048},"relationshipName":{"type":"string","description":"A description of the relationship.","minLength":1,"maxLength":128},"relationshipValue":{"type":"string","description":"The target of the relationship. Can be the CVE ID or another taxonomy identifier.","minLength":1,"maxLength":2048}},"additionalProperties":false}}},"additionalProperties":false}},"tagExtension":{"type":"string","minLength":2,"maxLength":128,"pattern":"^x_.*$","$comment":"These values are not used as JSON property names, so there is not a need to work-around property naming limitations in some common implementations."},"cnaTags":{"type":"array","description":"Tags provided by a CNA describing the CVE Record.","uniqueItems":true,"minItems":1,"items":{"oneOf":[{"$ref":"#/definitions/tagExtension"},{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://cve.mitre.org/cve/v5_00/tags/cna/","type":"string","description":"exclusively-hosted-service: All known software and/or hardware affected by this CVE Record is known to exist only in the affected hosted service. If the vulnerability affects both hosted and on-prem software and/or hardware, then the tag should not be used.\n\nunsupported-when-assigned: Used by the assigning CNA to indicate that when a request for a CVE assignment was received, the product was already end-of-life (EOL) or a product or specific version was deemed not to be supported by the vendor. This tag should only be applied to a CVE Record when all affected products or version lines referenced in the CVE-Record are EOL.\n\ndisputed: When one party disagrees with another party's assertion that a particular issue in software is a vulnerability, a CVE Record assigned to that issue may be tagged as being 'disputed'.","enum":["unsupported-when-assigned","exclusively-hosted-service","disputed"]}]}},"adpTags":{"type":"array","description":"Tags provided by an ADP describing the CVE Record.","uniqueItems":true,"minItems":1,"items":{"oneOf":[{"$ref":"#/definitions/tagExtension"},{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://cve.mitre.org/cve/v5_00/tags/adp/","type":"string","description":"disputed: When one party disagrees with another party's assertion that a particular issue in software is a vulnerability, a CVE Record assigned to that issue may be tagged as being 'disputed'.","enum":["disputed"]}]}}},"oneOf":[{"title":"Published","description":"When a CNA populates the data associated with a CVE ID as a CVE Record, the state of the CVE Record is Published.","type":"object","properties":{"dataType":{"$ref":"#/definitions/dataType"},"dataVersion":{"$ref":"#/definitions/dataVersion"},"cveMetadata":{"$ref":"#/definitions/cveMetadataPublished"},"containers":{"description":"A set of structures (called containers) used to store vulnerability information related to a specific CVE ID provided by a specific organization participating in the CVE program. Each container includes information provided by a different source.\n\nAt a minimum, a 'cna' container containing the vulnerability information provided by the CNA who initially assigned the CVE ID must be included.\n\nThere can only be one 'cna' container, as there can only be one assigning CNA. However, there can be multiple 'adp' containers, allowing multiple organizations participating in the CVE program to add additional information related to the vulnerability. For the most part, the 'cna' and 'adp' containers contain the same properties. The main differences are the source of the information. The 'cna' container requires the CNA to include certain fields, while the 'adp' container does not.","type":"object","properties":{"cna":{"$ref":"#/definitions/cnaPublishedContainer"},"adp":{"type":"array","items":{"$ref":"#/definitions/adpContainer"},"minItems":1,"uniqueItems":true}},"required":["cna"],"additionalProperties":false}},"required":["dataType","dataVersion","cveMetadata","containers"],"additionalProperties":false},{"title":"Rejected","description":"If the CVE ID and associated CVE Record should no longer be used, the CVE Record is placed in the Rejected state. A Rejected CVE Record remains on the CVE List so that users can know when it is invalid.","type":"object","properties":{"dataType":{"$ref":"#/definitions/dataType"},"dataVersion":{"$ref":"#/definitions/dataVersion"},"cveMetadata":{"$ref":"#/definitions/cveMetadataRejected"},"containers":{"description":"A set of structures (called containers) used to store vulnerability information related to a specific CVE ID provided by a specific organization participating in the CVE program. Each container includes information provided by a different source.\n\nAt minimum, a 'cna' container containing the vulnerability information provided by the CNA who initially assigned the CVE ID must be included.\n\nThere can only be one 'cna' container, as there can only be one assigning CNA.","type":"object","properties":{"cna":{"$ref":"#/definitions/cnaRejectedContainer"}},"required":["cna"],"additionalProperties":false}},"required":["dataType","dataVersion","cveMetadata","containers"],"additionalProperties":false}]}
|
Provide a JSON object that satisfies the schema "CVE JSON record format". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
CVE JSON record format
|
schema-store
|
schema_store_14
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://geojson.org/schema/GeoJSON.json\",\"title\":\"GeoJSON\",\"oneOf\":[{\"title\":\"GeoJSON Point\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Point\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON LineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"LineString\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Polygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Polygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPoint\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPoint\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiLineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiLineString\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPolygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPolygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON GeometryCollection\",\"type\":\"object\",\"required\":[\"type\",\"geometries\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"GeometryCollection\"]},\"geometries\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"title\":\"GeoJSON Point\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Point\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON LineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"LineString\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Polygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Polygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPoint\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPoint\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiLineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiLineString\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPolygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPolygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}]}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Feature\",\"type\":\"object\",\"required\":[\"type\",\"properties\",\"geometry\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Feature\"]},\"id\":{\"oneOf\":[{\"type\":\"number\"},{\"type\":\"string\"}]},\"properties\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"object\"}]},\"geometry\":{\"oneOf\":[{\"type\":\"null\"},{\"title\":\"GeoJSON Point\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Point\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON LineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"LineString\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Polygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Polygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPoint\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPoint\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiLineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiLineString\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPolygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPolygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON GeometryCollection\",\"type\":\"object\",\"required\":[\"type\",\"geometries\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"GeometryCollection\"]},\"geometries\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"title\":\"GeoJSON Point\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Point\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON LineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"LineString\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Polygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Polygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPoint\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPoint\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiLineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiLineString\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPolygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPolygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}]}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}]},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON FeatureCollection\",\"type\":\"object\",\"required\":[\"type\",\"features\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"FeatureCollection\"]},\"features\":{\"type\":\"array\",\"items\":{\"title\":\"GeoJSON Feature\",\"type\":\"object\",\"required\":[\"type\",\"properties\",\"geometry\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Feature\"]},\"id\":{\"oneOf\":[{\"type\":\"number\"},{\"type\":\"string\"}]},\"properties\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"object\"}]},\"geometry\":{\"oneOf\":[{\"type\":\"null\"},{\"title\":\"GeoJSON Point\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Point\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON LineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"LineString\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Polygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Polygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPoint\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPoint\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiLineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiLineString\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPolygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPolygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON GeometryCollection\",\"type\":\"object\",\"required\":[\"type\",\"geometries\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"GeometryCollection\"]},\"geometries\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"title\":\"GeoJSON Point\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Point\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON LineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"LineString\"]},\"coordinates\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON Polygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"Polygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPoint\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPoint\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiLineString\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiLineString\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}},{\"title\":\"GeoJSON MultiPolygon\",\"type\":\"object\",\"required\":[\"type\",\"coordinates\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"MultiPolygon\"]},\"coordinates\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"array\",\"minItems\":2,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}]}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}]},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}},\"bbox\":{\"type\":\"array\",\"minItems\":4,\"items\":{\"type\":\"number\"}}}}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"GeoJSON\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://geojson.org/schema/GeoJSON.json","title":"GeoJSON","oneOf":[{"title":"GeoJSON Point","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"number"}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON LineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Polygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPoint","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiLineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPolygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON GeometryCollection","type":"object","required":["type","geometries"],"properties":{"type":{"type":"string","enum":["GeometryCollection"]},"geometries":{"type":"array","items":{"oneOf":[{"title":"GeoJSON Point","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"number"}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON LineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Polygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPoint","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiLineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPolygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}]}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Feature","type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","enum":["Feature"]},"id":{"oneOf":[{"type":"number"},{"type":"string"}]},"properties":{"oneOf":[{"type":"null"},{"type":"object"}]},"geometry":{"oneOf":[{"type":"null"},{"title":"GeoJSON Point","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"number"}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON LineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Polygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPoint","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiLineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPolygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON GeometryCollection","type":"object","required":["type","geometries"],"properties":{"type":{"type":"string","enum":["GeometryCollection"]},"geometries":{"type":"array","items":{"oneOf":[{"title":"GeoJSON Point","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"number"}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON LineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Polygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPoint","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiLineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPolygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}]}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}]},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON FeatureCollection","type":"object","required":["type","features"],"properties":{"type":{"type":"string","enum":["FeatureCollection"]},"features":{"type":"array","items":{"title":"GeoJSON Feature","type":"object","required":["type","properties","geometry"],"properties":{"type":{"type":"string","enum":["Feature"]},"id":{"oneOf":[{"type":"number"},{"type":"string"}]},"properties":{"oneOf":[{"type":"null"},{"type":"object"}]},"geometry":{"oneOf":[{"type":"null"},{"title":"GeoJSON Point","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"number"}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON LineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Polygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPoint","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiLineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPolygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON GeometryCollection","type":"object","required":["type","geometries"],"properties":{"type":{"type":"string","enum":["GeometryCollection"]},"geometries":{"type":"array","items":{"oneOf":[{"title":"GeoJSON Point","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Point"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"number"}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON LineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["LineString"]},"coordinates":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON Polygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPoint","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPoint"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"number"}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiLineString","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiLineString"]},"coordinates":{"type":"array","items":{"type":"array","minItems":2,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}},{"title":"GeoJSON MultiPolygon","type":"object","required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}]}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}]},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}},"bbox":{"type":"array","minItems":4,"items":{"type":"number"}}}}]}
|
Provide a JSON object that satisfies the schema "GeoJSON". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
GeoJSON
|
schema-store
|
schema_store_15
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://gitversion.net/schemas/6.0/GitVersion.configuration.json\",\"title\":\"GitVersion Configuration (6.0)\",\"description\":\"GitVersion configuration schema (6.0)\",\"type\":\"object\",\"properties\":{\"assembly-file-versioning-format\":{\"description\":\"Specifies the format of AssemblyFileVersion and overwrites the value of assembly-file-versioning-scheme.\",\"type\":\"string\"},\"assembly-file-versioning-scheme\":{\"description\":\"The scheme to use when setting AssemblyFileVersion attribute. Can be 'MajorMinorPatchTag', 'MajorMinorPatch', 'MajorMinor', 'Major', 'None'. Defaults to 'MajorMinorPatch'.\",\"default\":\"MajorMinorPatch\",\"enum\":[\"MajorMinorPatchTag\",\"MajorMinorPatch\",\"MajorMinor\",\"Major\",\"None\"]},\"assembly-informational-format\":{\"description\":\"Specifies the format of AssemblyInformationalVersion. Defaults to '{InformationalVersion}'.\",\"default\":\"'{InformationalVersion}'\",\"type\":\"string\"},\"assembly-versioning-format\":{\"description\":\"Specifies the format of AssemblyVersion and overwrites the value of assembly-versioning-scheme.\",\"type\":\"string\"},\"assembly-versioning-scheme\":{\"description\":\"The scheme to use when setting AssemblyVersion attribute. Can be 'MajorMinorPatchTag', 'MajorMinorPatch', 'MajorMinor', 'Major', 'None'. Defaults to 'MajorMinorPatch'.\",\"default\":\"MajorMinorPatch\",\"enum\":[\"MajorMinorPatchTag\",\"MajorMinorPatch\",\"MajorMinor\",\"Major\",\"None\"]},\"branches\":{\"description\":\"The header for all the individual branch configuration.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/branchConfiguration\"}},\"commit-date-format\":{\"description\":\"The format to use when calculating the commit date. Defaults to 'yyyy-MM-dd'. See [Standard Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [Custom Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings).\",\"default\":\"yyyy-MM-dd\",\"type\":\"string\"},\"commit-message-incrementing\":{\"$ref\":\"#/$defs/nullableOfCommitMessageIncrementMode\"},\"mode\":{\"$ref\":\"#/$defs/nullableOfDeploymentMode\"},\"ignore\":{\"description\":\"The header property for the ignore configuration.\",\"type\":\"object\",\"properties\":{\"commits-before\":{\"$ref\":\"#/$defs/string3\"},\"sha\":{\"$ref\":\"#/$defs/hashSetOfString2\"}}},\"increment\":{\"$ref\":\"#/$defs/incrementStrategy\"},\"is-main-branch\":{\"$ref\":\"#/$defs/nullableOfBoolean\"},\"is-release-branch\":{\"$ref\":\"#/$defs/nullableOfBoolean1\"},\"is-source-branch-for\":{\"$ref\":\"#/$defs/hashSetOfString\"},\"label\":{\"$ref\":\"#/$defs/string\"},\"label-number-pattern\":{\"$ref\":\"#/$defs/string1\"},\"major-version-bump-message\":{\"format\":\"regex\",\"description\":\"The regular expression to match commit messages with to perform a major version increment. Defaults to '\\\\+semver:\\\\s?(breaking|major)'\",\"default\":\"\\\\+semver:\\\\s?(breaking|major)\",\"type\":\"string\"},\"merge-message-formats\":{\"description\":\"Custom merge message formats to enable identification of merge messages that do not follow the built-in conventions.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"minor-version-bump-message\":{\"format\":\"regex\",\"description\":\"The regular expression to match commit messages with to perform a minor version increment. Defaults to '\\\\+semver:\\\\s?(feature|minor)'\",\"default\":\"\\\\+semver:\\\\s?(feature|minor)\",\"type\":\"string\"},\"next-version\":{\"description\":\"Allows you to bump the next version explicitly. Useful for bumping main or a feature branch with breaking changes\",\"type\":\"string\"},\"no-bump-message\":{\"format\":\"regex\",\"description\":\"Used to tell GitVersion not to increment when in Mainline development mode. Defaults to '\\\\+semver:\\\\s?(none|skip)'\",\"default\":\"\\\\+semver:\\\\s?(none|skip)\",\"type\":\"string\"},\"patch-version-bump-message\":{\"format\":\"regex\",\"description\":\"The regular expression to match commit messages with to perform a patch version increment. Defaults to '\\\\+semver:\\\\s?(fix|patch)'\",\"default\":\"\\\\+semver:\\\\s?(fix|patch)\",\"type\":\"string\"},\"pre-release-weight\":{\"$ref\":\"#/$defs/nullableOfInt32\"},\"prevent-increment\":{\"$ref\":\"#/$defs/preventIncrementConfiguration\"},\"regex\":{\"$ref\":\"#/$defs/string2\"},\"semantic-version-format\":{\"description\":\"Specifies the semantic version format that is used when parsing the string. Can be 'Strict' or 'Loose'. Defaults to 'Strict'.\",\"default\":\"Strict\",\"enum\":[\"Strict\",\"Loose\"]},\"source-branches\":{\"$ref\":\"#/$defs/hashSetOfString1\"},\"tag-prefix\":{\"format\":\"regex\",\"description\":\"A regular expression which is used to trim Git tags before processing. Defaults to '[vV]?'\",\"default\":\"[vV]?\",\"type\":\"string\"},\"tag-pre-release-weight\":{\"description\":\"The pre-release weight in case of tagged commits. Defaults to 60000.\",\"type\":[\"integer\",\"null\"]},\"track-merge-message\":{\"$ref\":\"#/$defs/nullableOfBoolean4\"},\"track-merge-target\":{\"$ref\":\"#/$defs/nullableOfBoolean5\"},\"tracks-release-branches\":{\"$ref\":\"#/$defs/nullableOfBoolean6\"},\"update-build-number\":{\"description\":\"Whether to update the build number in the project file. Defaults to true.\",\"default\":\"true\",\"type\":\"boolean\"},\"version-in-branch-pattern\":{\"format\":\"regex\",\"description\":\"A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). Defaults to '(?<version>[vV]?\\\\d+(\\\\.\\\\d+)?(\\\\.\\\\d+)?).*'.\",\"default\":\"(?<version>[vV]?\\\\d+(\\\\.\\\\d+)?(\\\\.\\\\d+)?).*\",\"type\":\"string\"},\"strategies\":{\"description\":\"Specifies which version strategies (one or more) will be used to determine the next version. Following values are available: 'ConfiguredNextVersion', 'MergeMessage', 'TaggedCommit', 'TrackReleaseBranches', 'VersionInBranchName' and 'Mainline'.\",\"type\":\"array\",\"items\":{\"description\":\"Specifies which version strategies (one or more) will be used to determine the next version. Following values are available: 'ConfiguredNextVersion', 'MergeMessage', 'TaggedCommit', 'TrackReleaseBranches', 'VersionInBranchName' and 'Mainline'.\",\"enum\":[\"None\",\"Fallback\",\"ConfiguredNextVersion\",\"MergeMessage\",\"TaggedCommit\",\"TrackReleaseBranches\",\"VersionInBranchName\",\"Mainline\"]}},\"workflow\":{\"description\":\"The base template of the configuration to use. Possible values are: 'GitFlow/v1' or 'GitHubFlow/v1'\",\"type\":\"string\"}},\"$defs\":{\"branchConfiguration\":{\"type\":\"object\",\"properties\":{\"commit-message-incrementing\":{\"$ref\":\"#/$defs/nullableOfCommitMessageIncrementMode\"},\"mode\":{\"$ref\":\"#/$defs/nullableOfDeploymentMode\"},\"increment\":{\"$ref\":\"#/$defs/incrementStrategy\"},\"is-main-branch\":{\"$ref\":\"#/$defs/nullableOfBoolean\"},\"is-release-branch\":{\"$ref\":\"#/$defs/nullableOfBoolean1\"},\"is-source-branch-for\":{\"$ref\":\"#/$defs/hashSetOfString\"},\"label\":{\"$ref\":\"#/$defs/string\"},\"label-number-pattern\":{\"$ref\":\"#/$defs/string1\"},\"pre-release-weight\":{\"$ref\":\"#/$defs/nullableOfInt32\"},\"prevent-increment\":{\"$ref\":\"#/$defs/preventIncrementConfiguration\"},\"regex\":{\"$ref\":\"#/$defs/string2\"},\"source-branches\":{\"$ref\":\"#/$defs/hashSetOfString1\"},\"track-merge-message\":{\"$ref\":\"#/$defs/nullableOfBoolean4\"},\"track-merge-target\":{\"$ref\":\"#/$defs/nullableOfBoolean5\"},\"tracks-release-branches\":{\"$ref\":\"#/$defs/nullableOfBoolean6\"}}},\"nullableOfCommitMessageIncrementMode\":{\"description\":\"Sets whether it should be possible to increment the version with special syntax in the commit message. Can be 'Disabled', 'Enabled' or 'MergeMessageOnly'.\",\"enum\":[\"Enabled\",\"Disabled\",\"MergeMessageOnly\"]},\"nullableOfDeploymentMode\":{\"description\":\"The deployment mode for this branch. Can be 'ManualDeployment', 'ContinuousDelivery', 'ContinuousDeployment'.\",\"enum\":[\"ManualDeployment\",\"ContinuousDelivery\",\"ContinuousDeployment\"]},\"incrementStrategy\":{\"description\":\"The increment strategy for this branch. Can be 'Inherit', 'Patch', 'Minor', 'Major', 'None'.\",\"enum\":[\"None\",\"Major\",\"Minor\",\"Patch\",\"Inherit\"]},\"nullableOfBoolean\":{\"description\":\"When using Mainline mode, this indicates that this branch is a mainline. By default main and support/* are mainlines.\",\"type\":[\"boolean\",\"null\"]},\"nullableOfBoolean1\":{\"description\":\"Indicates this branch configuration represents a release branch in GitFlow.\",\"type\":[\"boolean\",\"null\"]},\"hashSetOfString\":{\"description\":\"The branches that this branch is a source branch.\",\"type\":\"array\",\"items\":{\"description\":\"The branches that this branch is a source branch.\",\"type\":\"string\"}},\"string\":{\"description\":\"The label to use for this branch. Use the value {BranchName} or similar as a placeholder to insert a named capture group from RegularExpression (fx. the branch name).\",\"type\":\"string\"},\"string1\":{\"format\":\"regex\",\"description\":\"The regular expression pattern to use to extract the number from the branch name. Defaults to '[/-](?<number>\\\\d+)'.\",\"default\":\"[/-](?<number>\\\\d+)\",\"type\":\"string\"},\"nullableOfInt32\":{\"description\":\"Provides a way to translate the PreReleaseLabel to a number.\",\"type\":[\"integer\",\"null\"]},\"preventIncrementConfiguration\":{\"description\":\"The prevent increment configuration section.\",\"type\":\"object\",\"properties\":{\"of-merged-branch\":{\"$ref\":\"#/$defs/nullableOfBoolean2\"},\"when-branch-merged\":{\"$ref\":\"#/$defs/nullableOfBoolean2\"},\"when-current-commit-tagged\":{\"$ref\":\"#/$defs/nullableOfBoolean3\"}}},\"nullableOfBoolean2\":{\"description\":\"Prevent increment when branch merged.\",\"type\":[\"boolean\",\"null\"]},\"nullableOfBoolean3\":{\"description\":\"This branch related property controls the behavior whether to use the tagged (value set to true) or the incremented (value set to false) semantic version. Defaults to true.\",\"type\":[\"boolean\",\"null\"]},\"string2\":{\"format\":\"regex\",\"description\":\"The regular expression pattern to use to match this branch.\",\"type\":\"string\"},\"hashSetOfString1\":{\"description\":\"The source branches for this branch.\",\"type\":\"array\",\"items\":{\"description\":\"The source branches for this branch.\",\"type\":\"string\"}},\"nullableOfBoolean4\":{\"description\":\"This property is a branch related property and gives the user the possibility to control the behavior of whether the merge commit message will be interpreted as a next version or not.\",\"type\":[\"boolean\",\"null\"]},\"nullableOfBoolean5\":{\"description\":\"Strategy which will look for tagged merge commits directly off the current branch.\",\"type\":[\"boolean\",\"null\"]},\"nullableOfBoolean6\":{\"description\":\"Indicates this branch configuration represents develop in GitFlow.\",\"type\":[\"boolean\",\"null\"]},\"string3\":{\"format\":\"date-time\",\"description\":\"Commits before this date will be ignored. Format: yyyy-MM-ddTHH:mm:ss.\",\"type\":\"string\"},\"hashSetOfString2\":{\"description\":\"A sequence of SHAs to be excluded from the version calculations.\",\"type\":\"array\",\"items\":{\"description\":\"A sequence of SHAs to be excluded from the version calculations.\",\"type\":\"string\"}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"GitVersion Configuration (6.0)\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://gitversion.net/schemas/6.0/GitVersion.configuration.json","title":"GitVersion Configuration (6.0)","description":"GitVersion configuration schema (6.0)","type":"object","properties":{"assembly-file-versioning-format":{"description":"Specifies the format of AssemblyFileVersion and overwrites the value of assembly-file-versioning-scheme.","type":"string"},"assembly-file-versioning-scheme":{"description":"The scheme to use when setting AssemblyFileVersion attribute. Can be 'MajorMinorPatchTag', 'MajorMinorPatch', 'MajorMinor', 'Major', 'None'. Defaults to 'MajorMinorPatch'.","default":"MajorMinorPatch","enum":["MajorMinorPatchTag","MajorMinorPatch","MajorMinor","Major","None"]},"assembly-informational-format":{"description":"Specifies the format of AssemblyInformationalVersion. Defaults to '{InformationalVersion}'.","default":"'{InformationalVersion}'","type":"string"},"assembly-versioning-format":{"description":"Specifies the format of AssemblyVersion and overwrites the value of assembly-versioning-scheme.","type":"string"},"assembly-versioning-scheme":{"description":"The scheme to use when setting AssemblyVersion attribute. Can be 'MajorMinorPatchTag', 'MajorMinorPatch', 'MajorMinor', 'Major', 'None'. Defaults to 'MajorMinorPatch'.","default":"MajorMinorPatch","enum":["MajorMinorPatchTag","MajorMinorPatch","MajorMinor","Major","None"]},"branches":{"description":"The header for all the individual branch configuration.","type":"object","additionalProperties":{"$ref":"#/$defs/branchConfiguration"}},"commit-date-format":{"description":"The format to use when calculating the commit date. Defaults to 'yyyy-MM-dd'. See [Standard Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [Custom Date and Time Format Strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings).","default":"yyyy-MM-dd","type":"string"},"commit-message-incrementing":{"$ref":"#/$defs/nullableOfCommitMessageIncrementMode"},"mode":{"$ref":"#/$defs/nullableOfDeploymentMode"},"ignore":{"description":"The header property for the ignore configuration.","type":"object","properties":{"commits-before":{"$ref":"#/$defs/string3"},"sha":{"$ref":"#/$defs/hashSetOfString2"}}},"increment":{"$ref":"#/$defs/incrementStrategy"},"is-main-branch":{"$ref":"#/$defs/nullableOfBoolean"},"is-release-branch":{"$ref":"#/$defs/nullableOfBoolean1"},"is-source-branch-for":{"$ref":"#/$defs/hashSetOfString"},"label":{"$ref":"#/$defs/string"},"label-number-pattern":{"$ref":"#/$defs/string1"},"major-version-bump-message":{"format":"regex","description":"The regular expression to match commit messages with to perform a major version increment. Defaults to '\\+semver:\\s?(breaking|major)'","default":"\\+semver:\\s?(breaking|major)","type":"string"},"merge-message-formats":{"description":"Custom merge message formats to enable identification of merge messages that do not follow the built-in conventions.","type":"object","additionalProperties":{"type":"string"}},"minor-version-bump-message":{"format":"regex","description":"The regular expression to match commit messages with to perform a minor version increment. Defaults to '\\+semver:\\s?(feature|minor)'","default":"\\+semver:\\s?(feature|minor)","type":"string"},"next-version":{"description":"Allows you to bump the next version explicitly. Useful for bumping main or a feature branch with breaking changes","type":"string"},"no-bump-message":{"format":"regex","description":"Used to tell GitVersion not to increment when in Mainline development mode. Defaults to '\\+semver:\\s?(none|skip)'","default":"\\+semver:\\s?(none|skip)","type":"string"},"patch-version-bump-message":{"format":"regex","description":"The regular expression to match commit messages with to perform a patch version increment. Defaults to '\\+semver:\\s?(fix|patch)'","default":"\\+semver:\\s?(fix|patch)","type":"string"},"pre-release-weight":{"$ref":"#/$defs/nullableOfInt32"},"prevent-increment":{"$ref":"#/$defs/preventIncrementConfiguration"},"regex":{"$ref":"#/$defs/string2"},"semantic-version-format":{"description":"Specifies the semantic version format that is used when parsing the string. Can be 'Strict' or 'Loose'. Defaults to 'Strict'.","default":"Strict","enum":["Strict","Loose"]},"source-branches":{"$ref":"#/$defs/hashSetOfString1"},"tag-prefix":{"format":"regex","description":"A regular expression which is used to trim Git tags before processing. Defaults to '[vV]?'","default":"[vV]?","type":"string"},"tag-pre-release-weight":{"description":"The pre-release weight in case of tagged commits. Defaults to 60000.","type":["integer","null"]},"track-merge-message":{"$ref":"#/$defs/nullableOfBoolean4"},"track-merge-target":{"$ref":"#/$defs/nullableOfBoolean5"},"tracks-release-branches":{"$ref":"#/$defs/nullableOfBoolean6"},"update-build-number":{"description":"Whether to update the build number in the project file. Defaults to true.","default":"true","type":"boolean"},"version-in-branch-pattern":{"format":"regex","description":"A regular expression which is used to determine the version number in the branch name or commit message (e.g., v1.0.0-LTS). Defaults to '(?<version>[vV]?\\d+(\\.\\d+)?(\\.\\d+)?).*'.","default":"(?<version>[vV]?\\d+(\\.\\d+)?(\\.\\d+)?).*","type":"string"},"strategies":{"description":"Specifies which version strategies (one or more) will be used to determine the next version. Following values are available: 'ConfiguredNextVersion', 'MergeMessage', 'TaggedCommit', 'TrackReleaseBranches', 'VersionInBranchName' and 'Mainline'.","type":"array","items":{"description":"Specifies which version strategies (one or more) will be used to determine the next version. Following values are available: 'ConfiguredNextVersion', 'MergeMessage', 'TaggedCommit', 'TrackReleaseBranches', 'VersionInBranchName' and 'Mainline'.","enum":["None","Fallback","ConfiguredNextVersion","MergeMessage","TaggedCommit","TrackReleaseBranches","VersionInBranchName","Mainline"]}},"workflow":{"description":"The base template of the configuration to use. Possible values are: 'GitFlow/v1' or 'GitHubFlow/v1'","type":"string"}},"$defs":{"branchConfiguration":{"type":"object","properties":{"commit-message-incrementing":{"$ref":"#/$defs/nullableOfCommitMessageIncrementMode"},"mode":{"$ref":"#/$defs/nullableOfDeploymentMode"},"increment":{"$ref":"#/$defs/incrementStrategy"},"is-main-branch":{"$ref":"#/$defs/nullableOfBoolean"},"is-release-branch":{"$ref":"#/$defs/nullableOfBoolean1"},"is-source-branch-for":{"$ref":"#/$defs/hashSetOfString"},"label":{"$ref":"#/$defs/string"},"label-number-pattern":{"$ref":"#/$defs/string1"},"pre-release-weight":{"$ref":"#/$defs/nullableOfInt32"},"prevent-increment":{"$ref":"#/$defs/preventIncrementConfiguration"},"regex":{"$ref":"#/$defs/string2"},"source-branches":{"$ref":"#/$defs/hashSetOfString1"},"track-merge-message":{"$ref":"#/$defs/nullableOfBoolean4"},"track-merge-target":{"$ref":"#/$defs/nullableOfBoolean5"},"tracks-release-branches":{"$ref":"#/$defs/nullableOfBoolean6"}}},"nullableOfCommitMessageIncrementMode":{"description":"Sets whether it should be possible to increment the version with special syntax in the commit message. Can be 'Disabled', 'Enabled' or 'MergeMessageOnly'.","enum":["Enabled","Disabled","MergeMessageOnly"]},"nullableOfDeploymentMode":{"description":"The deployment mode for this branch. Can be 'ManualDeployment', 'ContinuousDelivery', 'ContinuousDeployment'.","enum":["ManualDeployment","ContinuousDelivery","ContinuousDeployment"]},"incrementStrategy":{"description":"The increment strategy for this branch. Can be 'Inherit', 'Patch', 'Minor', 'Major', 'None'.","enum":["None","Major","Minor","Patch","Inherit"]},"nullableOfBoolean":{"description":"When using Mainline mode, this indicates that this branch is a mainline. By default main and support/* are mainlines.","type":["boolean","null"]},"nullableOfBoolean1":{"description":"Indicates this branch configuration represents a release branch in GitFlow.","type":["boolean","null"]},"hashSetOfString":{"description":"The branches that this branch is a source branch.","type":"array","items":{"description":"The branches that this branch is a source branch.","type":"string"}},"string":{"description":"The label to use for this branch. Use the value {BranchName} or similar as a placeholder to insert a named capture group from RegularExpression (fx. the branch name).","type":"string"},"string1":{"format":"regex","description":"The regular expression pattern to use to extract the number from the branch name. Defaults to '[/-](?<number>\\d+)'.","default":"[/-](?<number>\\d+)","type":"string"},"nullableOfInt32":{"description":"Provides a way to translate the PreReleaseLabel to a number.","type":["integer","null"]},"preventIncrementConfiguration":{"description":"The prevent increment configuration section.","type":"object","properties":{"of-merged-branch":{"$ref":"#/$defs/nullableOfBoolean2"},"when-branch-merged":{"$ref":"#/$defs/nullableOfBoolean2"},"when-current-commit-tagged":{"$ref":"#/$defs/nullableOfBoolean3"}}},"nullableOfBoolean2":{"description":"Prevent increment when branch merged.","type":["boolean","null"]},"nullableOfBoolean3":{"description":"This branch related property controls the behavior whether to use the tagged (value set to true) or the incremented (value set to false) semantic version. Defaults to true.","type":["boolean","null"]},"string2":{"format":"regex","description":"The regular expression pattern to use to match this branch.","type":"string"},"hashSetOfString1":{"description":"The source branches for this branch.","type":"array","items":{"description":"The source branches for this branch.","type":"string"}},"nullableOfBoolean4":{"description":"This property is a branch related property and gives the user the possibility to control the behavior of whether the merge commit message will be interpreted as a next version or not.","type":["boolean","null"]},"nullableOfBoolean5":{"description":"Strategy which will look for tagged merge commits directly off the current branch.","type":["boolean","null"]},"nullableOfBoolean6":{"description":"Indicates this branch configuration represents develop in GitFlow.","type":["boolean","null"]},"string3":{"format":"date-time","description":"Commits before this date will be ignored. Format: yyyy-MM-ddTHH:mm:ss.","type":"string"},"hashSetOfString2":{"description":"A sequence of SHAs to be excluded from the version calculations.","type":"array","items":{"description":"A sequence of SHAs to be excluded from the version calculations.","type":"string"}}}}
|
Provide a JSON object that satisfies the schema "GitVersion Configuration (6.0)". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
GitVersion Configuration (6.0)
|
schema-store
|
schema_store_16
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"title\":\"Add-on Version Checker file\",\"description\":\"A KSP-AVC version file's content\",\"type\":\"object\",\"properties\":{\"NAME\":{\"description\":\"The display name for the add-on\",\"type\":\"string\"},\"URL\":{\"description\":\"Location of a remote version file for update checking\",\"type\":\"string\",\"format\":\"uri\"},\"DOWNLOAD\":{\"description\":\"Web address where the latest version can be downloaded\",\"type\":\"string\",\"format\":\"uri\"},\"CHANGE_LOG\":{\"description\":\"The complete or incremental change log for the add-on\",\"type\":\"string\"},\"CHANGE_LOG_URL\":{\"description\":\"Populates the CHANGE_LOG field using the file at this url\",\"type\":\"string\",\"format\":\"uri\"},\"GITHUB\":{\"description\":\"Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified. If the latest release version is not equal to the version in the file, an update notification will not appear.\",\"type\":\"object\",\"properties\":{\"USERNAME \":{\"description\":\"Your GitHub username\",\"type\":\"string\"},\"REPOSITORY \":{\"description\":\"The name of the source repository\",\"type\":\"string\"},\"ALLOW_PRE_RELEASE \":{\"description\":\"Include pre-releases in the latest release search\",\"type\":\"boolean\"}},\"required\":[\"USERNAME\",\"REPOSITORY\"]},\"KERBAL_STUFF_URL\":{\"description\":\"URL to this mod's page on KerbalStuff\",\"type\":\"string\",\"format\":\"uri\"},\"VERSION\":{\"description\":\"The version of the add-on\",\"$ref\":\"#/definitions/version\"},\"KSP_VERSION\":{\"description\":\"Version of KSP that the add-on was made to support\",\"$ref\":\"#/definitions/version\"},\"KSP_VERSION_MIN\":{\"description\":\"Minimum version of KSP that the add-on supports\",\"$ref\":\"#/definitions/version\"},\"KSP_VERSION_MAX\":{\"description\":\"Maximum version of KSP that the add-on supports\",\"$ref\":\"#/definitions/version\"},\"DISALLOW_VERSION_OVERRIDE\":{\"type\":\"boolean\",\"description\":\"If true, don't trust KSP-AVC's idea of which game versions are compatible with which other game versions, based on user configuration\"},\"ASSEMBLY_NAME\":{\"type\":\"string\",\"description\":\"DO NOT USE, won't work with CKAN; name of a DLL to check for VERSION on the fly\"},\"KSP_VERSION_INCLUDE\":{\"description\":\"DO NOT USE, won't work with CKAN; a list of versions with which this mod is compatible\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/version\"},\"uniqueItems\":true},\"KSP_VERSION_EXCLUDE\":{\"description\":\"DO NOT USE, won't work with CKAN; a list of versions with which this mod is incompatible\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/version\"},\"uniqueItems\":true},\"LOCAL_HAS_PRIORITY\":{\"type\":\"boolean\",\"description\":\"DO NOT USE, won't work with CKAN; if true, don't override properties using the remote version file\"},\"REMOTE_HAS_PRIORITY\":{\"type\":\"boolean\",\"description\":\"DO NOT USE, won't work with CKAN; if false, don't override properties using the remote version file\"},\"INSTALL_LOC|INSTALL_LOC*\":{\"description\":\"Stanza to define file location to check, used by MADLAD\",\"$ref\":\"#/definitions/install_loc\"}},\"required\":[\"NAME\",\"VERSION\"],\"definitions\":{\"version\":{\"description\":\"A semantic(?) version\",\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(any|[0-9]+\\\\.[0-9]+(\\\\.[0-9]+)?)$\"},{\"type\":\"object\",\"properties\":{\"MAJOR\":{\"description\":\"Change major version when you make incompatible API changes\",\"type\":\"integer\"},\"MINOR\":{\"description\":\"Change minor version when you add functionality in a backwards-compatible manner\",\"type\":\"integer\"},\"PATCH\":{\"description\":\"Change patch version when you make backwards-compatible bug fixes\",\"type\":\"integer\"},\"BUILD\":{\"description\":\"Build informaion\",\"type\":\"integer\"}},\"required\":[\"MAJOR\"]}]},\"install_loc\":{\"description\":\"definition of the install_loc fields\",\"NAME\":{\"type\":\"string\",\"description\":\"Name of the mod, If not specified, uses the Modname from the .version file\"},\"PATH\":{\"type\":\"string\",\"description\":\"Path to the directory, begins below the GameData. Must be there, but will be empty in most cases\"},\"DIRECTORY\":{\"type\":\"string\",\"description\":\"Directory where file is\"},\"FILE\":{\"type\":\"string\",\"description\":\"filename to be checked. If not specified, then it checks for the directory only\"},\"required\":[\"PATH\",\"DIRECTORY\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Add-on Version Checker file\". Here are the required top‑level fields: NAME, VERSION. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","title":"Add-on Version Checker file","description":"A KSP-AVC version file's content","type":"object","properties":{"NAME":{"description":"The display name for the add-on","type":"string"},"URL":{"description":"Location of a remote version file for update checking","type":"string","format":"uri"},"DOWNLOAD":{"description":"Web address where the latest version can be downloaded","type":"string","format":"uri"},"CHANGE_LOG":{"description":"The complete or incremental change log for the add-on","type":"string"},"CHANGE_LOG_URL":{"description":"Populates the CHANGE_LOG field using the file at this url","type":"string","format":"uri"},"GITHUB":{"description":"Allows KSP-AVC to do release checks with GitHub including setting a download location if one is not specified. If the latest release version is not equal to the version in the file, an update notification will not appear.","type":"object","properties":{"USERNAME ":{"description":"Your GitHub username","type":"string"},"REPOSITORY ":{"description":"The name of the source repository","type":"string"},"ALLOW_PRE_RELEASE ":{"description":"Include pre-releases in the latest release search","type":"boolean"}},"required":["USERNAME","REPOSITORY"]},"KERBAL_STUFF_URL":{"description":"URL to this mod's page on KerbalStuff","type":"string","format":"uri"},"VERSION":{"description":"The version of the add-on","$ref":"#/definitions/version"},"KSP_VERSION":{"description":"Version of KSP that the add-on was made to support","$ref":"#/definitions/version"},"KSP_VERSION_MIN":{"description":"Minimum version of KSP that the add-on supports","$ref":"#/definitions/version"},"KSP_VERSION_MAX":{"description":"Maximum version of KSP that the add-on supports","$ref":"#/definitions/version"},"DISALLOW_VERSION_OVERRIDE":{"type":"boolean","description":"If true, don't trust KSP-AVC's idea of which game versions are compatible with which other game versions, based on user configuration"},"ASSEMBLY_NAME":{"type":"string","description":"DO NOT USE, won't work with CKAN; name of a DLL to check for VERSION on the fly"},"KSP_VERSION_INCLUDE":{"description":"DO NOT USE, won't work with CKAN; a list of versions with which this mod is compatible","type":"array","items":{"$ref":"#/definitions/version"},"uniqueItems":true},"KSP_VERSION_EXCLUDE":{"description":"DO NOT USE, won't work with CKAN; a list of versions with which this mod is incompatible","type":"array","items":{"$ref":"#/definitions/version"},"uniqueItems":true},"LOCAL_HAS_PRIORITY":{"type":"boolean","description":"DO NOT USE, won't work with CKAN; if true, don't override properties using the remote version file"},"REMOTE_HAS_PRIORITY":{"type":"boolean","description":"DO NOT USE, won't work with CKAN; if false, don't override properties using the remote version file"},"INSTALL_LOC|INSTALL_LOC*":{"description":"Stanza to define file location to check, used by MADLAD","$ref":"#/definitions/install_loc"}},"required":["NAME","VERSION"],"definitions":{"version":{"description":"A semantic(?) version","anyOf":[{"type":"string","pattern":"^(any|[0-9]+\\.[0-9]+(\\.[0-9]+)?)$"},{"type":"object","properties":{"MAJOR":{"description":"Change major version when you make incompatible API changes","type":"integer"},"MINOR":{"description":"Change minor version when you add functionality in a backwards-compatible manner","type":"integer"},"PATCH":{"description":"Change patch version when you make backwards-compatible bug fixes","type":"integer"},"BUILD":{"description":"Build informaion","type":"integer"}},"required":["MAJOR"]}]},"install_loc":{"description":"definition of the install_loc fields","NAME":{"type":"string","description":"Name of the mod, If not specified, uses the Modname from the .version file"},"PATH":{"type":"string","description":"Path to the directory, begins below the GameData. Must be there, but will be empty in most cases"},"DIRECTORY":{"type":"string","description":"Directory where file is"},"FILE":{"type":"string","description":"filename to be checked. If not specified, then it checks for the directory only"},"required":["PATH","DIRECTORY"]}}}
|
Provide a JSON object that satisfies the schema "Add-on Version Checker file". Here are the required top‑level fields: NAME, VERSION. Return only the valid JSON object.
|
Add-on Version Checker file
|
schema-store
|
schema_store_17
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"title\":\"NetKAN JSON Schema\",\"description\":\"Schema for validating NetKAN files\",\"type\":\"object\",\"properties\":{\"abstract\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/abstract\"},\"author\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/author\"},\"comment\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/comment\"},\"conflicts\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/conflicts\"},\"depends\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/depends\"},\"description\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/description\"},\"download\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download\"},\"download_content_type\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download_content_type\"},\"download_hash\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download_hash\"},\"download_size\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download_size\"},\"identifier\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/identifier\"},\"install\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/install\"},\"install_size\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/install_size\"},\"kind\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/kind\"},\"ksp_version\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version\"},\"ksp_version_max\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version_max\"},\"ksp_version_min\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version_min\"},\"ksp_version_strict\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version_strict\"},\"license\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/license\"},\"localizations\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/localizations\"},\"name\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/name\"},\"provides\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/provides\"},\"recommends\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/recommends\"},\"release_date\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/release_date\"},\"release_status\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/release_status\"},\"replaced_by\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/replaced_by\"},\"resources\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/resources\"},\"spec_version\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/spec_version\"},\"suggests\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/suggests\"},\"supports\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/supports\"},\"tags\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/tags\"},\"version\":{\"$ref\":\"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/version\"},\"$kref\":{\"description\":\"Indicates that data should be filled in from an external service provider\",\"type\":\"string\",\"oneOf\":[{\"pattern\":\"^#/ckan/spacedock/[0-9]+$\",\"description\":\"Indicates that data should be fetched from SpaceDock\"},{\"pattern\":\"^#/ckan/curse/[A-Za-z0-9_-]+$\",\"description\":\"Deprecated format, no longer supported\"},{\"pattern\":\"^#/ckan/github/[A-Za-z0-9_-]+/[A-Za-z0-9_-]+(/asset_match/.+|/version_from_asset/.+)?$\",\"description\":\"Indicates that data should be fetched from the GitHub user and repo provided\"},{\"pattern\":\"^#/ckan/gitlab/[A-Za-z0-9_-]+/[A-Za-z0-9_-]+$\",\"description\":\"Indicates that data should be fetched from the GitLab the user and repo provided\"},{\"pattern\":\"^#/ckan/sourceforge/.+$\",\"description\":\"Indicates that data should be fetched from SourceForge using the repo provided\"},{\"pattern\":\"^#/ckan/jenkins/.+$\",\"description\":\"Indicates that data should be fetched from a Jenkins CI server using the joburl provided\"},{\"pattern\":\"^#/ckan/http/.+$\",\"description\":\"Indicates data should be fetched from an HTTP server, using the URL provided\"},{\"pattern\":\"^#/ckan/ksp-avc/.+$\",\"description\":\"Indicates that data should be fetched from a KSP-AVC .version file at the URL provided\"},{\"pattern\":\"^#/ckan/netkan/.+$\",\"description\":\"Indicates that data should be fetched from the .netkan file at the given URL\"}]},\"$vref\":{\"description\":\"Indicates that version data should be filled in from an external service provider\",\"type\":\"string\",\"oneOf\":[{\"pattern\":\"^#/ckan/ksp-avc(/.*)?$\",\"description\":\"Version information should be retrieved from an embedded KSP-AVC .version file inside the downloaded file\"},{\"pattern\":\"^#/ckan/space-warp(/.*)?$\",\"description\":\"Version information should be retrieved from an embedded SpaceWarp swinfo.json file inside the downloaded file\"}]},\"x_netkan_trust_version_file\":{\"description\":\"If true (and $vref is set), set the version property to the VERSION specified in the .version file\",\"type\":\"boolean\"},\"x_netkan_epoch\":{\"description\":\"Specifies a minimum epoch number manually in the version field\",\"type\":\"integer\"},\"x_netkan_allow_out_of_order\":{\"description\":\"If true, then this module allows a freshly released version to have a version number smaller than previously existing releases\",\"type\":\"boolean\"},\"x_netkan_force_v\":{\"description\":\"If true, then a v is prepended to the version field if not already present\",\"type\":\"boolean\"},\"x_netkan_version_edit\":{\"oneOf\":[{\"description\":\"Regex to match against the existing version field\",\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"find\":{\"description\":\"Regex to match against the existing version field\",\"type\":\"string\"},\"replace\":{\"description\":\"Regex substitution string to use as the value of the new version field\",\"type\":\"string\"},\"strict\":{\"description\":\"If true, produce an error if the find regex fails to match\",\"type\":\"boolean\"}},\"required\":[\"find\"]}]},\"x_netkan_override\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"version\":{\"oneOf\":[{\"description\":\"Version comparison string to match against version\",\"type\":\"string\"},{\"description\":\"Version comparison strings to match against version\",\"type\":\"array\",\"items\":{\"description\":\"Version comparison string to match against version\",\"type\":\"string\"}}]},\"before\":{\"description\":\"Name of a transformation for this override to happen directly before\",\"$ref\":\"#/definitions/inflation_steps\"},\"after\":{\"description\":\"Name of a transformation for this override to happen directly after\",\"$ref\":\"#/definitions/inflation_steps\"},\"override\":{\"description\":\"An object whose fields will replace the fields already present if a match occurs\",\"type\":\"object\"},\"delete\":{\"description\":\"Array of names of fields to remove if a match occurs\",\"type\":\"array\",\"items\":{\"description\":\"Name of field to remove if a match occurs\",\"type\":\"string\"}}}}},\"x_netkan_staging\":{\"type\":\"boolean\",\"description\":\"If true, changed metadata files for this module will be committed to a separate module-specific branch and a pull request will be created to merge this branch\"},\"x_netkan_staging_reason\":{\"type\":\"string\",\"description\":\"Explanation of why staging is enabled for this module to be pasted into the pull request\"},\"x_netkan_jenkins\":{\"description\":\"Customizes how the metadata is fetched from the Jenkins server\",\"type\":\"object\",\"properties\":{\"build\":{\"description\":\"Type of build to use\",\"enum\":[\"any\",\"completed\",\"failed\",\"stable\",\"successful\",\"unstable\",\"unsuccessful\"]},\"asset_match\":{\"description\":\"Regex to select which artifact to use by filename\",\"type\":\"string\"},\"use_filename_version\":{\"description\":\"If true, use the filename of the matched artifact as the value of the version property\",\"type\":\"boolean\"}}},\"x_netkan_github\":{\"description\":\"Customizes how the metadata is fetched from GitHub\",\"type\":\"object\",\"properties\":{\"use_source_archive\":{\"description\":\"If true, the release's source ZIP will be used instead of an asset\",\"type\":\"boolean\"},\"prereleases\":{\"description\":\"Skip prereleases if false, skip regular releases if true, use both if absent\",\"type\":\"boolean\"}}},\"x_netkan_gitlab\":{\"description\":\"Customizes how the metadata is fetched from GitLab\",\"type\":\"object\",\"properties\":{\"use_source_archive\":{\"description\":\"If true, the release's source ZIP will be used instead of an asset\",\"type\":\"boolean\"}}}},\"required\":[\"identifier\"],\"oneOf\":[{\"required\":[\"$kref\"]},{\"required\":[\"download\"]}],\"definitions\":{\"inflation_steps\":{\"enum\":[\"$none\",\"$all\",\"avc\",\"download_attributes\",\"epoch\",\"forced_v\",\"generated_by\",\"github\",\"http\",\"internal_ckan\",\"jenkins\",\"metanetkan\",\"optimus_prime\",\"property_sort\",\"spacedock\",\"curse\",\"strip_netkan_metadata\",\"version_edit\",\"versioned_override\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"NetKAN JSON Schema\". Here are the required top‑level fields: identifier. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","title":"NetKAN JSON Schema","description":"Schema for validating NetKAN files","type":"object","properties":{"abstract":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/abstract"},"author":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/author"},"comment":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/comment"},"conflicts":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/conflicts"},"depends":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/depends"},"description":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/description"},"download":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download"},"download_content_type":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download_content_type"},"download_hash":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download_hash"},"download_size":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/download_size"},"identifier":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/identifier"},"install":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/install"},"install_size":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/install_size"},"kind":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/kind"},"ksp_version":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version"},"ksp_version_max":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version_max"},"ksp_version_min":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version_min"},"ksp_version_strict":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/ksp_version_strict"},"license":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/license"},"localizations":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/localizations"},"name":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/name"},"provides":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/provides"},"recommends":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/recommends"},"release_date":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/release_date"},"release_status":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/release_status"},"replaced_by":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/replaced_by"},"resources":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/resources"},"spec_version":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/spec_version"},"suggests":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/suggests"},"supports":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/supports"},"tags":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/tags"},"version":{"$ref":"https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema#/properties/version"},"$kref":{"description":"Indicates that data should be filled in from an external service provider","type":"string","oneOf":[{"pattern":"^#/ckan/spacedock/[0-9]+$","description":"Indicates that data should be fetched from SpaceDock"},{"pattern":"^#/ckan/curse/[A-Za-z0-9_-]+$","description":"Deprecated format, no longer supported"},{"pattern":"^#/ckan/github/[A-Za-z0-9_-]+/[A-Za-z0-9_-]+(/asset_match/.+|/version_from_asset/.+)?$","description":"Indicates that data should be fetched from the GitHub user and repo provided"},{"pattern":"^#/ckan/gitlab/[A-Za-z0-9_-]+/[A-Za-z0-9_-]+$","description":"Indicates that data should be fetched from the GitLab the user and repo provided"},{"pattern":"^#/ckan/sourceforge/.+$","description":"Indicates that data should be fetched from SourceForge using the repo provided"},{"pattern":"^#/ckan/jenkins/.+$","description":"Indicates that data should be fetched from a Jenkins CI server using the joburl provided"},{"pattern":"^#/ckan/http/.+$","description":"Indicates data should be fetched from an HTTP server, using the URL provided"},{"pattern":"^#/ckan/ksp-avc/.+$","description":"Indicates that data should be fetched from a KSP-AVC .version file at the URL provided"},{"pattern":"^#/ckan/netkan/.+$","description":"Indicates that data should be fetched from the .netkan file at the given URL"}]},"$vref":{"description":"Indicates that version data should be filled in from an external service provider","type":"string","oneOf":[{"pattern":"^#/ckan/ksp-avc(/.*)?$","description":"Version information should be retrieved from an embedded KSP-AVC .version file inside the downloaded file"},{"pattern":"^#/ckan/space-warp(/.*)?$","description":"Version information should be retrieved from an embedded SpaceWarp swinfo.json file inside the downloaded file"}]},"x_netkan_trust_version_file":{"description":"If true (and $vref is set), set the version property to the VERSION specified in the .version file","type":"boolean"},"x_netkan_epoch":{"description":"Specifies a minimum epoch number manually in the version field","type":"integer"},"x_netkan_allow_out_of_order":{"description":"If true, then this module allows a freshly released version to have a version number smaller than previously existing releases","type":"boolean"},"x_netkan_force_v":{"description":"If true, then a v is prepended to the version field if not already present","type":"boolean"},"x_netkan_version_edit":{"oneOf":[{"description":"Regex to match against the existing version field","type":"string"},{"type":"object","properties":{"find":{"description":"Regex to match against the existing version field","type":"string"},"replace":{"description":"Regex substitution string to use as the value of the new version field","type":"string"},"strict":{"description":"If true, produce an error if the find regex fails to match","type":"boolean"}},"required":["find"]}]},"x_netkan_override":{"type":"array","items":{"type":"object","properties":{"version":{"oneOf":[{"description":"Version comparison string to match against version","type":"string"},{"description":"Version comparison strings to match against version","type":"array","items":{"description":"Version comparison string to match against version","type":"string"}}]},"before":{"description":"Name of a transformation for this override to happen directly before","$ref":"#/definitions/inflation_steps"},"after":{"description":"Name of a transformation for this override to happen directly after","$ref":"#/definitions/inflation_steps"},"override":{"description":"An object whose fields will replace the fields already present if a match occurs","type":"object"},"delete":{"description":"Array of names of fields to remove if a match occurs","type":"array","items":{"description":"Name of field to remove if a match occurs","type":"string"}}}}},"x_netkan_staging":{"type":"boolean","description":"If true, changed metadata files for this module will be committed to a separate module-specific branch and a pull request will be created to merge this branch"},"x_netkan_staging_reason":{"type":"string","description":"Explanation of why staging is enabled for this module to be pasted into the pull request"},"x_netkan_jenkins":{"description":"Customizes how the metadata is fetched from the Jenkins server","type":"object","properties":{"build":{"description":"Type of build to use","enum":["any","completed","failed","stable","successful","unstable","unsuccessful"]},"asset_match":{"description":"Regex to select which artifact to use by filename","type":"string"},"use_filename_version":{"description":"If true, use the filename of the matched artifact as the value of the version property","type":"boolean"}}},"x_netkan_github":{"description":"Customizes how the metadata is fetched from GitHub","type":"object","properties":{"use_source_archive":{"description":"If true, the release's source ZIP will be used instead of an asset","type":"boolean"},"prereleases":{"description":"Skip prereleases if false, skip regular releases if true, use both if absent","type":"boolean"}}},"x_netkan_gitlab":{"description":"Customizes how the metadata is fetched from GitLab","type":"object","properties":{"use_source_archive":{"description":"If true, the release's source ZIP will be used instead of an asset","type":"boolean"}}}},"required":["identifier"],"oneOf":[{"required":["$kref"]},{"required":["download"]}],"definitions":{"inflation_steps":{"enum":["$none","$all","avc","download_attributes","epoch","forced_v","generated_by","github","http","internal_ckan","jenkins","metanetkan","optimus_prime","property_sort","spacedock","curse","strip_netkan_metadata","version_edit","versioned_override"]}}}
|
Provide a JSON object that satisfies the schema "NetKAN JSON Schema". Here are the required top‑level fields: identifier. Return only the valid JSON object.
|
NetKAN JSON Schema
|
schema-store
|
schema_store_18
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/abc-inventory-module-data-5.1.0.json\",\"title\":\"ABCInventoryModuleData JSON Schema\",\"description\":\"Schema defining the structure of ABCInventoryModuleData including Principal Data, inventory, and transaction data in ABC-Plan's Inventory Management Module. Version 5.1.0 adds support for Change Attributes transactions.\",\"type\":\"object\",\"definitions\":{\"ABCStatus\":{\"type\":\"string\",\"enum\":[\"RELEASED\",\"CONDITIONAL_RELEASED\",\"QUARANTINE\",\"IN_TRANSIT\",\"ON_HOLD\",\"EXPIRED\",\"DAMAGED\"]},\"ABCInventoryReceiveTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"receive\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"materialCategoryID\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"dateOfExpiry\":{\"type\":\"string\",\"format\":\"date\"},\"dateOfManufacture\":{\"type\":\"string\",\"format\":\"date\"},\"poNumber\":{\"type\":\"string\"},\"statusID\":{\"$ref\":\"#/definitions/ABCStatus\"},\"locationID\":{\"type\":\"string\"},\"tagIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"productID\":{\"type\":[\"string\",\"null\"]},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotNumber\",\"materialNumberID\",\"materialCategoryID\",\"quantity\",\"dateOfExpiry\",\"dateOfManufacture\",\"poNumber\",\"statusID\",\"locationID\",\"tagIDs\",\"productID\",\"notes\"],\"additionalProperties\":false},\"targetLotID\":{\"type\":\"string\"}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryBuildTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"build\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"materialCategoryID\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"dateOfExpiry\":{\"type\":\"string\",\"format\":\"date\"},\"dateOfManufacture\":{\"type\":\"string\",\"format\":\"date\"},\"poNumber\":{\"type\":\"string\"},\"statusID\":{\"$ref\":\"#/definitions/ABCStatus\"},\"locationID\":{\"type\":\"string\"},\"tagIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"upstreams\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"}},\"required\":[\"lotID\",\"quantity\"],\"additionalProperties\":false}},\"upstreamIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"upstreamLotNumbers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"upstreamQuantities\":{\"type\":\"array\",\"items\":{\"type\":\"number\"}},\"upstreamMaterialNumberIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"upstreamMaterialCategoryIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"upstreamLocationIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"productID\":{\"type\":[\"string\",\"null\"]},\"upstreamProductIDs\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"null\"]}},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotNumber\",\"materialNumberID\",\"materialCategoryID\",\"quantity\",\"dateOfExpiry\",\"dateOfManufacture\",\"poNumber\",\"statusID\",\"locationID\",\"tagIDs\",\"upstreams\",\"upstreamIDs\",\"upstreamLotNumbers\",\"upstreamQuantities\",\"upstreamMaterialNumberIDs\",\"upstreamMaterialCategoryIDs\",\"upstreamLocationIDs\",\"productID\",\"upstreamProductIDs\",\"notes\"],\"additionalProperties\":false},\"targetLotID\":{\"type\":\"string\"}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryTransferTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"transfer\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"newLocationID\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"newLocationID\",\"quantity\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false},\"targetLotID\":{\"type\":\"string\"}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryStatusChangeTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"statusChange\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"newStatusID\":{\"$ref\":\"#/definitions/ABCStatus\"},\"quantity\":{\"type\":\"number\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"newStatusID\",\"quantity\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false},\"targetLotID\":{\"type\":\"string\"}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryDistributeTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"distribute\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"quantity\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryDestroyTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"destroy\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventorySellTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"sell\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"quantity\":{\"type\":\"number\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"quantity\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryAdjustTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"adjust\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"newQuantity\":{\"type\":\"number\"},\"reasonCodeID\":{\"type\":\"string\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"newQuantity\",\"reasonCodeID\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false},\"oldQuantity\":{\"type\":\"number\"}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\",\"oldQuantity\"],\"additionalProperties\":false},\"ABCInventoryChangeExpiryTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"changeExpiry\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"newDateOfExpiry\":{\"type\":\"string\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"locationID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"newDateOfExpiry\",\"lotNumber\",\"materialNumberID\",\"locationID\",\"productID\",\"materialCategoryID\",\"notes\"],\"additionalProperties\":false}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryChangeAttributesTransaction\":{\"type\":\"object\",\"properties\":{\"uid\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"number\"},\"transactionType\":{\"type\":\"string\",\"enum\":[\"changeAttributes\"]},\"transactionData\":{\"type\":\"object\",\"properties\":{\"lotID\":{\"type\":\"string\"},\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"materialCategoryID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"locationID\":{\"type\":\"string\"},\"dateOfManufacture\":{\"type\":\"string\",\"format\":\"date\"},\"poNumber\":{\"type\":\"string\"},\"tagIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"notes\":{\"type\":\"string\"}},\"required\":[\"lotID\",\"lotNumber\",\"materialNumberID\",\"materialCategoryID\",\"productID\",\"locationID\"],\"additionalProperties\":false}},\"required\":[\"uid\",\"timestamp\",\"transactionType\",\"transactionData\"],\"additionalProperties\":false},\"ABCInventoryTransaction\":{\"oneOf\":[{\"$ref\":\"#/definitions/ABCInventoryReceiveTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryBuildTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryTransferTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryStatusChangeTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryDistributeTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryDestroyTransaction\"},{\"$ref\":\"#/definitions/ABCInventorySellTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryAdjustTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryChangeExpiryTransaction\"},{\"$ref\":\"#/definitions/ABCInventoryChangeAttributesTransaction\"}]},\"ABCInventoryEntryWithoutUpstreams\":{\"type\":\"object\",\"properties\":{\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"materialCategoryID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"quantity\":{\"type\":\"number\"},\"dateOfExpiry\":{\"type\":\"string\",\"format\":\"date\"},\"dateOfManufacture\":{\"type\":\"string\",\"format\":\"date\"},\"poNumber\":{\"type\":\"string\"},\"statusID\":{\"$ref\":\"#/definitions/ABCStatus\"},\"locationID\":{\"type\":\"string\"},\"tagIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"hasUpstreams\":{\"type\":\"boolean\",\"enum\":[false]},\"transactionNotes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"lotNumberLowercase\":{\"type\":\"string\"}},\"required\":[\"lotNumber\",\"materialNumberID\",\"materialCategoryID\",\"productID\",\"quantity\",\"dateOfExpiry\",\"dateOfManufacture\",\"poNumber\",\"statusID\",\"locationID\",\"tagIDs\",\"hasUpstreams\",\"transactionNotes\",\"lotNumberLowercase\"],\"additionalProperties\":false},\"ABCInventoryEntryWithUpstreams\":{\"type\":\"object\",\"properties\":{\"lotNumber\":{\"type\":\"string\"},\"materialNumberID\":{\"type\":\"string\"},\"materialCategoryID\":{\"type\":\"string\"},\"productID\":{\"type\":[\"string\",\"null\"]},\"quantity\":{\"type\":\"number\"},\"dateOfExpiry\":{\"type\":\"string\",\"format\":\"date\"},\"dateOfManufacture\":{\"type\":\"string\",\"format\":\"date\"},\"poNumber\":{\"type\":\"string\"},\"statusID\":{\"$ref\":\"#/definitions/ABCStatus\"},\"locationID\":{\"type\":\"string\"},\"tagIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"hasUpstreams\":{\"type\":\"boolean\",\"enum\":[true]},\"upstreamIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"upstreamQuantities\":{\"type\":\"array\",\"items\":{\"type\":\"number\"}},\"upstreamLotNumbers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"transactionNotes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"lotNumberLowercase\":{\"type\":\"string\"}},\"required\":[\"lotNumber\",\"materialNumberID\",\"materialCategoryID\",\"productID\",\"quantity\",\"dateOfExpiry\",\"dateOfManufacture\",\"poNumber\",\"statusID\",\"locationID\",\"tagIDs\",\"hasUpstreams\",\"upstreamIDs\",\"upstreamQuantities\",\"upstreamLotNumbers\",\"transactionNotes\",\"lotNumberLowercase\"],\"additionalProperties\":false},\"ABCInventoryEntry\":{\"oneOf\":[{\"$ref\":\"#/definitions/ABCInventoryEntryWithoutUpstreams\"},{\"$ref\":\"#/definitions/ABCInventoryEntryWithUpstreams\"}]}},\"properties\":{\"$schema\":{\"description\":\"Link to https://www.schemastore.org/abc-inventory-module-data-5.1.0.json\",\"type\":\"string\",\"enum\":[\"https://www.schemastore.org/abc-inventory-module-data-5.1.0.json\"]},\"ABCProducts\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"name\",\"isActive\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCVendors\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"name\",\"isActive\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCMaterialCategories\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"prefix\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"name\",\"isActive\",\"prefix\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCMaterialNumbers\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"productID\":{\"type\":[\"string\",\"null\"]},\"vendorID\":{\"type\":[\"string\",\"null\"]},\"materialCategoryID\":{\"type\":\"string\"},\"number\":{\"type\":\"number\"},\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"unitOfMeasure\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"productID\",\"vendorID\",\"materialCategoryID\",\"number\",\"name\",\"description\",\"unitOfMeasure\",\"isActive\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCLocations\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"name\",\"isActive\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCTags\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"name\",\"isActive\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCReasonCodes\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"code\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}},\"required\":[\"code\",\"description\",\"isActive\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"ABCTransactions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ABCInventoryTransaction\"}},\"ABCInventoryEntries\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"$ref\":\"#/definitions/ABCInventoryEntry\"}},\"additionalProperties\":false}},\"required\":[\"$schema\",\"ABCProducts\",\"ABCVendors\",\"ABCMaterialCategories\",\"ABCMaterialNumbers\",\"ABCLocations\",\"ABCTags\",\"ABCReasonCodes\",\"ABCTransactions\",\"ABCInventoryEntries\"],\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ABCInventoryModuleData JSON Schema\". Here are the required top‑level fields: $schema, ABCProducts, ABCVendors, ABCMaterialCategories, ABCMaterialNumbers, ABCLocations, ABCTags, ABCReasonCodes, ABCTransactions, ABCInventoryEntries. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/abc-inventory-module-data-5.1.0.json","title":"ABCInventoryModuleData JSON Schema","description":"Schema defining the structure of ABCInventoryModuleData including Principal Data, inventory, and transaction data in ABC-Plan's Inventory Management Module. Version 5.1.0 adds support for Change Attributes transactions.","type":"object","definitions":{"ABCStatus":{"type":"string","enum":["RELEASED","CONDITIONAL_RELEASED","QUARANTINE","IN_TRANSIT","ON_HOLD","EXPIRED","DAMAGED"]},"ABCInventoryReceiveTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["receive"]},"transactionData":{"type":"object","properties":{"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"materialCategoryID":{"type":"string"},"quantity":{"type":"number"},"dateOfExpiry":{"type":"string","format":"date"},"dateOfManufacture":{"type":"string","format":"date"},"poNumber":{"type":"string"},"statusID":{"$ref":"#/definitions/ABCStatus"},"locationID":{"type":"string"},"tagIDs":{"type":"array","items":{"type":"string"}},"productID":{"type":["string","null"]},"notes":{"type":"string"}},"required":["lotNumber","materialNumberID","materialCategoryID","quantity","dateOfExpiry","dateOfManufacture","poNumber","statusID","locationID","tagIDs","productID","notes"],"additionalProperties":false},"targetLotID":{"type":"string"}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryBuildTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["build"]},"transactionData":{"type":"object","properties":{"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"materialCategoryID":{"type":"string"},"quantity":{"type":"number"},"dateOfExpiry":{"type":"string","format":"date"},"dateOfManufacture":{"type":"string","format":"date"},"poNumber":{"type":"string"},"statusID":{"$ref":"#/definitions/ABCStatus"},"locationID":{"type":"string"},"tagIDs":{"type":"array","items":{"type":"string"}},"upstreams":{"type":"array","items":{"type":"object","properties":{"lotID":{"type":"string"},"quantity":{"type":"number"}},"required":["lotID","quantity"],"additionalProperties":false}},"upstreamIDs":{"type":"array","items":{"type":"string"}},"upstreamLotNumbers":{"type":"array","items":{"type":"string"}},"upstreamQuantities":{"type":"array","items":{"type":"number"}},"upstreamMaterialNumberIDs":{"type":"array","items":{"type":"string"}},"upstreamMaterialCategoryIDs":{"type":"array","items":{"type":"string"}},"upstreamLocationIDs":{"type":"array","items":{"type":"string"}},"productID":{"type":["string","null"]},"upstreamProductIDs":{"type":"array","items":{"type":["string","null"]}},"notes":{"type":"string"}},"required":["lotNumber","materialNumberID","materialCategoryID","quantity","dateOfExpiry","dateOfManufacture","poNumber","statusID","locationID","tagIDs","upstreams","upstreamIDs","upstreamLotNumbers","upstreamQuantities","upstreamMaterialNumberIDs","upstreamMaterialCategoryIDs","upstreamLocationIDs","productID","upstreamProductIDs","notes"],"additionalProperties":false},"targetLotID":{"type":"string"}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryTransferTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["transfer"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"newLocationID":{"type":"string"},"quantity":{"type":"number"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","newLocationID","quantity","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false},"targetLotID":{"type":"string"}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryStatusChangeTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["statusChange"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"newStatusID":{"$ref":"#/definitions/ABCStatus"},"quantity":{"type":"number"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","newStatusID","quantity","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false},"targetLotID":{"type":"string"}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryDistributeTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["distribute"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"quantity":{"type":"number"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","quantity","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryDestroyTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["destroy"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventorySellTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["sell"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"quantity":{"type":"number"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","quantity","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryAdjustTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["adjust"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"newQuantity":{"type":"number"},"reasonCodeID":{"type":"string"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","newQuantity","reasonCodeID","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false},"oldQuantity":{"type":"number"}},"required":["uid","timestamp","transactionType","transactionData","oldQuantity"],"additionalProperties":false},"ABCInventoryChangeExpiryTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["changeExpiry"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"newDateOfExpiry":{"type":"string"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"locationID":{"type":"string"},"productID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"notes":{"type":"string"}},"required":["lotID","newDateOfExpiry","lotNumber","materialNumberID","locationID","productID","materialCategoryID","notes"],"additionalProperties":false}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryChangeAttributesTransaction":{"type":"object","properties":{"uid":{"type":"string"},"timestamp":{"type":"number"},"transactionType":{"type":"string","enum":["changeAttributes"]},"transactionData":{"type":"object","properties":{"lotID":{"type":"string"},"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"materialCategoryID":{"type":"string"},"productID":{"type":["string","null"]},"locationID":{"type":"string"},"dateOfManufacture":{"type":"string","format":"date"},"poNumber":{"type":"string"},"tagIDs":{"type":"array","items":{"type":"string"}},"notes":{"type":"string"}},"required":["lotID","lotNumber","materialNumberID","materialCategoryID","productID","locationID"],"additionalProperties":false}},"required":["uid","timestamp","transactionType","transactionData"],"additionalProperties":false},"ABCInventoryTransaction":{"oneOf":[{"$ref":"#/definitions/ABCInventoryReceiveTransaction"},{"$ref":"#/definitions/ABCInventoryBuildTransaction"},{"$ref":"#/definitions/ABCInventoryTransferTransaction"},{"$ref":"#/definitions/ABCInventoryStatusChangeTransaction"},{"$ref":"#/definitions/ABCInventoryDistributeTransaction"},{"$ref":"#/definitions/ABCInventoryDestroyTransaction"},{"$ref":"#/definitions/ABCInventorySellTransaction"},{"$ref":"#/definitions/ABCInventoryAdjustTransaction"},{"$ref":"#/definitions/ABCInventoryChangeExpiryTransaction"},{"$ref":"#/definitions/ABCInventoryChangeAttributesTransaction"}]},"ABCInventoryEntryWithoutUpstreams":{"type":"object","properties":{"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"materialCategoryID":{"type":"string"},"productID":{"type":["string","null"]},"quantity":{"type":"number"},"dateOfExpiry":{"type":"string","format":"date"},"dateOfManufacture":{"type":"string","format":"date"},"poNumber":{"type":"string"},"statusID":{"$ref":"#/definitions/ABCStatus"},"locationID":{"type":"string"},"tagIDs":{"type":"array","items":{"type":"string"}},"hasUpstreams":{"type":"boolean","enum":[false]},"transactionNotes":{"type":"array","items":{"type":"string"}},"lotNumberLowercase":{"type":"string"}},"required":["lotNumber","materialNumberID","materialCategoryID","productID","quantity","dateOfExpiry","dateOfManufacture","poNumber","statusID","locationID","tagIDs","hasUpstreams","transactionNotes","lotNumberLowercase"],"additionalProperties":false},"ABCInventoryEntryWithUpstreams":{"type":"object","properties":{"lotNumber":{"type":"string"},"materialNumberID":{"type":"string"},"materialCategoryID":{"type":"string"},"productID":{"type":["string","null"]},"quantity":{"type":"number"},"dateOfExpiry":{"type":"string","format":"date"},"dateOfManufacture":{"type":"string","format":"date"},"poNumber":{"type":"string"},"statusID":{"$ref":"#/definitions/ABCStatus"},"locationID":{"type":"string"},"tagIDs":{"type":"array","items":{"type":"string"}},"hasUpstreams":{"type":"boolean","enum":[true]},"upstreamIDs":{"type":"array","items":{"type":"string"}},"upstreamQuantities":{"type":"array","items":{"type":"number"}},"upstreamLotNumbers":{"type":"array","items":{"type":"string"}},"transactionNotes":{"type":"array","items":{"type":"string"}},"lotNumberLowercase":{"type":"string"}},"required":["lotNumber","materialNumberID","materialCategoryID","productID","quantity","dateOfExpiry","dateOfManufacture","poNumber","statusID","locationID","tagIDs","hasUpstreams","upstreamIDs","upstreamQuantities","upstreamLotNumbers","transactionNotes","lotNumberLowercase"],"additionalProperties":false},"ABCInventoryEntry":{"oneOf":[{"$ref":"#/definitions/ABCInventoryEntryWithoutUpstreams"},{"$ref":"#/definitions/ABCInventoryEntryWithUpstreams"}]}},"properties":{"$schema":{"description":"Link to https://www.schemastore.org/abc-inventory-module-data-5.1.0.json","type":"string","enum":["https://www.schemastore.org/abc-inventory-module-data-5.1.0.json"]},"ABCProducts":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"name":{"type":"string"},"isActive":{"type":"boolean"}},"required":["name","isActive"],"additionalProperties":false}},"additionalProperties":false},"ABCVendors":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"name":{"type":"string"},"isActive":{"type":"boolean"}},"required":["name","isActive"],"additionalProperties":false}},"additionalProperties":false},"ABCMaterialCategories":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"name":{"type":"string"},"prefix":{"type":"string"},"isActive":{"type":"boolean"}},"required":["name","isActive","prefix"],"additionalProperties":false}},"additionalProperties":false},"ABCMaterialNumbers":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"productID":{"type":["string","null"]},"vendorID":{"type":["string","null"]},"materialCategoryID":{"type":"string"},"number":{"type":"number"},"name":{"type":"string"},"description":{"type":"string"},"unitOfMeasure":{"type":"string"},"isActive":{"type":"boolean"}},"required":["productID","vendorID","materialCategoryID","number","name","description","unitOfMeasure","isActive"],"additionalProperties":false}},"additionalProperties":false},"ABCLocations":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"name":{"type":"string"},"isActive":{"type":"boolean"}},"required":["name","isActive"],"additionalProperties":false}},"additionalProperties":false},"ABCTags":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"name":{"type":"string"},"isActive":{"type":"boolean"}},"required":["name","isActive"],"additionalProperties":false}},"additionalProperties":false},"ABCReasonCodes":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"isActive":{"type":"boolean"}},"required":["code","description","isActive"],"additionalProperties":false}},"additionalProperties":false},"ABCTransactions":{"type":"array","items":{"$ref":"#/definitions/ABCInventoryTransaction"}},"ABCInventoryEntries":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"$ref":"#/definitions/ABCInventoryEntry"}},"additionalProperties":false}},"required":["$schema","ABCProducts","ABCVendors","ABCMaterialCategories","ABCMaterialNumbers","ABCLocations","ABCTags","ABCReasonCodes","ABCTransactions","ABCInventoryEntries"],"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "ABCInventoryModuleData JSON Schema". Here are the required top‑level fields: $schema, ABCProducts, ABCVendors, ABCMaterialCategories, ABCMaterialNumbers, ABCLocations, ABCTags, ABCReasonCodes, ABCTransactions, ABCInventoryEntries. Return only the valid JSON object.
|
ABCInventoryModuleData JSON Schema
|
schema-store
|
schema_store_19
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/abc-supply-plan-10.0.0.json\",\"title\":\"ABCSupplyPlan JSON Schema\",\"description\":\"Schema defining the structure of ABCSupplyPlan used for managing plan data in ABC-Plan's MasterPlanner.\",\"properties\":{\"$schema\":{\"description\":\"Link to https://json.schemastore.org/abc-supply-plan-10.0.0.json\",\"type\":\"string\",\"enum\":[\"https://json.schemastore.org/abc-supply-plan-10.0.0.json\"]},\"planDate\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Plan Date\",\"description\":\"The start date for the plan. Format: first day of a month.\",\"abcIsFirstDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true},\"planNotes\":{\"type\":\"string\",\"format\":\"abc-draft-js_RawDraftContentState\",\"title\":\"Plan Notes\",\"description\":\"Notes or comments about the plan in a specified format. Since there is no JSON Schema for draft-js, the underlying component for mui-rte, format abc-draft-js_RawDraftContentState is enforced by calling https://draftjs.org/docs/api-reference-data-conversion/#convertfromraw. see also: https://github.com/facebookarchive/draft-js/issues/2071 and https://github.com/facebookarchive/draft-js/issues/1544\"},\"analytics\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"title\":\"Analytics Item\",\"description\":\"An analytics item that can be either a time series or an analytics note\",\"oneOf\":[{\"type\":\"object\",\"title\":\"Time Series\",\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\",\"enum\":[\"TIME_SERIES\"]},\"subtitle\":{\"type\":\"string\"},\"excludeMonthsFromBeginning\":{\"type\":\"number\",\"description\":\"Number of months to exclude from the beginning of the time series. Positive values trim, negative values add months before the plan start date.\"},\"excludeMonthsFromEnd\":{\"type\":\"number\",\"description\":\"Number of months to exclude from the end of the time series. Positive values trim, negative values add months after the plan end date.\"},\"timeAggregateType\":{\"type\":\"string\",\"enum\":[\"Annual\",\"Quarterly\",\"Monthly\"],\"title\":\"Time Aggregate Type\",\"description\":\"The aggregation level for time series data display\"},\"metrics\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"metricType\":{\"type\":\"string\",\"enum\":[\"demand\",\"demandDetail\",\"actuals\",\"otherDemand\",\"firmOrders\",\"plannedOrders\",\"firmRelease\",\"plannedRelease\",\"expiryAdjustments\",\"inventory\",\"mfc\"]},\"abcMaterialIDs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"visualization\":{\"type\":\"object\",\"oneOf\":[{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"line\"]},\"strokeWidth\":{\"type\":\"number\"},\"strokeDasharray\":{\"type\":\"string\"},\"dotSize\":{\"type\":\"number\",\"minimum\":0},\"dotFill\":{\"type\":\"string\"}},\"required\":[\"type\",\"strokeWidth\",\"strokeDasharray\",\"dotSize\",\"dotFill\"],\"additionalProperties\":false},{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"bar\"]},\"barWidth\":{\"type\":\"number\"},\"radius\":{\"type\":\"number\"},\"stackId\":{\"type\":\"string\"},\"showAsPercent\":{\"type\":\"boolean\"}},\"required\":[\"type\",\"barWidth\",\"radius\",\"stackId\",\"showAsPercent\"],\"additionalProperties\":false},{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"area\"]},\"fillOpacity\":{\"type\":\"number\"},\"strokeWidth\":{\"type\":\"number\"},\"stackId\":{\"type\":\"string\"},\"showAsPercent\":{\"type\":\"boolean\"}},\"required\":[\"type\",\"fillOpacity\",\"strokeWidth\",\"stackId\",\"showAsPercent\"],\"additionalProperties\":false}]},\"yAxisIndex\":{\"type\":\"number\"},\"color\":{\"type\":\"string\"},\"zIndex\":{\"type\":\"number\"},\"label\":{\"type\":\"string\"},\"showQuantitiesAs\":{\"type\":[\"string\",\"null\"],\"oneOf\":[{\"type\":\"string\",\"enum\":[\"Units\",\"Lots\",\"Monetary\"]},{\"type\":\"null\"}],\"title\":\"Show Quantities As\",\"description\":\"How to display the quantities for this metric\"},\"comparisonPlanID\":{\"type\":[\"string\",\"null\"],\"title\":\"Comparison Plan ID\",\"description\":\"The ID of the comparison plan to use for this metric or null if no comparison plan is used\"}},\"required\":[\"metricType\",\"abcMaterialIDs\",\"visualization\",\"yAxisIndex\",\"color\",\"zIndex\",\"label\",\"showQuantitiesAs\",\"comparisonPlanID\"],\"allOf\":[{\"if\":{\"properties\":{\"metricType\":{\"const\":\"mfc\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"type\":\"null\"}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"otherDemand\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"type\":\"null\"}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"moh\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"type\":\"null\"}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"capacityUtilization\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"type\":\"null\"}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"demand\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"enum\":[\"Units\",\"Monetary\"]}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"actuals\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"enum\":[\"Units\",\"Monetary\"]}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"firmRelease\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"enum\":[\"Units\",\"Lots\"]}}}},{\"if\":{\"properties\":{\"metricType\":{\"const\":\"plannedRelease\"}}},\"then\":{\"properties\":{\"showQuantitiesAs\":{\"enum\":[\"Units\",\"Lots\"]}}}}],\"additionalProperties\":false}}},\"required\":[\"id\",\"name\",\"type\",\"subtitle\",\"excludeMonthsFromBeginning\",\"excludeMonthsFromEnd\",\"timeAggregateType\",\"metrics\"],\"additionalProperties\":false},{\"type\":\"object\",\"title\":\"Analytics Note Item\",\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\",\"enum\":[\"ANALYTICS_NOTE\"]},\"subtitle\":{\"type\":\"string\"},\"backgroundColor\":{\"type\":\"string\"},\"imageUrl\":{\"type\":\"string\"},\"text\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"string\"},\"fontFamily\":{\"type\":\"string\"},\"fontSize\":{\"type\":\"number\"},\"color\":{\"type\":\"string\"},\"horizontalAlignment\":{\"type\":\"string\",\"enum\":[\"left\",\"center\",\"right\"]},\"verticalAlignment\":{\"type\":\"string\",\"enum\":[\"top\",\"center\",\"bottom\"]}},\"required\":[\"content\",\"fontFamily\",\"fontSize\",\"color\",\"horizontalAlignment\",\"verticalAlignment\"],\"additionalProperties\":false}},\"required\":[\"id\",\"name\",\"type\",\"subtitle\",\"text\"],\"additionalProperties\":false}]}},\"layouts\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"contentId\":{\"type\":\"string\"},\"x\":{\"type\":\"number\",\"minimum\":0,\"maximum\":11,\"description\":\"Grid column position (0-11 for 12-column grid)\"},\"y\":{\"type\":\"number\",\"minimum\":0,\"description\":\"Grid row position\"},\"tabID\":{\"type\":\"string\",\"description\":\"ID of the tab this layout item belongs to\"},\"w\":{\"type\":\"number\",\"minimum\":1,\"maximum\":12,\"description\":\"Width in grid units (1-12)\"},\"h\":{\"type\":\"number\",\"minimum\":1,\"description\":\"Height in grid units\"},\"minH\":{\"type\":\"number\",\"minimum\":1,\"description\":\"Minimum height in grid units\"},\"maxH\":{\"type\":\"number\",\"minimum\":1,\"description\":\"Maximum height in grid units\"},\"minW\":{\"type\":\"number\",\"minimum\":1,\"description\":\"Minimum width in grid units\"},\"maxW\":{\"type\":\"number\",\"minimum\":1,\"description\":\"Maximum width in grid units\"},\"isDraggable\":{\"type\":\"boolean\",\"description\":\"Whether the item can be dragged\"},\"isResizable\":{\"type\":\"boolean\",\"description\":\"Whether the item can be resized\"}},\"required\":[\"contentId\",\"x\",\"y\",\"w\",\"h\"],\"additionalProperties\":false}},\"tabs\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"ordering\":{\"type\":\"number\"}},\"required\":[\"id\",\"name\",\"ordering\"],\"additionalProperties\":false}}},\"required\":[\"items\",\"layouts\",\"tabs\"],\"additionalProperties\":false},\"abcMaterialsMap\":{\"type\":\"object\",\"patternProperties\":{\"^\\\\d+$\":{\"$ref\":\"#/definitions/ABCMaterialState\"}},\"additionalProperties\":false,\"title\":\"ABC Materials Map\",\"description\":\"A mapping of material IDs to their respective states within the ABC system.\",\"abcNoDuplicateValuesForOrderingProperty\":true},\"recipeMap\":{\"type\":\"object\",\"patternProperties\":{\"^\\\\d+-\\\\d+$\":{\"$ref\":\"#/definitions/RecipeState\"}},\"additionalProperties\":false,\"title\":\"Recipe Map\",\"description\":\"A mapping of recipes, representing the acyclic relationships among materials. abcAreAllocationMethodsHomogeneous requires no mixing of Allocation Methods. A downstream material cannot have mixed upstream recipes. An upstream material cannot have mixed downstream recipes.\",\"abcDoMaterialIDsExist\":true,\"abcIsAcyclic\":true,\"abcAreAllocationMethodsHomogeneous\":true}},\"required\":[\"$schema\",\"planDate\",\"planNotes\",\"analytics\",\"abcMaterialsMap\",\"recipeMap\"],\"additionalProperties\":false,\"type\":\"object\",\"definitions\":{\"ABCMaterialState\":{\"type\":\"object\",\"title\":\"ABC Material State\",\"description\":\"Represents the state of a material in the system including its attributes and planning parameters.\",\"abcDemandDetailsMatchDemandRows\":true,\"properties\":{\"x\":{\"type\":\"number\",\"title\":\"X Coordinate\",\"description\":\"The X coordinate position of the material in a graphical representation.\"},\"y\":{\"type\":\"number\",\"title\":\"Y Coordinate\",\"description\":\"The Y coordinate position of the material in a graphical representation.\"},\"ordering\":{\"type\":\"number\",\"title\":\"Ordering\",\"description\":\"Numeric value representing the order or sequence of the material.\"},\"abcMaterialName\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Material Name\",\"description\":\"The name of the material.\"},\"uom\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Unit of Measure\",\"description\":\"The unit of measure used for the material.\"},\"materialShape\":{\"type\":\"string\",\"enum\":[\"circle\",\"square\",\"diamond\",\"rectangle\",\"parallelogram\",\"trapezoid\",\"triangle\",\"pentagon\",\"hexagon\"],\"title\":\"Material Shape\",\"description\":\"The shape of the material represented graphically.\"},\"materialColor\":{\"$ref\":\"#/definitions/Color\"},\"doExpiryCarryover\":{\"type\":\"boolean\",\"title\":\"Expiry Carryover\",\"description\":\"Indicates whether to carry over the expiry information for the material.\"},\"isCapacityConstraintNode\":{\"type\":\"boolean\",\"title\":\"Capacity Constraint Node\",\"description\":\"Determines if the material is a node where capacity constraints are applied.\"},\"inventoryMethod\":{\"type\":\"string\",\"enum\":[\"TargetMFC\",\"MinimumInventory\"],\"title\":\"Inventory Method\",\"description\":\"The method used for managing inventory levels, either target months forward coverage or minimum inventory.\"},\"decimalPrecision\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":5,\"title\":\"Decimal Precision\",\"description\":\"The precision of decimal places allowed for numerical entries related to the material.\"},\"currency\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Currency\",\"description\":\"The currency used for monetary calculations of the material.\"},\"manufacturingCost\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Manufacturing Cost\",\"description\":\"The direct manufacturing cost per unit of the material.\"},\"standardCost\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Standard Cost\",\"description\":\"The standard cost per unit including overhead of the material.\"},\"salesPrice\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Sales Price\",\"description\":\"The sales price per unit of the material.\"},\"lotSize\":{\"$comment\":\"Require integer until we fix https://gitlab.com/abc-plan/abc-plan-server/-/issues/9\",\"type\":\"integer\",\"minimum\":1,\"title\":\"Lot Size\",\"description\":\"Batch size for orders. Must be greater than 0 to plan, etc.\"},\"leadTime\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Lead Time\",\"description\":\"Delay between Manufacture Date and Release Date. Format: non-negative integer.\"},\"firmingPeriod\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Firming Period\",\"description\":\"Time during which no Planned Orders are allowed. Format: non-negative integer.\"},\"targetMFCs\":{\"$ref\":\"#/definitions/NonNegativeIntegerTimeDependentValues\",\"title\":\"Target MFC\",\"description\":\"Target Months Forward Coverage refers to a dynamic safety stock level\\u2014a buffer quantity of inventory designed to mitigate the risk of stock-outs caused by variability in Demand. In essence, it represents the number of months of Demand that could be satisfied assuming no additional material is manufactured. Each value is defined for a specific period of time.\"},\"minimumInventories\":{\"$ref\":\"#/definitions/NonNegativeIntegerTimeDependentValues\",\"title\":\"Minimum Inventory\",\"description\":\"List of Minimum Inventory values, each defined for a specific period of time. Minimum Inventory denotes the lowest stock level to prevent outages, triggering restock.\"},\"planningFrequencies\":{\"$ref\":\"#/definitions/PositiveIntegerTimeDependentValues\",\"title\":\"Planning Frequencies\",\"description\":\"List of Planning Frequency values, each defined for a specific period of time.\"},\"shelfLives\":{\"$ref\":\"#/definitions/NonNegativeIntegerTimeDependentValues\",\"title\":\"Shelf Lives\",\"description\":\"List of Shelf Life values, each defined for a specific period of time.\"},\"stopshipBuffers\":{\"$ref\":\"#/definitions/NonNegativeIntegerTimeDependentValues\",\"title\":\"Stopship Buffers\",\"description\":\"Buffers to account for Stopship scenarios, listed for different periods.\"},\"initialInventories\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/InitialInventory\"},\"title\":\"Initial Inventories\",\"description\":\"List of Initial Inventory records, each associated with specific lot and dates.\"},\"firmOrders\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/FirmOrder\"},\"title\":\"Firm Orders\",\"description\":\"List of Firm Orders with their respective quantities and dates.\"},\"demand\":{\"$ref\":\"#/definitions/PositiveDateMapMap\",\"title\":\"Demand\",\"description\":\"Map of demand rows, where each key is a unique ID and value is a DateMap containing demand values for specific dates.\"},\"demandDetails\":{\"$ref\":\"#/definitions/ABCDemandDetailsMap\",\"title\":\"Demand Details\",\"description\":\"Mapping of demand row IDs to their metadata including labels and ordering.\"},\"otherDemand\":{\"$ref\":\"#/definitions/PositiveDateMap\",\"title\":\"Other Demand\",\"description\":\"Map of other types of demand not included in the primary demand values.\"},\"otherDemandAnnotation\":{\"$ref\":\"#/definitions/AnnotationMap\",\"title\":\"Other Demand Annotation\",\"description\":\"Annotations related to other demand entries, providing additional context.\"},\"actuals\":{\"$ref\":\"#/definitions/PositiveDateMap\",\"title\":\"Actuals\",\"description\":\"Map of actual quantities, corresponding to real data collected.\"},\"plannedOrders\":{\"$ref\":\"#/definitions/PositiveDateMap\",\"title\":\"Planned Orders\",\"description\":\"Map of planned order quantities, anticipated ahead of time.\"},\"expiryAdjustments\":{\"$ref\":\"#/definitions/NegativeDateMap\",\"title\":\"Expiry Adjustments\",\"description\":\"Adjustments made to account for expired materials, reducing quantities.\"},\"timeAggregateType\":{\"type\":\"string\",\"enum\":[\"Annual\",\"Quarterly\",\"Monthly\"],\"title\":\"Time Aggregate Type\",\"description\":\"The aggregation level for planning and reporting, e.g., annual, quarterly, or monthly.\"},\"showQuantitiesAs\":{\"type\":\"string\",\"enum\":[\"Units\",\"Lots\",\"Monetary\"],\"title\":\"Show Quantities As\",\"description\":\"Defines how quantities are represented, e.g., in units, lots, or monetary value.\"},\"expiryAnalysisType\":{\"type\":\"string\",\"enum\":[\"Expiration\",\"Stopship\"],\"title\":\"Expiry Analysis Type\",\"description\":\"Determines the type of analysis to be performed on expiry data, focusing on expiration or stopship scenarios.\"},\"timeDependentPlanningParameters\":{\"type\":\"boolean\",\"title\":\"Time Dependent Planning Parameters\",\"description\":\"Indicates whether planning parameters are dependent on time, necessitating different values at different periods.\"},\"inventorySystemMaterialNumber\":{\"title\":\"Material Number in the inventory management system\",\"description\":\"For pulling inventory from the inventory management system into Initial Inventory and Firm Orders & Releases\",\"type\":[\"string\",\"null\"]},\"inventorySystemLocationName\":{\"title\":\"Location in the inventory management system\",\"description\":\"For pulling inventory from the inventory management system into Initial Inventory and Firm Orders & Releases and filtering it by location\",\"type\":[\"string\",\"null\"]}},\"required\":[\"x\",\"y\",\"ordering\",\"abcMaterialName\",\"uom\",\"materialShape\",\"materialColor\",\"doExpiryCarryover\",\"isCapacityConstraintNode\",\"inventoryMethod\",\"decimalPrecision\",\"currency\",\"manufacturingCost\",\"standardCost\",\"salesPrice\",\"lotSize\",\"leadTime\",\"firmingPeriod\",\"targetMFCs\",\"minimumInventories\",\"planningFrequencies\",\"shelfLives\",\"stopshipBuffers\",\"initialInventories\",\"firmOrders\",\"demand\",\"demandDetails\",\"actuals\",\"expiryAdjustments\",\"otherDemand\",\"otherDemandAnnotation\",\"plannedOrders\",\"timeAggregateType\",\"showQuantitiesAs\",\"expiryAnalysisType\",\"timeDependentPlanningParameters\",\"inventorySystemMaterialNumber\",\"inventorySystemLocationName\"],\"additionalProperties\":false,\"allOf\":[{\"if\":{\"properties\":{\"timeDependentPlanningParameters\":{\"const\":false}}},\"then\":{\"properties\":{\"targetMFCs\":{\"type\":\"array\",\"maxItems\":1,\"minItems\":1},\"minimumInventories\":{\"type\":\"array\",\"maxItems\":1,\"minItems\":1},\"planningFrequencies\":{\"type\":\"array\",\"maxItems\":1,\"minItems\":1},\"shelfLives\":{\"type\":\"array\",\"maxItems\":1,\"minItems\":1},\"stopshipBuffers\":{\"type\":\"array\",\"maxItems\":1,\"minItems\":1}}}},{\"if\":{\"properties\":{\"timeDependentPlanningParameters\":{\"const\":true}}},\"then\":{\"properties\":{\"targetMFCs\":{\"type\":\"array\",\"minItems\":1},\"minimumInventories\":{\"type\":\"array\",\"minItems\":1},\"planningFrequencies\":{\"type\":\"array\",\"minItems\":1},\"shelfLives\":{\"type\":\"array\",\"minItems\":1},\"stopshipBuffers\":{\"type\":\"array\",\"minItems\":1}}}}]},\"RecipeState\":{\"type\":\"object\",\"title\":\"Recipe State\",\"description\":\"Defines a recipe within the system, including its components and yields.\",\"properties\":{\"recipe\":{\"type\":\"number\",\"exclusiveMinimum\":0,\"title\":\"Recipe ID\",\"description\":\"Unique identifier of the recipe.\"},\"allocationMethod\":{\"type\":\"string\",\"enum\":[\"PercentAllocation\",\"PriorityAllocation\"],\"title\":\"Consumption Allocation\",\"description\":\"Method for allocating downstream consumption to upstream materials.\"},\"percentAllocations\":{\"$ref\":\"#/definitions/PercentTimeDependentValues\",\"title\":\"Percent Allocations\",\"description\":\"Percentage allocations of materials to the recipe over different periods.\"},\"priorityAllocations\":{\"$ref\":\"#/definitions/NonNegativeNumberTimeDependentValues\",\"title\":\"Priority Allocations\",\"description\":\"Priority allocations of materials to the recipe over different periods.\"},\"percentYield\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Percent Yield\",\"description\":\"The yield percentage of the recipe, indicating efficiency.\"}},\"required\":[\"recipe\",\"allocationMethod\",\"percentAllocations\",\"priorityAllocations\",\"percentYield\"],\"additionalProperties\":false},\"PositiveDateMap\":{\"type\":\"object\",\"title\":\"Positive Date Map\",\"description\":\"Mapping of dates to positive numerical values, typically representing demand or supply quantities.\",\"patternProperties\":{\"^\\\\d{4}-(0[1-9]|1[0-2])-01$\":{\"type\":\"number\",\"minimum\":0}},\"additionalProperties\":false},\"PositiveDateMapMap\":{\"type\":\"object\",\"title\":\"Positive Date Map Map\",\"description\":\"Mapping of unique IDs to date maps, supporting multiple demand rows per material.\",\"patternProperties\":{\"^.*$\":{\"$ref\":\"#/definitions/PositiveDateMap\"}},\"additionalProperties\":false},\"NegativeDateMap\":{\"type\":\"object\",\"title\":\"Negative Date Map\",\"description\":\"Mapping of dates to negative numerical values, typically representing adjustments or reductions.\",\"patternProperties\":{\"^\\\\d{4}-(0[1-9]|1[0-2])-01$\":{\"type\":\"number\",\"maximum\":0}},\"additionalProperties\":false},\"AnnotationMap\":{\"type\":\"object\",\"title\":\"Annotation Map\",\"description\":\"Mapping of dates to annotations or notes about specific entries.\",\"patternProperties\":{\"^\\\\d{4}-(0[1-9]|1[0-2])-01$\":{\"type\":\"string\"}},\"additionalProperties\":false},\"Color\":{\"type\":\"string\",\"title\":\"Color\",\"description\":\"Colors may be specified in any string-based format supported by the Color constructor documented at https://www.npmjs.com/package/color\",\"abcIsValidColor\":\"true\"},\"ABCDemandDetailsMap\":{\"type\":\"object\",\"title\":\"ABC Demand Details Map\",\"description\":\"Mapping of demand row IDs to their metadata including label and ordering.\",\"patternProperties\":{\"^.*$\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\",\"title\":\"Label\",\"description\":\"User-visible label for the demand row.\"},\"ordering\":{\"type\":\"number\",\"title\":\"Ordering\",\"description\":\"Display order of the demand row within a material.\"}},\"required\":[\"label\",\"ordering\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"TemplateTimeDependentValue\":{\"$comment\":\"additionalProperties is true because this object acts as a template and is merged with other type definitions to specify valid date ranges for time-dependent values.\",\"type\":\"object\",\"title\":\"Template Time Dependent Value\",\"description\":\"Base template for defining time-dependent values, specifying the valid date ranges for such values.\",\"properties\":{\"startDate\":{\"title\":\"Start Date\",\"description\":\"The start date for the time-dependent value. Must be the first day of a month and within a valid date range.\",\"oneOf\":[{\"type\":\"string\",\"format\":\"date\",\"abcIsFirstDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true},{\"type\":\"null\"}]},\"endDate\":{\"title\":\"End Date\",\"description\":\"The end date for the time-dependent value. Must be the last day of a month and within a valid date range.\",\"oneOf\":[{\"type\":\"string\",\"format\":\"date\",\"abcIsLastDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true},{\"type\":\"null\"}]}},\"required\":[\"startDate\",\"endDate\"],\"additionalProperties\":true},\"PercentValueConstraints\":{\"$comment\":\"additionalProperties is true because it is a template and gets merged with other types\",\"type\":\"object\",\"title\":\"Percent Value Constraints\",\"description\":\"Constraints for percentage values, defining the valid range as 0% to 100%.\",\"properties\":{\"timeDependentValue\":{\"description\":\"During a particular period of time for this recipe, how much of the downstream consumption is allocated to the upstream material. Format: 0-1 which correspond to 0%-100%.\",\"type\":\"number\",\"minimum\":0,\"maximum\":1}},\"required\":[\"timeDependentValue\"],\"additionalProperties\":true},\"PercentTimeDependentValue\":{\"allOf\":[{\"$ref\":\"#/definitions/TemplateTimeDependentValue\"},{\"$ref\":\"#/definitions/PercentValueConstraints\"}],\"title\":\"Percent Time Dependent Value\",\"description\":\"Defines a time-specific percentage value within a valid date range, adhering to percentage constraints.\"},\"PercentTimeDependentValues\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/PercentTimeDependentValue\"},\"title\":\"Percent Time Dependent Values\",\"description\":\"Array of time-dependent percentage values, each specifying the allocation for a given period.\",\"abcHasNonOverlappingTimeDependentValues\":\"true\",\"abcHasUninterruptedTimeDependentValues\":\"true\"},\"NonNegativeIntegerConstraints\":{\"$comment\":\"additionalProperties is true because this object acts as a template and is merged with other type definitions to enforce non-negative integer constraints in various scenarios.\",\"type\":\"object\",\"title\":\"Non-Negative Integer Constraints\",\"description\":\"Defines constraints for integer values to ensure they are non-negative, used in various time-dependent value configurations.\",\"properties\":{\"timeDependentValue\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Time Dependent Value\",\"description\":\"An integer value that cannot be negative, typically representing quantities or counts in a time-dependent context.\"}},\"required\":[\"timeDependentValue\"],\"additionalProperties\":true},\"NonNegativeIntegerTimeDependentValue\":{\"allOf\":[{\"$ref\":\"#/definitions/TemplateTimeDependentValue\"},{\"$ref\":\"#/definitions/NonNegativeIntegerConstraints\"}],\"title\":\"Non-Negative Integer Time Dependent Value\",\"description\":\"Defines a time-specific integer value within a valid date range, ensuring it is non-negative.\"},\"NonNegativeIntegerTimeDependentValues\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/NonNegativeIntegerTimeDependentValue\"},\"title\":\"Non-Negative Integer Time Dependent Values\",\"description\":\"Array of time-dependent integer values, ensuring each is non-negative.\",\"abcHasNonOverlappingTimeDependentValues\":\"true\",\"abcHasUninterruptedTimeDependentValues\":\"true\"},\"NonNegativeNumberConstraints\":{\"$comment\":\"additionalProperties is true to allow merging this object with other type definitions to enforce non-negative number constraints in various scenarios.\",\"type\":\"object\",\"title\":\"Non-Negative Number Constraints\",\"description\":\"Defines constraints for numbers to ensure they are non-negative, used in various contexts.\",\"properties\":{\"timeDependentValue\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Non-Negative Number\",\"description\":\"A non-negative number, used in various contexts to represent quantities or counts.\"}},\"required\":[\"timeDependentValue\"],\"additionalProperties\":true},\"NonNegativeNumberTimeDependentValue\":{\"allOf\":[{\"$ref\":\"#/definitions/TemplateTimeDependentValue\"},{\"$ref\":\"#/definitions/NonNegativeNumberConstraints\"}],\"title\":\"Non-Negative Number Time Dependent Value\",\"description\":\"Defines a time-specific number within a valid range, ensuring it is non-negative.\"},\"NonNegativeNumberTimeDependentValues\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/NonNegativeNumberTimeDependentValue\"},\"title\":\"Non-Negative Number Time Dependent Values\",\"description\":\"Array of time-dependent non-negative numbers.\",\"abcHasNonOverlappingTimeDependentValues\":\"true\",\"abcHasUninterruptedTimeDependentValues\":\"true\"},\"PositiveIntegerConstraints\":{\"$comment\":\"additionalProperties is set to true because this object acts as a template and is merged with other type definitions to enforce positive integer constraints in various scenarios.\",\"type\":\"object\",\"title\":\"Positive Integer Constraints\",\"description\":\"Defines constraints for integer values to ensure they are positive, used in various configurations where a strictly positive value is required.\",\"properties\":{\"timeDependentValue\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"Time Dependent Value\",\"description\":\"An integer value that must be positive, typically representing quantities or counts in contexts where zero is not a valid value.\"}},\"required\":[\"timeDependentValue\"],\"additionalProperties\":true},\"PositiveIntegerTimeDependentValue\":{\"allOf\":[{\"$ref\":\"#/definitions/TemplateTimeDependentValue\"},{\"$ref\":\"#/definitions/PositiveIntegerConstraints\"}],\"title\":\"Positive Integer Time Dependent Value\",\"description\":\"Defines a time-specific integer value that must always be positive, ensuring it meets the requirements of scenarios where zero or negative numbers are not permitted.\"},\"PositiveIntegerTimeDependentValues\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/PositiveIntegerTimeDependentValue\"},\"title\":\"Positive Integer Time Dependent Values\",\"description\":\"Array of time-dependent integer values, ensuring each is positive. This setup is intended for scenarios where values must always be greater than zero.\",\"abcHasNonOverlappingTimeDependentValues\":\"true\",\"abcHasUninterruptedTimeDependentValues\":\"true\"},\"InitialInventory\":{\"type\":\"object\",\"title\":\"Initial Inventory\",\"description\":\"Defines the initial inventory of a material, including lot number and associated dates.\",\"properties\":{\"lotNumber\":{\"type\":\"string\",\"minLength\":1,\"title\":\"Lot Number\",\"description\":\"The identifier for the lot number of the inventory item. It must be at least 1 character in length.\"},\"initialInventoryQuantity\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Initial Inventory Quantity\",\"description\":\"The quantity of the inventory item when first recorded. This must be a non-negative number.\"},\"manufactureDate\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Manufacture Date\",\"description\":\"The date the item was manufactured. This date must be the first day of a month and fall within a valid date range.\",\"abcIsFirstDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true},\"expirationDate\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Expiration Date\",\"description\":\"The date the item will expire. This date must be the last day of a month and fall within a valid date range.\",\"abcIsLastDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true,\"abcIsExpirationDateOnOrAfterManufactureDate\":true}},\"required\":[\"lotNumber\",\"initialInventoryQuantity\",\"manufactureDate\",\"expirationDate\"],\"additionalProperties\":false},\"FirmOrder\":{\"type\":\"object\",\"title\":\"Firm Order\",\"description\":\"Defines a firm order within the system, including order details and relevant dates.\",\"properties\":{\"firmOrderName\":{\"type\":\"string\",\"title\":\"Firm Order Name\",\"description\":\"The name or identifier of the firm order.\"},\"firmOrderQuantity\":{\"type\":\"number\",\"minimum\":0,\"title\":\"Firm Order Quantity\",\"description\":\"The quantity specified in the firm order. Must be a non-negative value.\"},\"manufactureDate\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Manufacture Date\",\"description\":\"The date the goods are scheduled to be manufactured. Must be the first day of the month and within valid date range.\",\"abcIsFirstDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true},\"releaseDate\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Release Date\",\"description\":\"The date the goods are scheduled to be released. Must be the first day of the month and within valid date range.\",\"abcIsFirstDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true,\"abcIsReleaseDateOnOrAfterPlanDate\":true,\"abcIsReleaseDateOnOrAfterManufactureDate\":true},\"expirationDate\":{\"type\":\"string\",\"format\":\"date\",\"title\":\"Expiration Date\",\"description\":\"The expiration date of the product. Must be the last day of the month and within valid date range.\",\"abcIsLastDayOfMonth\":true,\"abcIsAfter0001-01-01\":true,\"abcIsBefore9999-12-31\":true,\"abcIsExpirationDateOnOrAfterReleaseDate\":true}},\"required\":[\"firmOrderName\",\"firmOrderQuantity\",\"manufactureDate\",\"releaseDate\",\"expirationDate\"],\"additionalProperties\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ABCSupplyPlan JSON Schema\". Here are the required top‑level fields: $schema, planDate, planNotes, analytics, abcMaterialsMap, recipeMap. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/abc-supply-plan-10.0.0.json","title":"ABCSupplyPlan JSON Schema","description":"Schema defining the structure of ABCSupplyPlan used for managing plan data in ABC-Plan's MasterPlanner.","properties":{"$schema":{"description":"Link to https://json.schemastore.org/abc-supply-plan-10.0.0.json","type":"string","enum":["https://json.schemastore.org/abc-supply-plan-10.0.0.json"]},"planDate":{"type":"string","format":"date","title":"Plan Date","description":"The start date for the plan. Format: first day of a month.","abcIsFirstDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true},"planNotes":{"type":"string","format":"abc-draft-js_RawDraftContentState","title":"Plan Notes","description":"Notes or comments about the plan in a specified format. Since there is no JSON Schema for draft-js, the underlying component for mui-rte, format abc-draft-js_RawDraftContentState is enforced by calling https://draftjs.org/docs/api-reference-data-conversion/#convertfromraw. see also: https://github.com/facebookarchive/draft-js/issues/2071 and https://github.com/facebookarchive/draft-js/issues/1544"},"analytics":{"type":"object","properties":{"items":{"type":"array","items":{"title":"Analytics Item","description":"An analytics item that can be either a time series or an analytics note","oneOf":[{"type":"object","title":"Time Series","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["TIME_SERIES"]},"subtitle":{"type":"string"},"excludeMonthsFromBeginning":{"type":"number","description":"Number of months to exclude from the beginning of the time series. Positive values trim, negative values add months before the plan start date."},"excludeMonthsFromEnd":{"type":"number","description":"Number of months to exclude from the end of the time series. Positive values trim, negative values add months after the plan end date."},"timeAggregateType":{"type":"string","enum":["Annual","Quarterly","Monthly"],"title":"Time Aggregate Type","description":"The aggregation level for time series data display"},"metrics":{"type":"array","items":{"type":"object","properties":{"metricType":{"type":"string","enum":["demand","demandDetail","actuals","otherDemand","firmOrders","plannedOrders","firmRelease","plannedRelease","expiryAdjustments","inventory","mfc"]},"abcMaterialIDs":{"type":"array","items":{"type":"string"}},"visualization":{"type":"object","oneOf":[{"properties":{"type":{"type":"string","enum":["line"]},"strokeWidth":{"type":"number"},"strokeDasharray":{"type":"string"},"dotSize":{"type":"number","minimum":0},"dotFill":{"type":"string"}},"required":["type","strokeWidth","strokeDasharray","dotSize","dotFill"],"additionalProperties":false},{"properties":{"type":{"type":"string","enum":["bar"]},"barWidth":{"type":"number"},"radius":{"type":"number"},"stackId":{"type":"string"},"showAsPercent":{"type":"boolean"}},"required":["type","barWidth","radius","stackId","showAsPercent"],"additionalProperties":false},{"properties":{"type":{"type":"string","enum":["area"]},"fillOpacity":{"type":"number"},"strokeWidth":{"type":"number"},"stackId":{"type":"string"},"showAsPercent":{"type":"boolean"}},"required":["type","fillOpacity","strokeWidth","stackId","showAsPercent"],"additionalProperties":false}]},"yAxisIndex":{"type":"number"},"color":{"type":"string"},"zIndex":{"type":"number"},"label":{"type":"string"},"showQuantitiesAs":{"type":["string","null"],"oneOf":[{"type":"string","enum":["Units","Lots","Monetary"]},{"type":"null"}],"title":"Show Quantities As","description":"How to display the quantities for this metric"},"comparisonPlanID":{"type":["string","null"],"title":"Comparison Plan ID","description":"The ID of the comparison plan to use for this metric or null if no comparison plan is used"}},"required":["metricType","abcMaterialIDs","visualization","yAxisIndex","color","zIndex","label","showQuantitiesAs","comparisonPlanID"],"allOf":[{"if":{"properties":{"metricType":{"const":"mfc"}}},"then":{"properties":{"showQuantitiesAs":{"type":"null"}}}},{"if":{"properties":{"metricType":{"const":"otherDemand"}}},"then":{"properties":{"showQuantitiesAs":{"type":"null"}}}},{"if":{"properties":{"metricType":{"const":"moh"}}},"then":{"properties":{"showQuantitiesAs":{"type":"null"}}}},{"if":{"properties":{"metricType":{"const":"capacityUtilization"}}},"then":{"properties":{"showQuantitiesAs":{"type":"null"}}}},{"if":{"properties":{"metricType":{"const":"demand"}}},"then":{"properties":{"showQuantitiesAs":{"enum":["Units","Monetary"]}}}},{"if":{"properties":{"metricType":{"const":"actuals"}}},"then":{"properties":{"showQuantitiesAs":{"enum":["Units","Monetary"]}}}},{"if":{"properties":{"metricType":{"const":"firmRelease"}}},"then":{"properties":{"showQuantitiesAs":{"enum":["Units","Lots"]}}}},{"if":{"properties":{"metricType":{"const":"plannedRelease"}}},"then":{"properties":{"showQuantitiesAs":{"enum":["Units","Lots"]}}}}],"additionalProperties":false}}},"required":["id","name","type","subtitle","excludeMonthsFromBeginning","excludeMonthsFromEnd","timeAggregateType","metrics"],"additionalProperties":false},{"type":"object","title":"Analytics Note Item","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["ANALYTICS_NOTE"]},"subtitle":{"type":"string"},"backgroundColor":{"type":"string"},"imageUrl":{"type":"string"},"text":{"type":"object","properties":{"content":{"type":"string"},"fontFamily":{"type":"string"},"fontSize":{"type":"number"},"color":{"type":"string"},"horizontalAlignment":{"type":"string","enum":["left","center","right"]},"verticalAlignment":{"type":"string","enum":["top","center","bottom"]}},"required":["content","fontFamily","fontSize","color","horizontalAlignment","verticalAlignment"],"additionalProperties":false}},"required":["id","name","type","subtitle","text"],"additionalProperties":false}]}},"layouts":{"type":"array","items":{"type":"object","properties":{"contentId":{"type":"string"},"x":{"type":"number","minimum":0,"maximum":11,"description":"Grid column position (0-11 for 12-column grid)"},"y":{"type":"number","minimum":0,"description":"Grid row position"},"tabID":{"type":"string","description":"ID of the tab this layout item belongs to"},"w":{"type":"number","minimum":1,"maximum":12,"description":"Width in grid units (1-12)"},"h":{"type":"number","minimum":1,"description":"Height in grid units"},"minH":{"type":"number","minimum":1,"description":"Minimum height in grid units"},"maxH":{"type":"number","minimum":1,"description":"Maximum height in grid units"},"minW":{"type":"number","minimum":1,"description":"Minimum width in grid units"},"maxW":{"type":"number","minimum":1,"description":"Maximum width in grid units"},"isDraggable":{"type":"boolean","description":"Whether the item can be dragged"},"isResizable":{"type":"boolean","description":"Whether the item can be resized"}},"required":["contentId","x","y","w","h"],"additionalProperties":false}},"tabs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"ordering":{"type":"number"}},"required":["id","name","ordering"],"additionalProperties":false}}},"required":["items","layouts","tabs"],"additionalProperties":false},"abcMaterialsMap":{"type":"object","patternProperties":{"^\\d+$":{"$ref":"#/definitions/ABCMaterialState"}},"additionalProperties":false,"title":"ABC Materials Map","description":"A mapping of material IDs to their respective states within the ABC system.","abcNoDuplicateValuesForOrderingProperty":true},"recipeMap":{"type":"object","patternProperties":{"^\\d+-\\d+$":{"$ref":"#/definitions/RecipeState"}},"additionalProperties":false,"title":"Recipe Map","description":"A mapping of recipes, representing the acyclic relationships among materials. abcAreAllocationMethodsHomogeneous requires no mixing of Allocation Methods. A downstream material cannot have mixed upstream recipes. An upstream material cannot have mixed downstream recipes.","abcDoMaterialIDsExist":true,"abcIsAcyclic":true,"abcAreAllocationMethodsHomogeneous":true}},"required":["$schema","planDate","planNotes","analytics","abcMaterialsMap","recipeMap"],"additionalProperties":false,"type":"object","definitions":{"ABCMaterialState":{"type":"object","title":"ABC Material State","description":"Represents the state of a material in the system including its attributes and planning parameters.","abcDemandDetailsMatchDemandRows":true,"properties":{"x":{"type":"number","title":"X Coordinate","description":"The X coordinate position of the material in a graphical representation."},"y":{"type":"number","title":"Y Coordinate","description":"The Y coordinate position of the material in a graphical representation."},"ordering":{"type":"number","title":"Ordering","description":"Numeric value representing the order or sequence of the material."},"abcMaterialName":{"type":"string","minLength":1,"title":"Material Name","description":"The name of the material."},"uom":{"type":"string","minLength":1,"title":"Unit of Measure","description":"The unit of measure used for the material."},"materialShape":{"type":"string","enum":["circle","square","diamond","rectangle","parallelogram","trapezoid","triangle","pentagon","hexagon"],"title":"Material Shape","description":"The shape of the material represented graphically."},"materialColor":{"$ref":"#/definitions/Color"},"doExpiryCarryover":{"type":"boolean","title":"Expiry Carryover","description":"Indicates whether to carry over the expiry information for the material."},"isCapacityConstraintNode":{"type":"boolean","title":"Capacity Constraint Node","description":"Determines if the material is a node where capacity constraints are applied."},"inventoryMethod":{"type":"string","enum":["TargetMFC","MinimumInventory"],"title":"Inventory Method","description":"The method used for managing inventory levels, either target months forward coverage or minimum inventory."},"decimalPrecision":{"type":"integer","minimum":0,"maximum":5,"title":"Decimal Precision","description":"The precision of decimal places allowed for numerical entries related to the material."},"currency":{"type":"string","minLength":1,"title":"Currency","description":"The currency used for monetary calculations of the material."},"manufacturingCost":{"type":"number","minimum":0,"title":"Manufacturing Cost","description":"The direct manufacturing cost per unit of the material."},"standardCost":{"type":"number","minimum":0,"title":"Standard Cost","description":"The standard cost per unit including overhead of the material."},"salesPrice":{"type":"number","minimum":0,"title":"Sales Price","description":"The sales price per unit of the material."},"lotSize":{"$comment":"Require integer until we fix https://gitlab.com/abc-plan/abc-plan-server/-/issues/9","type":"integer","minimum":1,"title":"Lot Size","description":"Batch size for orders. Must be greater than 0 to plan, etc."},"leadTime":{"type":"integer","minimum":0,"title":"Lead Time","description":"Delay between Manufacture Date and Release Date. Format: non-negative integer."},"firmingPeriod":{"type":"integer","minimum":0,"title":"Firming Period","description":"Time during which no Planned Orders are allowed. Format: non-negative integer."},"targetMFCs":{"$ref":"#/definitions/NonNegativeIntegerTimeDependentValues","title":"Target MFC","description":"Target Months Forward Coverage refers to a dynamic safety stock level\u2014a buffer quantity of inventory designed to mitigate the risk of stock-outs caused by variability in Demand. In essence, it represents the number of months of Demand that could be satisfied assuming no additional material is manufactured. Each value is defined for a specific period of time."},"minimumInventories":{"$ref":"#/definitions/NonNegativeIntegerTimeDependentValues","title":"Minimum Inventory","description":"List of Minimum Inventory values, each defined for a specific period of time. Minimum Inventory denotes the lowest stock level to prevent outages, triggering restock."},"planningFrequencies":{"$ref":"#/definitions/PositiveIntegerTimeDependentValues","title":"Planning Frequencies","description":"List of Planning Frequency values, each defined for a specific period of time."},"shelfLives":{"$ref":"#/definitions/NonNegativeIntegerTimeDependentValues","title":"Shelf Lives","description":"List of Shelf Life values, each defined for a specific period of time."},"stopshipBuffers":{"$ref":"#/definitions/NonNegativeIntegerTimeDependentValues","title":"Stopship Buffers","description":"Buffers to account for Stopship scenarios, listed for different periods."},"initialInventories":{"type":"array","items":{"$ref":"#/definitions/InitialInventory"},"title":"Initial Inventories","description":"List of Initial Inventory records, each associated with specific lot and dates."},"firmOrders":{"type":"array","items":{"$ref":"#/definitions/FirmOrder"},"title":"Firm Orders","description":"List of Firm Orders with their respective quantities and dates."},"demand":{"$ref":"#/definitions/PositiveDateMapMap","title":"Demand","description":"Map of demand rows, where each key is a unique ID and value is a DateMap containing demand values for specific dates."},"demandDetails":{"$ref":"#/definitions/ABCDemandDetailsMap","title":"Demand Details","description":"Mapping of demand row IDs to their metadata including labels and ordering."},"otherDemand":{"$ref":"#/definitions/PositiveDateMap","title":"Other Demand","description":"Map of other types of demand not included in the primary demand values."},"otherDemandAnnotation":{"$ref":"#/definitions/AnnotationMap","title":"Other Demand Annotation","description":"Annotations related to other demand entries, providing additional context."},"actuals":{"$ref":"#/definitions/PositiveDateMap","title":"Actuals","description":"Map of actual quantities, corresponding to real data collected."},"plannedOrders":{"$ref":"#/definitions/PositiveDateMap","title":"Planned Orders","description":"Map of planned order quantities, anticipated ahead of time."},"expiryAdjustments":{"$ref":"#/definitions/NegativeDateMap","title":"Expiry Adjustments","description":"Adjustments made to account for expired materials, reducing quantities."},"timeAggregateType":{"type":"string","enum":["Annual","Quarterly","Monthly"],"title":"Time Aggregate Type","description":"The aggregation level for planning and reporting, e.g., annual, quarterly, or monthly."},"showQuantitiesAs":{"type":"string","enum":["Units","Lots","Monetary"],"title":"Show Quantities As","description":"Defines how quantities are represented, e.g., in units, lots, or monetary value."},"expiryAnalysisType":{"type":"string","enum":["Expiration","Stopship"],"title":"Expiry Analysis Type","description":"Determines the type of analysis to be performed on expiry data, focusing on expiration or stopship scenarios."},"timeDependentPlanningParameters":{"type":"boolean","title":"Time Dependent Planning Parameters","description":"Indicates whether planning parameters are dependent on time, necessitating different values at different periods."},"inventorySystemMaterialNumber":{"title":"Material Number in the inventory management system","description":"For pulling inventory from the inventory management system into Initial Inventory and Firm Orders & Releases","type":["string","null"]},"inventorySystemLocationName":{"title":"Location in the inventory management system","description":"For pulling inventory from the inventory management system into Initial Inventory and Firm Orders & Releases and filtering it by location","type":["string","null"]}},"required":["x","y","ordering","abcMaterialName","uom","materialShape","materialColor","doExpiryCarryover","isCapacityConstraintNode","inventoryMethod","decimalPrecision","currency","manufacturingCost","standardCost","salesPrice","lotSize","leadTime","firmingPeriod","targetMFCs","minimumInventories","planningFrequencies","shelfLives","stopshipBuffers","initialInventories","firmOrders","demand","demandDetails","actuals","expiryAdjustments","otherDemand","otherDemandAnnotation","plannedOrders","timeAggregateType","showQuantitiesAs","expiryAnalysisType","timeDependentPlanningParameters","inventorySystemMaterialNumber","inventorySystemLocationName"],"additionalProperties":false,"allOf":[{"if":{"properties":{"timeDependentPlanningParameters":{"const":false}}},"then":{"properties":{"targetMFCs":{"type":"array","maxItems":1,"minItems":1},"minimumInventories":{"type":"array","maxItems":1,"minItems":1},"planningFrequencies":{"type":"array","maxItems":1,"minItems":1},"shelfLives":{"type":"array","maxItems":1,"minItems":1},"stopshipBuffers":{"type":"array","maxItems":1,"minItems":1}}}},{"if":{"properties":{"timeDependentPlanningParameters":{"const":true}}},"then":{"properties":{"targetMFCs":{"type":"array","minItems":1},"minimumInventories":{"type":"array","minItems":1},"planningFrequencies":{"type":"array","minItems":1},"shelfLives":{"type":"array","minItems":1},"stopshipBuffers":{"type":"array","minItems":1}}}}]},"RecipeState":{"type":"object","title":"Recipe State","description":"Defines a recipe within the system, including its components and yields.","properties":{"recipe":{"type":"number","exclusiveMinimum":0,"title":"Recipe ID","description":"Unique identifier of the recipe."},"allocationMethod":{"type":"string","enum":["PercentAllocation","PriorityAllocation"],"title":"Consumption Allocation","description":"Method for allocating downstream consumption to upstream materials."},"percentAllocations":{"$ref":"#/definitions/PercentTimeDependentValues","title":"Percent Allocations","description":"Percentage allocations of materials to the recipe over different periods."},"priorityAllocations":{"$ref":"#/definitions/NonNegativeNumberTimeDependentValues","title":"Priority Allocations","description":"Priority allocations of materials to the recipe over different periods."},"percentYield":{"type":"number","minimum":0,"title":"Percent Yield","description":"The yield percentage of the recipe, indicating efficiency."}},"required":["recipe","allocationMethod","percentAllocations","priorityAllocations","percentYield"],"additionalProperties":false},"PositiveDateMap":{"type":"object","title":"Positive Date Map","description":"Mapping of dates to positive numerical values, typically representing demand or supply quantities.","patternProperties":{"^\\d{4}-(0[1-9]|1[0-2])-01$":{"type":"number","minimum":0}},"additionalProperties":false},"PositiveDateMapMap":{"type":"object","title":"Positive Date Map Map","description":"Mapping of unique IDs to date maps, supporting multiple demand rows per material.","patternProperties":{"^.*$":{"$ref":"#/definitions/PositiveDateMap"}},"additionalProperties":false},"NegativeDateMap":{"type":"object","title":"Negative Date Map","description":"Mapping of dates to negative numerical values, typically representing adjustments or reductions.","patternProperties":{"^\\d{4}-(0[1-9]|1[0-2])-01$":{"type":"number","maximum":0}},"additionalProperties":false},"AnnotationMap":{"type":"object","title":"Annotation Map","description":"Mapping of dates to annotations or notes about specific entries.","patternProperties":{"^\\d{4}-(0[1-9]|1[0-2])-01$":{"type":"string"}},"additionalProperties":false},"Color":{"type":"string","title":"Color","description":"Colors may be specified in any string-based format supported by the Color constructor documented at https://www.npmjs.com/package/color","abcIsValidColor":"true"},"ABCDemandDetailsMap":{"type":"object","title":"ABC Demand Details Map","description":"Mapping of demand row IDs to their metadata including label and ordering.","patternProperties":{"^.*$":{"type":"object","properties":{"label":{"type":"string","title":"Label","description":"User-visible label for the demand row."},"ordering":{"type":"number","title":"Ordering","description":"Display order of the demand row within a material."}},"required":["label","ordering"],"additionalProperties":false}},"additionalProperties":false},"TemplateTimeDependentValue":{"$comment":"additionalProperties is true because this object acts as a template and is merged with other type definitions to specify valid date ranges for time-dependent values.","type":"object","title":"Template Time Dependent Value","description":"Base template for defining time-dependent values, specifying the valid date ranges for such values.","properties":{"startDate":{"title":"Start Date","description":"The start date for the time-dependent value. Must be the first day of a month and within a valid date range.","oneOf":[{"type":"string","format":"date","abcIsFirstDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true},{"type":"null"}]},"endDate":{"title":"End Date","description":"The end date for the time-dependent value. Must be the last day of a month and within a valid date range.","oneOf":[{"type":"string","format":"date","abcIsLastDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true},{"type":"null"}]}},"required":["startDate","endDate"],"additionalProperties":true},"PercentValueConstraints":{"$comment":"additionalProperties is true because it is a template and gets merged with other types","type":"object","title":"Percent Value Constraints","description":"Constraints for percentage values, defining the valid range as 0% to 100%.","properties":{"timeDependentValue":{"description":"During a particular period of time for this recipe, how much of the downstream consumption is allocated to the upstream material. Format: 0-1 which correspond to 0%-100%.","type":"number","minimum":0,"maximum":1}},"required":["timeDependentValue"],"additionalProperties":true},"PercentTimeDependentValue":{"allOf":[{"$ref":"#/definitions/TemplateTimeDependentValue"},{"$ref":"#/definitions/PercentValueConstraints"}],"title":"Percent Time Dependent Value","description":"Defines a time-specific percentage value within a valid date range, adhering to percentage constraints."},"PercentTimeDependentValues":{"type":"array","items":{"$ref":"#/definitions/PercentTimeDependentValue"},"title":"Percent Time Dependent Values","description":"Array of time-dependent percentage values, each specifying the allocation for a given period.","abcHasNonOverlappingTimeDependentValues":"true","abcHasUninterruptedTimeDependentValues":"true"},"NonNegativeIntegerConstraints":{"$comment":"additionalProperties is true because this object acts as a template and is merged with other type definitions to enforce non-negative integer constraints in various scenarios.","type":"object","title":"Non-Negative Integer Constraints","description":"Defines constraints for integer values to ensure they are non-negative, used in various time-dependent value configurations.","properties":{"timeDependentValue":{"type":"integer","minimum":0,"title":"Time Dependent Value","description":"An integer value that cannot be negative, typically representing quantities or counts in a time-dependent context."}},"required":["timeDependentValue"],"additionalProperties":true},"NonNegativeIntegerTimeDependentValue":{"allOf":[{"$ref":"#/definitions/TemplateTimeDependentValue"},{"$ref":"#/definitions/NonNegativeIntegerConstraints"}],"title":"Non-Negative Integer Time Dependent Value","description":"Defines a time-specific integer value within a valid date range, ensuring it is non-negative."},"NonNegativeIntegerTimeDependentValues":{"type":"array","items":{"$ref":"#/definitions/NonNegativeIntegerTimeDependentValue"},"title":"Non-Negative Integer Time Dependent Values","description":"Array of time-dependent integer values, ensuring each is non-negative.","abcHasNonOverlappingTimeDependentValues":"true","abcHasUninterruptedTimeDependentValues":"true"},"NonNegativeNumberConstraints":{"$comment":"additionalProperties is true to allow merging this object with other type definitions to enforce non-negative number constraints in various scenarios.","type":"object","title":"Non-Negative Number Constraints","description":"Defines constraints for numbers to ensure they are non-negative, used in various contexts.","properties":{"timeDependentValue":{"type":"number","minimum":0,"title":"Non-Negative Number","description":"A non-negative number, used in various contexts to represent quantities or counts."}},"required":["timeDependentValue"],"additionalProperties":true},"NonNegativeNumberTimeDependentValue":{"allOf":[{"$ref":"#/definitions/TemplateTimeDependentValue"},{"$ref":"#/definitions/NonNegativeNumberConstraints"}],"title":"Non-Negative Number Time Dependent Value","description":"Defines a time-specific number within a valid range, ensuring it is non-negative."},"NonNegativeNumberTimeDependentValues":{"type":"array","items":{"$ref":"#/definitions/NonNegativeNumberTimeDependentValue"},"title":"Non-Negative Number Time Dependent Values","description":"Array of time-dependent non-negative numbers.","abcHasNonOverlappingTimeDependentValues":"true","abcHasUninterruptedTimeDependentValues":"true"},"PositiveIntegerConstraints":{"$comment":"additionalProperties is set to true because this object acts as a template and is merged with other type definitions to enforce positive integer constraints in various scenarios.","type":"object","title":"Positive Integer Constraints","description":"Defines constraints for integer values to ensure they are positive, used in various configurations where a strictly positive value is required.","properties":{"timeDependentValue":{"type":"integer","minimum":1,"title":"Time Dependent Value","description":"An integer value that must be positive, typically representing quantities or counts in contexts where zero is not a valid value."}},"required":["timeDependentValue"],"additionalProperties":true},"PositiveIntegerTimeDependentValue":{"allOf":[{"$ref":"#/definitions/TemplateTimeDependentValue"},{"$ref":"#/definitions/PositiveIntegerConstraints"}],"title":"Positive Integer Time Dependent Value","description":"Defines a time-specific integer value that must always be positive, ensuring it meets the requirements of scenarios where zero or negative numbers are not permitted."},"PositiveIntegerTimeDependentValues":{"type":"array","items":{"$ref":"#/definitions/PositiveIntegerTimeDependentValue"},"title":"Positive Integer Time Dependent Values","description":"Array of time-dependent integer values, ensuring each is positive. This setup is intended for scenarios where values must always be greater than zero.","abcHasNonOverlappingTimeDependentValues":"true","abcHasUninterruptedTimeDependentValues":"true"},"InitialInventory":{"type":"object","title":"Initial Inventory","description":"Defines the initial inventory of a material, including lot number and associated dates.","properties":{"lotNumber":{"type":"string","minLength":1,"title":"Lot Number","description":"The identifier for the lot number of the inventory item. It must be at least 1 character in length."},"initialInventoryQuantity":{"type":"number","minimum":0,"title":"Initial Inventory Quantity","description":"The quantity of the inventory item when first recorded. This must be a non-negative number."},"manufactureDate":{"type":"string","format":"date","title":"Manufacture Date","description":"The date the item was manufactured. This date must be the first day of a month and fall within a valid date range.","abcIsFirstDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true},"expirationDate":{"type":"string","format":"date","title":"Expiration Date","description":"The date the item will expire. This date must be the last day of a month and fall within a valid date range.","abcIsLastDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true,"abcIsExpirationDateOnOrAfterManufactureDate":true}},"required":["lotNumber","initialInventoryQuantity","manufactureDate","expirationDate"],"additionalProperties":false},"FirmOrder":{"type":"object","title":"Firm Order","description":"Defines a firm order within the system, including order details and relevant dates.","properties":{"firmOrderName":{"type":"string","title":"Firm Order Name","description":"The name or identifier of the firm order."},"firmOrderQuantity":{"type":"number","minimum":0,"title":"Firm Order Quantity","description":"The quantity specified in the firm order. Must be a non-negative value."},"manufactureDate":{"type":"string","format":"date","title":"Manufacture Date","description":"The date the goods are scheduled to be manufactured. Must be the first day of the month and within valid date range.","abcIsFirstDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true},"releaseDate":{"type":"string","format":"date","title":"Release Date","description":"The date the goods are scheduled to be released. Must be the first day of the month and within valid date range.","abcIsFirstDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true,"abcIsReleaseDateOnOrAfterPlanDate":true,"abcIsReleaseDateOnOrAfterManufactureDate":true},"expirationDate":{"type":"string","format":"date","title":"Expiration Date","description":"The expiration date of the product. Must be the last day of the month and within valid date range.","abcIsLastDayOfMonth":true,"abcIsAfter0001-01-01":true,"abcIsBefore9999-12-31":true,"abcIsExpirationDateOnOrAfterReleaseDate":true}},"required":["firmOrderName","firmOrderQuantity","manufactureDate","releaseDate","expirationDate"],"additionalProperties":false}}}
|
Provide a JSON object that satisfies the schema "ABCSupplyPlan JSON Schema". Here are the required top‑level fields: $schema, planDate, planNotes, analytics, abcMaterialsMap, recipeMap. Return only the valid JSON object.
|
ABCSupplyPlan JSON Schema
|
schema-store
|
schema_store_20
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/accelerator.json\",\"definitions\":{\"AcceleratorOption\":{\"type\":\"object\",\"properties\":{\"choices\":{\"title\":\"choices\",\"description\":\"A list of predefined choices\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"text\":{\"type\":\"string\",\"title\":\"text\",\"description\":\"The displayed text\"},\"value\":{\"title\":\"value\",\"description\":\"The value that the form returns for this choice\"}},\"title\":\"choices\"}},\"dataType\":{\"anyOf\":[{\"const\":\"string\"},{\"const\":\"number\"},{\"const\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"^$|^[A-Z][a-z0-9A-Z]*$\"},{\"type\":\"array\",\"minItems\":1,\"maxItems\":1,\"items\":{\"const\":\"string\"}},{\"type\":\"array\",\"minItems\":1,\"maxItems\":1,\"items\":{\"const\":\"number\"}},{\"type\":\"array\",\"minItems\":1,\"maxItems\":1,\"items\":{\"const\":\"boolean\"}},{\"type\":\"array\",\"minItems\":1,\"maxItems\":1,\"items\":{\"type\":\"string\",\"pattern\":\"^$|^[A-Z][a-z0-9A-Z]*$\"}},{\"type\":\"null\"}],\"title\":\"dataType\",\"description\":\"The option data type\"},\"defaultValue\":{\"title\":\"defaultValue\",\"description\":\"The value used to pre-populate the option\"},\"dependsOn\":{\"allOf\":[{\"$ref\":\"#/definitions/DependsOn\"},{\"title\":\"dependsOn\",\"description\":\"The dependency that controls this options visibility\"}]},\"description\":{\"type\":\"string\",\"title\":\"description\",\"description\":\"A tooltip to accompany the input\"},\"inputType\":{\"type\":\"string\",\"enum\":[\"text\",\"textarea\",\"checkbox\",\"select\",\"radio\"],\"title\":\"inputType\",\"description\":\"The HTML input type used to display the option\"},\"label\":{\"type\":\"string\",\"title\":\"label\",\"description\":\"A human-readable version of the name identifying the option\"},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"A unique, camelCase name\",\"minLength\":1,\"pattern\":\"^$|^[a-z][a-z0-9A-Z]*$\"},\"required\":{\"type\":\"boolean\",\"title\":\"required\",\"description\":\"Whether the user is required to enter a value in the UI\"},\"validationRegex\":{\"allOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"title\":\"validationRegex\",\"description\":\"A regex that validates the string representation of the option value when set\"}]}},\"anyOf\":[{\"properties\":{\"dataType\":{\"const\":\"string\"},\"defaultValue\":{\"type\":\"string\"}}},{\"properties\":{\"dataType\":{\"type\":\"array\",\"items\":{\"const\":\"string\"}},\"defaultValue\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},{\"properties\":{\"dataType\":{\"const\":\"number\"},\"defaultValue\":{\"type\":\"number\"}}},{\"properties\":{\"dataType\":{\"type\":\"array\",\"items\":{\"const\":\"number\"}},\"defaultValue\":{\"type\":\"array\",\"items\":{\"type\":\"number\"}}}},{\"properties\":{\"dataType\":{\"const\":\"boolean\"},\"defaultValue\":{\"type\":\"boolean\"}}},{\"properties\":{\"dataType\":{\"type\":\"array\",\"items\":{\"const\":\"boolean\"}},\"defaultValue\":{\"type\":\"array\",\"items\":{\"type\":\"boolean\"}}}},{\"properties\":{\"dataType\":{\"type\":\"string\",\"pattern\":\"^$|^[A-Z][a-z0-9A-Z]*$\"},\"defaultValue\":{\"type\":\"object\"}}},{\"properties\":{\"dataType\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^$|^[A-Z][a-z0-9A-Z]*$\"}},\"defaultValue\":{\"type\":\"array\",\"items\":{\"type\":\"object\"}}}}]},\"Chain-1\":{\"type\":\"object\",\"properties\":{\"applyTo\":{\"title\":\"applyTo\",\"description\":\"The path patterns used to filter which files to apply the Transforms to\",\"minItems\":1,\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"applyTo\",\"minLength\":1,\"pattern\":\"^$|^[^/].*$\"}},\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"transformations\":{\"title\":\"transformations\",\"description\":\"A list of child Transforms to apply sequentially\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]}}}},\"Chain-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Chain-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Chain\"}},\"required\":[\"type\"]}]},\"Combo-1\":{\"type\":\"object\",\"properties\":{\"applyTo\":{\"title\":\"applyTo\",\"description\":\"The path patterns used to filter which files to apply the Transforms to\",\"minItems\":1,\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"applyTo\",\"minLength\":1,\"pattern\":\"^$|^[^/].*$\"}},\"chain\":{\"title\":\"chain\",\"description\":\"A list of child Transforms to apply sequentially\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]}},\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"exclude\":{\"title\":\"exclude\",\"description\":\"The path patterns used to filter which files to exclude\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"exclude\",\"minLength\":1,\"pattern\":\"^$|^[^/].*$\"}},\"include\":{\"title\":\"include\",\"description\":\"The path patterns used to filter which files to include\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"include\",\"minLength\":1,\"pattern\":\"^$|^[^/].*$\"}},\"let\":{\"title\":\"let\",\"description\":\"A list of additional variables and their values\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/DerivedSymbol\"},{\"title\":\"let\"}]}},\"merge\":{\"title\":\"merge\",\"description\":\"A list of child Transforms to be executed in parallel\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]}},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"onConflict\":{\"allOf\":[{\"$ref\":\"#/definitions/ConflictResolution\"},{\"title\":\"onConflict\",\"description\":\"How conflict is handled when an operation produces multiple files at the same path\"}]}}},\"Combo-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Combo-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Combo\"}}}]},\"ConflictResolution\":{\"type\":\"string\",\"enum\":[\"Fail\",\"UseFirst\",\"UseLast\",\"Append\",\"FavorOwn\",\"FavorForeign\",\"NWayDiff\"]},\"DependsOn\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The options name\",\"minLength\":1,\"pattern\":\"^$|^[a-z][a-z0-9A-Z]*$\"},\"value\":{\"title\":\"value\",\"description\":\"The desired options value to compare against\"}}},\"DerivedSymbol\":{\"type\":\"object\",\"properties\":{\"expression\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"expression\",\"description\":\"The SpEL expression to evaluate to compute the symbol value\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The name under which the new symbol will be added\",\"minLength\":1,\"pattern\":\"^$|^[a-z][a-z0-9A-Z]*$\"}}},\"Exclude-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"patterns\":{\"title\":\"patterns\",\"description\":\"The path patterns used to filter which files to exclude\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"patterns\",\"minLength\":1,\"pattern\":\"^$|^[^/].*$\"}}}},\"Exclude-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Exclude-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Exclude\"}},\"required\":[\"type\"]}]},\"Expression\":{\"type\":\"string\"},\"Include-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"patterns\":{\"title\":\"patterns\",\"description\":\"The path patterns used to filter which files to include\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"patterns\",\"minLength\":1,\"pattern\":\"^$|^[^/].*$\"}}}},\"Include-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Include-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Include\"}},\"required\":[\"type\"]}]},\"InvokeFragment-1\":{\"type\":\"object\",\"properties\":{\"anchor\":{\"type\":\"string\",\"title\":\"anchor\",\"pattern\":\"^$|^[^/]$|^[^/](.+)[^/]$\"},\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"let\":{\"title\":\"let\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/DerivedSymbol\"},{\"title\":\"let\"}]}},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"reference\":{\"type\":\"string\",\"title\":\"reference\",\"minLength\":1,\"pattern\":\"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$\"}}},\"InvokeFragment-2\":{\"allOf\":[{\"$ref\":\"#/definitions/InvokeFragment-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"InvokeFragment\"}},\"required\":[\"type\"]}]},\"Let-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"in\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"noShadow\":{\"type\":\"boolean\",\"title\":\"noShadow\",\"description\":\"Whether shadowing should be turned off\"},\"symbols\":{\"title\":\"symbols\",\"description\":\"A list of additional variables and their values\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/DerivedSymbol\"},{\"title\":\"symbols\"}]}}}},\"Let-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Let-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Let\"}},\"required\":[\"type\"]}]},\"Loop-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"doAsChain\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]},\"doAsMerge\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]},\"index\":{\"type\":\"string\",\"title\":\"index\",\"description\":\"The variable's name to be assigned to the index of the current element on each iteration\",\"pattern\":\"^$|^[a-z][a-z0-9A-Z]*$\"},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"on\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"on\",\"description\":\"A SpEL expression that evaluates a list that contains the elements to be iterated over\"}]},\"var\":{\"type\":\"string\",\"title\":\"var\",\"description\":\"The name of the variable to be assigned to the current element on each iteration\",\"pattern\":\"^$|^[a-z][a-z0-9A-Z]*$\"}}},\"Loop-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Loop-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Loop\"}},\"required\":[\"type\"]}]},\"Merge-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"sources\":{\"title\":\"sources\",\"description\":\"A list of child Transforms to be executed in parallel\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]}}}},\"Merge-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Merge-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Merge\"}},\"required\":[\"type\"]}]},\"OpenRewriteRecipe-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"options\":{\"type\":\"object\",\"title\":\"options\",\"description\":\"Keys and values that depend on the class of the recipe\"},\"parseOrFail\":{\"type\":\"boolean\",\"title\":\"parseOrFail\"},\"recipe\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z_$][a-zA-Z\\\\d_$]*(?:\\\\.[a-zA-Z_$][a-zA-Z\\\\d_$]*)*$\",\"title\":\"recipe\",\"description\":\"Full qualified classname of the recipe\"}}},\"OpenRewriteRecipe-2\":{\"allOf\":[{\"$ref\":\"#/definitions/OpenRewriteRecipe-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"OpenRewriteRecipe\"}},\"required\":[\"type\"]}]},\"Pattern\":{\"type\":\"string\",\"format\":\"regex\"},\"Provenance-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"}}},\"Provenance-2\":{\"allOf\":[{\"$ref\":\"#/definitions/Provenance-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"Provenance\"}},\"required\":[\"type\"]}]},\"ReplaceText-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"regex\":{\"type\":\"object\",\"properties\":{\"pattern\":{\"allOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"title\":\"pattern\",\"description\":\"The regular expression that determines text that will be replaced\"}]},\"with\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"with\",\"description\":\"The SpEL expression that evaluates to the text that will replace the previous string\"}]}},\"title\":\"regex\",\"description\":\"The replacement rule using a single regular expression\"},\"substitutions\":{\"title\":\"substitutions\",\"description\":\"The replacement rules using literal text tokens\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"text\":{\"type\":\"string\",\"title\":\"text\",\"description\":\"The text that will be replaced\",\"minLength\":1},\"with\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"with\",\"description\":\"The SpEL expression that evaluates to the text that will replace the previous string\"}]}},\"title\":\"substitutions\"}}}},\"ReplaceText-2\":{\"allOf\":[{\"$ref\":\"#/definitions/ReplaceText-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"ReplaceText\"}},\"required\":[\"type\"]}]},\"RewritePath-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"matchOrFail\":{\"type\":\"boolean\",\"title\":\"matchOrFail\",\"description\":\"Whether an error should occur if the regex doesn't match\"},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"regex\":{\"allOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"title\":\"regex\",\"description\":\"The regular expression used to match each input files path\"}]},\"rewriteTo\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"rewriteTo\",\"description\":\"The SpEL expression of the location that the file will be rewritten to\"}]}}},\"RewritePath-2\":{\"allOf\":[{\"$ref\":\"#/definitions/RewritePath-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"RewritePath\"}},\"required\":[\"type\"]}]},\"UniquePath-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"},\"strategy\":{\"allOf\":[{\"$ref\":\"#/definitions/ConflictResolution\"},{\"title\":\"strategy\",\"description\":\"How conflict is handled when an operation produces multiple files at the same path\"}]}}},\"UniquePath-2\":{\"allOf\":[{\"$ref\":\"#/definitions/UniquePath-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"UniquePath\"}},\"required\":[\"type\"]}]},\"UseEncoding-1\":{\"type\":\"object\",\"properties\":{\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"encoding\":{\"type\":\"object\",\"title\":\"encoding\",\"description\":\"The encuding to use, as recognized by the java java.nio.charset.Charset class\"},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"}}},\"UseEncoding-2\":{\"allOf\":[{\"$ref\":\"#/definitions/UseEncoding-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"UseEncoding\"}},\"required\":[\"type\"]}]},\"YTT-1\":{\"type\":\"object\",\"properties\":{\"allowList\":{\"title\":\"allowList\",\"description\":\"A list of variable names that are allowed to be passed to YTT\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"title\":\"allowList\"}]}},\"condition\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"condition\",\"description\":\"The SpEL expression that determines if this Transform should execute\"}]},\"denyList\":{\"title\":\"denyList\",\"description\":\"A list of variable names that are denied from being passed to YTT\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/Pattern\"},{\"title\":\"denyList\"}]}},\"extraArgs\":{\"title\":\"extraArgs\",\"description\":\"A list of SpEL expressions whose results are additional command line arguments\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/Expression\"},{\"title\":\"extraArgs\"}]}},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The transform name\"}}},\"YTT-2\":{\"allOf\":[{\"$ref\":\"#/definitions/YTT-1\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"YTT\"}},\"required\":[\"type\"]}]}},\"properties\":{\"accelerator\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"title\":\"description\",\"description\":\"A more detailed description\"},\"displayName\":{\"type\":\"string\",\"title\":\"displayName\",\"description\":\"A human-readable name\"},\"iconUrl\":{\"type\":\"string\",\"title\":\"iconUrl\",\"description\":\"A URL pointing to an icon image\"},\"imports\":{\"title\":\"imports\",\"description\":\"The list of fragment to import\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"expose\":{\"title\":\"expose\",\"description\":\"The list of fragment options to make available as accelerator options\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"as\":{\"type\":\"string\",\"title\":\"as\",\"description\":\"The alias to use as the name of the option\",\"minLength\":1,\"pattern\":\"^$|^[a-z][a-z0-9A-Z]*$\"},\"dependsOn\":{\"allOf\":[{\"$ref\":\"#/definitions/DependsOn\"},{\"title\":\"dependsOn\",\"description\":\"The dependency that controls this options visibility\"}]},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The original name of the option\",\"minLength\":1,\"pattern\":\"^\\\\*$|^$|^[a-z][a-z0-9A-Z]*$\"}},\"title\":\"expose\"}},\"exposeTypes\":{\"title\":\"exposeTypes\",\"description\":\"The list of fragment types to make available as accelerator types\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"as\":{\"type\":\"string\",\"title\":\"as\",\"description\":\"The alias to use as the name of the type\",\"minLength\":1,\"pattern\":\"^$|^[A-Z][a-z0-9A-Z]*$\"},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The original name of the type\",\"minLength\":1,\"pattern\":\"^\\\\*$|^$|^[A-Z][a-z0-9A-Z]*$\"}},\"title\":\"exposeTypes\"}},\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The name of the fragment to import\",\"minLength\":1}},\"title\":\"imports\"}},\"options\":{\"title\":\"options\",\"description\":\"The list of options passed to the UI to create input text boxes\",\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/AcceleratorOption\"},{\"title\":\"options\"}]}},\"tags\":{\"title\":\"tags\",\"description\":\"A list of tags used to filter accelerators\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"title\":\"tags\"}},\"types\":{\"title\":\"types\",\"description\":\"The definitions of custom types\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"name\",\"description\":\"The capitalized name of this custom type\",\"minLength\":1,\"pattern\":\"^$|^[A-Z][a-z0-9A-Z]*$\"},\"struct\":{\"title\":\"struct\",\"description\":\"A sequence of option definitions\",\"minItems\":1,\"type\":\"array\",\"items\":{\"allOf\":[{\"$ref\":\"#/definitions/AcceleratorOption\"},{\"title\":\"struct\"}]}}},\"title\":\"types\"}}},\"title\":\"accelerator\",\"description\":\"The metadata (non-behavioral) part of an App Accelerator's accelerator.yaml file\"},\"engine\":{\"anyOf\":[{\"$ref\":\"#/definitions/Loop-2\"},{\"$ref\":\"#/definitions/Chain-2\"},{\"$ref\":\"#/definitions/Provenance-2\"},{\"$ref\":\"#/definitions/Exclude-2\"},{\"$ref\":\"#/definitions/Include-2\"},{\"$ref\":\"#/definitions/Combo-2\"},{\"$ref\":\"#/definitions/ReplaceText-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"},{\"$ref\":\"#/definitions/Merge-2\"},{\"$ref\":\"#/definitions/OpenRewriteRecipe-2\"},{\"$ref\":\"#/definitions/RewritePath-2\"},{\"$ref\":\"#/definitions/UniquePath-2\"},{\"$ref\":\"#/definitions/YTT-2\"},{\"$ref\":\"#/definitions/Let-2\"},{\"$ref\":\"#/definitions/UseEncoding-2\"},{\"$ref\":\"#/definitions/InvokeFragment-2\"}]}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"accelerator\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/accelerator.json","definitions":{"AcceleratorOption":{"type":"object","properties":{"choices":{"title":"choices","description":"A list of predefined choices","type":"array","items":{"type":"object","properties":{"text":{"type":"string","title":"text","description":"The displayed text"},"value":{"title":"value","description":"The value that the form returns for this choice"}},"title":"choices"}},"dataType":{"anyOf":[{"const":"string"},{"const":"number"},{"const":"boolean"},{"type":"string","pattern":"^$|^[A-Z][a-z0-9A-Z]*$"},{"type":"array","minItems":1,"maxItems":1,"items":{"const":"string"}},{"type":"array","minItems":1,"maxItems":1,"items":{"const":"number"}},{"type":"array","minItems":1,"maxItems":1,"items":{"const":"boolean"}},{"type":"array","minItems":1,"maxItems":1,"items":{"type":"string","pattern":"^$|^[A-Z][a-z0-9A-Z]*$"}},{"type":"null"}],"title":"dataType","description":"The option data type"},"defaultValue":{"title":"defaultValue","description":"The value used to pre-populate the option"},"dependsOn":{"allOf":[{"$ref":"#/definitions/DependsOn"},{"title":"dependsOn","description":"The dependency that controls this options visibility"}]},"description":{"type":"string","title":"description","description":"A tooltip to accompany the input"},"inputType":{"type":"string","enum":["text","textarea","checkbox","select","radio"],"title":"inputType","description":"The HTML input type used to display the option"},"label":{"type":"string","title":"label","description":"A human-readable version of the name identifying the option"},"name":{"type":"string","title":"name","description":"A unique, camelCase name","minLength":1,"pattern":"^$|^[a-z][a-z0-9A-Z]*$"},"required":{"type":"boolean","title":"required","description":"Whether the user is required to enter a value in the UI"},"validationRegex":{"allOf":[{"$ref":"#/definitions/Pattern"},{"title":"validationRegex","description":"A regex that validates the string representation of the option value when set"}]}},"anyOf":[{"properties":{"dataType":{"const":"string"},"defaultValue":{"type":"string"}}},{"properties":{"dataType":{"type":"array","items":{"const":"string"}},"defaultValue":{"type":"array","items":{"type":"string"}}}},{"properties":{"dataType":{"const":"number"},"defaultValue":{"type":"number"}}},{"properties":{"dataType":{"type":"array","items":{"const":"number"}},"defaultValue":{"type":"array","items":{"type":"number"}}}},{"properties":{"dataType":{"const":"boolean"},"defaultValue":{"type":"boolean"}}},{"properties":{"dataType":{"type":"array","items":{"const":"boolean"}},"defaultValue":{"type":"array","items":{"type":"boolean"}}}},{"properties":{"dataType":{"type":"string","pattern":"^$|^[A-Z][a-z0-9A-Z]*$"},"defaultValue":{"type":"object"}}},{"properties":{"dataType":{"type":"array","items":{"type":"string","pattern":"^$|^[A-Z][a-z0-9A-Z]*$"}},"defaultValue":{"type":"array","items":{"type":"object"}}}}]},"Chain-1":{"type":"object","properties":{"applyTo":{"title":"applyTo","description":"The path patterns used to filter which files to apply the Transforms to","minItems":1,"type":"array","items":{"type":"string","title":"applyTo","minLength":1,"pattern":"^$|^[^/].*$"}},"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"transformations":{"title":"transformations","description":"A list of child Transforms to apply sequentially","type":"array","items":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]}}}},"Chain-2":{"allOf":[{"$ref":"#/definitions/Chain-1"},{"type":"object","properties":{"type":{"const":"Chain"}},"required":["type"]}]},"Combo-1":{"type":"object","properties":{"applyTo":{"title":"applyTo","description":"The path patterns used to filter which files to apply the Transforms to","minItems":1,"type":"array","items":{"type":"string","title":"applyTo","minLength":1,"pattern":"^$|^[^/].*$"}},"chain":{"title":"chain","description":"A list of child Transforms to apply sequentially","type":"array","items":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]}},"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"exclude":{"title":"exclude","description":"The path patterns used to filter which files to exclude","type":"array","items":{"type":"string","title":"exclude","minLength":1,"pattern":"^$|^[^/].*$"}},"include":{"title":"include","description":"The path patterns used to filter which files to include","type":"array","items":{"type":"string","title":"include","minLength":1,"pattern":"^$|^[^/].*$"}},"let":{"title":"let","description":"A list of additional variables and their values","type":"array","items":{"allOf":[{"$ref":"#/definitions/DerivedSymbol"},{"title":"let"}]}},"merge":{"title":"merge","description":"A list of child Transforms to be executed in parallel","type":"array","items":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]}},"name":{"type":"string","title":"name","description":"The transform name"},"onConflict":{"allOf":[{"$ref":"#/definitions/ConflictResolution"},{"title":"onConflict","description":"How conflict is handled when an operation produces multiple files at the same path"}]}}},"Combo-2":{"allOf":[{"$ref":"#/definitions/Combo-1"},{"type":"object","properties":{"type":{"const":"Combo"}}}]},"ConflictResolution":{"type":"string","enum":["Fail","UseFirst","UseLast","Append","FavorOwn","FavorForeign","NWayDiff"]},"DependsOn":{"type":"object","properties":{"name":{"type":"string","title":"name","description":"The options name","minLength":1,"pattern":"^$|^[a-z][a-z0-9A-Z]*$"},"value":{"title":"value","description":"The desired options value to compare against"}}},"DerivedSymbol":{"type":"object","properties":{"expression":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"expression","description":"The SpEL expression to evaluate to compute the symbol value"}]},"name":{"type":"string","title":"name","description":"The name under which the new symbol will be added","minLength":1,"pattern":"^$|^[a-z][a-z0-9A-Z]*$"}}},"Exclude-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"patterns":{"title":"patterns","description":"The path patterns used to filter which files to exclude","type":"array","items":{"type":"string","title":"patterns","minLength":1,"pattern":"^$|^[^/].*$"}}}},"Exclude-2":{"allOf":[{"$ref":"#/definitions/Exclude-1"},{"type":"object","properties":{"type":{"const":"Exclude"}},"required":["type"]}]},"Expression":{"type":"string"},"Include-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"patterns":{"title":"patterns","description":"The path patterns used to filter which files to include","type":"array","items":{"type":"string","title":"patterns","minLength":1,"pattern":"^$|^[^/].*$"}}}},"Include-2":{"allOf":[{"$ref":"#/definitions/Include-1"},{"type":"object","properties":{"type":{"const":"Include"}},"required":["type"]}]},"InvokeFragment-1":{"type":"object","properties":{"anchor":{"type":"string","title":"anchor","pattern":"^$|^[^/]$|^[^/](.+)[^/]$"},"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"let":{"title":"let","type":"array","items":{"allOf":[{"$ref":"#/definitions/DerivedSymbol"},{"title":"let"}]}},"name":{"type":"string","title":"name","description":"The transform name"},"reference":{"type":"string","title":"reference","minLength":1,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"}}},"InvokeFragment-2":{"allOf":[{"$ref":"#/definitions/InvokeFragment-1"},{"type":"object","properties":{"type":{"const":"InvokeFragment"}},"required":["type"]}]},"Let-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"in":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]},"name":{"type":"string","title":"name","description":"The transform name"},"noShadow":{"type":"boolean","title":"noShadow","description":"Whether shadowing should be turned off"},"symbols":{"title":"symbols","description":"A list of additional variables and their values","type":"array","items":{"allOf":[{"$ref":"#/definitions/DerivedSymbol"},{"title":"symbols"}]}}}},"Let-2":{"allOf":[{"$ref":"#/definitions/Let-1"},{"type":"object","properties":{"type":{"const":"Let"}},"required":["type"]}]},"Loop-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"doAsChain":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]},"doAsMerge":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]},"index":{"type":"string","title":"index","description":"The variable's name to be assigned to the index of the current element on each iteration","pattern":"^$|^[a-z][a-z0-9A-Z]*$"},"name":{"type":"string","title":"name","description":"The transform name"},"on":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"on","description":"A SpEL expression that evaluates a list that contains the elements to be iterated over"}]},"var":{"type":"string","title":"var","description":"The name of the variable to be assigned to the current element on each iteration","pattern":"^$|^[a-z][a-z0-9A-Z]*$"}}},"Loop-2":{"allOf":[{"$ref":"#/definitions/Loop-1"},{"type":"object","properties":{"type":{"const":"Loop"}},"required":["type"]}]},"Merge-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"sources":{"title":"sources","description":"A list of child Transforms to be executed in parallel","type":"array","items":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]}}}},"Merge-2":{"allOf":[{"$ref":"#/definitions/Merge-1"},{"type":"object","properties":{"type":{"const":"Merge"}},"required":["type"]}]},"OpenRewriteRecipe-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"options":{"type":"object","title":"options","description":"Keys and values that depend on the class of the recipe"},"parseOrFail":{"type":"boolean","title":"parseOrFail"},"recipe":{"type":"string","pattern":"^[a-zA-Z_$][a-zA-Z\\d_$]*(?:\\.[a-zA-Z_$][a-zA-Z\\d_$]*)*$","title":"recipe","description":"Full qualified classname of the recipe"}}},"OpenRewriteRecipe-2":{"allOf":[{"$ref":"#/definitions/OpenRewriteRecipe-1"},{"type":"object","properties":{"type":{"const":"OpenRewriteRecipe"}},"required":["type"]}]},"Pattern":{"type":"string","format":"regex"},"Provenance-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"}}},"Provenance-2":{"allOf":[{"$ref":"#/definitions/Provenance-1"},{"type":"object","properties":{"type":{"const":"Provenance"}},"required":["type"]}]},"ReplaceText-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"regex":{"type":"object","properties":{"pattern":{"allOf":[{"$ref":"#/definitions/Pattern"},{"title":"pattern","description":"The regular expression that determines text that will be replaced"}]},"with":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"with","description":"The SpEL expression that evaluates to the text that will replace the previous string"}]}},"title":"regex","description":"The replacement rule using a single regular expression"},"substitutions":{"title":"substitutions","description":"The replacement rules using literal text tokens","type":"array","items":{"type":"object","properties":{"text":{"type":"string","title":"text","description":"The text that will be replaced","minLength":1},"with":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"with","description":"The SpEL expression that evaluates to the text that will replace the previous string"}]}},"title":"substitutions"}}}},"ReplaceText-2":{"allOf":[{"$ref":"#/definitions/ReplaceText-1"},{"type":"object","properties":{"type":{"const":"ReplaceText"}},"required":["type"]}]},"RewritePath-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"matchOrFail":{"type":"boolean","title":"matchOrFail","description":"Whether an error should occur if the regex doesn't match"},"name":{"type":"string","title":"name","description":"The transform name"},"regex":{"allOf":[{"$ref":"#/definitions/Pattern"},{"title":"regex","description":"The regular expression used to match each input files path"}]},"rewriteTo":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"rewriteTo","description":"The SpEL expression of the location that the file will be rewritten to"}]}}},"RewritePath-2":{"allOf":[{"$ref":"#/definitions/RewritePath-1"},{"type":"object","properties":{"type":{"const":"RewritePath"}},"required":["type"]}]},"UniquePath-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"name":{"type":"string","title":"name","description":"The transform name"},"strategy":{"allOf":[{"$ref":"#/definitions/ConflictResolution"},{"title":"strategy","description":"How conflict is handled when an operation produces multiple files at the same path"}]}}},"UniquePath-2":{"allOf":[{"$ref":"#/definitions/UniquePath-1"},{"type":"object","properties":{"type":{"const":"UniquePath"}},"required":["type"]}]},"UseEncoding-1":{"type":"object","properties":{"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"encoding":{"type":"object","title":"encoding","description":"The encuding to use, as recognized by the java java.nio.charset.Charset class"},"name":{"type":"string","title":"name","description":"The transform name"}}},"UseEncoding-2":{"allOf":[{"$ref":"#/definitions/UseEncoding-1"},{"type":"object","properties":{"type":{"const":"UseEncoding"}},"required":["type"]}]},"YTT-1":{"type":"object","properties":{"allowList":{"title":"allowList","description":"A list of variable names that are allowed to be passed to YTT","type":"array","items":{"allOf":[{"$ref":"#/definitions/Pattern"},{"title":"allowList"}]}},"condition":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"condition","description":"The SpEL expression that determines if this Transform should execute"}]},"denyList":{"title":"denyList","description":"A list of variable names that are denied from being passed to YTT","type":"array","items":{"allOf":[{"$ref":"#/definitions/Pattern"},{"title":"denyList"}]}},"extraArgs":{"title":"extraArgs","description":"A list of SpEL expressions whose results are additional command line arguments","type":"array","items":{"allOf":[{"$ref":"#/definitions/Expression"},{"title":"extraArgs"}]}},"name":{"type":"string","title":"name","description":"The transform name"}}},"YTT-2":{"allOf":[{"$ref":"#/definitions/YTT-1"},{"type":"object","properties":{"type":{"const":"YTT"}},"required":["type"]}]}},"properties":{"accelerator":{"type":"object","properties":{"description":{"type":"string","title":"description","description":"A more detailed description"},"displayName":{"type":"string","title":"displayName","description":"A human-readable name"},"iconUrl":{"type":"string","title":"iconUrl","description":"A URL pointing to an icon image"},"imports":{"title":"imports","description":"The list of fragment to import","type":"array","items":{"type":"object","properties":{"expose":{"title":"expose","description":"The list of fragment options to make available as accelerator options","type":"array","items":{"type":"object","properties":{"as":{"type":"string","title":"as","description":"The alias to use as the name of the option","minLength":1,"pattern":"^$|^[a-z][a-z0-9A-Z]*$"},"dependsOn":{"allOf":[{"$ref":"#/definitions/DependsOn"},{"title":"dependsOn","description":"The dependency that controls this options visibility"}]},"name":{"type":"string","title":"name","description":"The original name of the option","minLength":1,"pattern":"^\\*$|^$|^[a-z][a-z0-9A-Z]*$"}},"title":"expose"}},"exposeTypes":{"title":"exposeTypes","description":"The list of fragment types to make available as accelerator types","type":"array","items":{"type":"object","properties":{"as":{"type":"string","title":"as","description":"The alias to use as the name of the type","minLength":1,"pattern":"^$|^[A-Z][a-z0-9A-Z]*$"},"name":{"type":"string","title":"name","description":"The original name of the type","minLength":1,"pattern":"^\\*$|^$|^[A-Z][a-z0-9A-Z]*$"}},"title":"exposeTypes"}},"name":{"type":"string","title":"name","description":"The name of the fragment to import","minLength":1}},"title":"imports"}},"options":{"title":"options","description":"The list of options passed to the UI to create input text boxes","type":"array","items":{"allOf":[{"$ref":"#/definitions/AcceleratorOption"},{"title":"options"}]}},"tags":{"title":"tags","description":"A list of tags used to filter accelerators","type":"array","items":{"type":"string","title":"tags"}},"types":{"title":"types","description":"The definitions of custom types","type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"name","description":"The capitalized name of this custom type","minLength":1,"pattern":"^$|^[A-Z][a-z0-9A-Z]*$"},"struct":{"title":"struct","description":"A sequence of option definitions","minItems":1,"type":"array","items":{"allOf":[{"$ref":"#/definitions/AcceleratorOption"},{"title":"struct"}]}}},"title":"types"}}},"title":"accelerator","description":"The metadata (non-behavioral) part of an App Accelerator's accelerator.yaml file"},"engine":{"anyOf":[{"$ref":"#/definitions/Loop-2"},{"$ref":"#/definitions/Chain-2"},{"$ref":"#/definitions/Provenance-2"},{"$ref":"#/definitions/Exclude-2"},{"$ref":"#/definitions/Include-2"},{"$ref":"#/definitions/Combo-2"},{"$ref":"#/definitions/ReplaceText-2"},{"$ref":"#/definitions/InvokeFragment-2"},{"$ref":"#/definitions/Merge-2"},{"$ref":"#/definitions/OpenRewriteRecipe-2"},{"$ref":"#/definitions/RewritePath-2"},{"$ref":"#/definitions/UniquePath-2"},{"$ref":"#/definitions/YTT-2"},{"$ref":"#/definitions/Let-2"},{"$ref":"#/definitions/UseEncoding-2"},{"$ref":"#/definitions/InvokeFragment-2"}]}},"type":"object"}
|
Provide a JSON object that satisfies the schema "accelerator". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
accelerator
|
schema-store
|
schema_store_21
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$ref\":\"#/definitions/IAccountsConfig\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"AwsAccountId\":{\"description\":\"AWS Account ID\",\"maxLength\":12,\"minLength\":12,\"type\":\"string\"},\"EmailAddress\":{\"description\":\"An email address\",\"maxLength\":64,\"minLength\":6,\"pattern\":\"['^\\\\S+@\\\\S+\\\\.\\\\S+$', '^\\\\w+$']\",\"type\":\"string\"},\"IAccountConfig\":{\"additionalProperties\":false,\"description\":\"Account configuration\",\"properties\":{\"accountAlias\":{\"$ref\":\"#/definitions/NonEmptyNoSpaceString\",\"description\":\"Account alias used for sign-in page URL in place of 12-digit number. This must be unique within the AWS partition and be only digits, lowercase letters, and hyphens. It will be validated againt the Regular Expression ^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$\"},\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The description is to used to provide more information about the account. This value is not used when creating accounts.\"},\"email\":{\"$ref\":\"#/definitions/EmailAddress\",\"description\":\"The email address of the owner to assign to the account. The email address must not already be associated with another AWS account. You must use a valid email address. The address must be a minimum of 6 and a maximum of 64 characters long. All characters must be 7-bit ASCII characters There must be one and only one @ symbol, which separates the local name from the domain name. The local name can\\u2019t contain any of the following characters: whitespace, \\u201d \\u2018 ( ) < > [ ] : ; , | % & The local name can\\u2019t begin with a dot (.) The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name can\\u2019t begin or end with a hyphen (-) or dot (.) The domain name must contain at least one dot\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyNoSpaceString\",\"description\":\"The friendly name that is assigned to the account for reference within the Accelerator. The name will be used to reference this account in other configuration files and not to lookup the account in AWS.\\n\\nFor pre-existing accounts this does not need to match the AWS account name.\\n\\nWhen creating new accounts with the Accelerator, this name will be used as the AWS account name.\\n\\nThe name should not contain any spaces as this isn't supported by the Accelerator.\"},\"organizationalUnit\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name for the Organizational Unit that this account is a member of. This Organizational Unit must exist in the organization-config.yaml file.\"},\"warm\":{\"description\":\"'Warm' the account by creating an EC2 instance that runs for 15 minutes Use for new accounts that will need to have ec2 instance provisioned as part of the solution The 'warming' will take place in the operations stack This property may be removed after the account has been provisioned\",\"type\":\"boolean\"}},\"required\":[\"email\",\"name\"],\"type\":\"object\"},\"IAccountIdConfig\":{\"additionalProperties\":false,\"properties\":{\"accountId\":{\"$ref\":\"#/definitions/AwsAccountId\"},\"email\":{\"$ref\":\"#/definitions/EmailAddress\"}},\"required\":[\"email\",\"accountId\"],\"type\":\"object\"},\"IAccountsConfig\":{\"additionalProperties\":false,\"properties\":{\"accountIds\":{\"items\":{\"$ref\":\"#/definitions/IAccountIdConfig\"},\"type\":\"array\"},\"mandatoryAccounts\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/definitions/IAccountConfig\"},\"type\":\"array\"},{\"items\":{\"$ref\":\"#/definitions/IGovCloudAccountConfig\"},\"type\":\"array\"}]},\"workloadAccounts\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/definitions/IAccountConfig\"},\"type\":\"array\"},{\"items\":{\"$ref\":\"#/definitions/IGovCloudAccountConfig\"},\"type\":\"array\"}]}},\"required\":[\"mandatoryAccounts\",\"workloadAccounts\"],\"type\":\"object\"},\"IGovCloudAccountConfig\":{\"additionalProperties\":false,\"description\":\"GovCloud Account configuration\\nUsed instead of the account configuration in the commercial\\npartition when creating GovCloud partition linked accounts.\",\"properties\":{\"accountAlias\":{\"$ref\":\"#/definitions/NonEmptyNoSpaceString\",\"description\":\"Account alias used for sign-in page URL in place of 12-digit number. This must be unique within the AWS partition and be only digits, lowercase letters, and hyphens. It will be validated againt the Regular Expression ^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$\"},\"description\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The description is to used to provide more information about the account. This value is not used when creating accounts.\"},\"email\":{\"$ref\":\"#/definitions/EmailAddress\",\"description\":\"The email address of the owner to assign to the account. The email address must not already be associated with another AWS account. You must use a valid email address. The address must be a minimum of 6 and a maximum of 64 characters long. All characters must be 7-bit ASCII characters There must be one and only one @ symbol, which separates the local name from the domain name. The local name can\\u2019t contain any of the following characters: whitespace, \\u201d \\u2018 ( ) < > [ ] : ; , | % & The local name can\\u2019t begin with a dot (.) The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name can\\u2019t begin or end with a hyphen (-) or dot (.) The domain name must contain at least one dot\"},\"enableGovCloud\":{\"description\":\"Indicates whether or not a GovCloud partition account should be created.\",\"type\":\"boolean\"},\"name\":{\"$ref\":\"#/definitions/NonEmptyNoSpaceString\",\"description\":\"The friendly name that is assigned to the account for reference within the Accelerator. The name will be used to reference this account in other configuration files and not to lookup the account in AWS.\\n\\nFor pre-existing accounts this does not need to match the AWS account name.\\n\\nWhen creating new accounts with the Accelerator, this name will be used as the AWS account name.\\n\\nThe name should not contain any spaces as this isn't supported by the Accelerator.\"},\"organizationalUnit\":{\"$ref\":\"#/definitions/NonEmptyString\",\"description\":\"The friendly name for the Organizational Unit that this account is a member of. This Organizational Unit must exist in the organization-config.yaml file.\"}},\"required\":[\"email\",\"name\"],\"type\":\"object\"},\"NonEmptyNoSpaceString\":{\"description\":\"A string that contains no spaces\",\"minLength\":1,\"pattern\":\"^[^\\\\s]*$\",\"type\":\"string\"},\"NonEmptyString\":{\"description\":\"A string that has at least 1 character\",\"minLength\":1,\"type\":\"string\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"accounts-config\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$ref":"#/definitions/IAccountsConfig","$schema":"http://json-schema.org/draft-07/schema#","definitions":{"AwsAccountId":{"description":"AWS Account ID","maxLength":12,"minLength":12,"type":"string"},"EmailAddress":{"description":"An email address","maxLength":64,"minLength":6,"pattern":"['^\\S+@\\S+\\.\\S+$', '^\\w+$']","type":"string"},"IAccountConfig":{"additionalProperties":false,"description":"Account configuration","properties":{"accountAlias":{"$ref":"#/definitions/NonEmptyNoSpaceString","description":"Account alias used for sign-in page URL in place of 12-digit number. This must be unique within the AWS partition and be only digits, lowercase letters, and hyphens. It will be validated againt the Regular Expression ^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$"},"description":{"$ref":"#/definitions/NonEmptyString","description":"The description is to used to provide more information about the account. This value is not used when creating accounts."},"email":{"$ref":"#/definitions/EmailAddress","description":"The email address of the owner to assign to the account. The email address must not already be associated with another AWS account. You must use a valid email address. The address must be a minimum of 6 and a maximum of 64 characters long. All characters must be 7-bit ASCII characters There must be one and only one @ symbol, which separates the local name from the domain name. The local name can\u2019t contain any of the following characters: whitespace, \u201d \u2018 ( ) < > [ ] : ; , | % & The local name can\u2019t begin with a dot (.) The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name can\u2019t begin or end with a hyphen (-) or dot (.) The domain name must contain at least one dot"},"name":{"$ref":"#/definitions/NonEmptyNoSpaceString","description":"The friendly name that is assigned to the account for reference within the Accelerator. The name will be used to reference this account in other configuration files and not to lookup the account in AWS.\n\nFor pre-existing accounts this does not need to match the AWS account name.\n\nWhen creating new accounts with the Accelerator, this name will be used as the AWS account name.\n\nThe name should not contain any spaces as this isn't supported by the Accelerator."},"organizationalUnit":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name for the Organizational Unit that this account is a member of. This Organizational Unit must exist in the organization-config.yaml file."},"warm":{"description":"'Warm' the account by creating an EC2 instance that runs for 15 minutes Use for new accounts that will need to have ec2 instance provisioned as part of the solution The 'warming' will take place in the operations stack This property may be removed after the account has been provisioned","type":"boolean"}},"required":["email","name"],"type":"object"},"IAccountIdConfig":{"additionalProperties":false,"properties":{"accountId":{"$ref":"#/definitions/AwsAccountId"},"email":{"$ref":"#/definitions/EmailAddress"}},"required":["email","accountId"],"type":"object"},"IAccountsConfig":{"additionalProperties":false,"properties":{"accountIds":{"items":{"$ref":"#/definitions/IAccountIdConfig"},"type":"array"},"mandatoryAccounts":{"anyOf":[{"items":{"$ref":"#/definitions/IAccountConfig"},"type":"array"},{"items":{"$ref":"#/definitions/IGovCloudAccountConfig"},"type":"array"}]},"workloadAccounts":{"anyOf":[{"items":{"$ref":"#/definitions/IAccountConfig"},"type":"array"},{"items":{"$ref":"#/definitions/IGovCloudAccountConfig"},"type":"array"}]}},"required":["mandatoryAccounts","workloadAccounts"],"type":"object"},"IGovCloudAccountConfig":{"additionalProperties":false,"description":"GovCloud Account configuration\nUsed instead of the account configuration in the commercial\npartition when creating GovCloud partition linked accounts.","properties":{"accountAlias":{"$ref":"#/definitions/NonEmptyNoSpaceString","description":"Account alias used for sign-in page URL in place of 12-digit number. This must be unique within the AWS partition and be only digits, lowercase letters, and hyphens. It will be validated againt the Regular Expression ^[a-z0-9]([a-z0-9]|-(?!-)){1,61}[a-z0-9]$"},"description":{"$ref":"#/definitions/NonEmptyString","description":"The description is to used to provide more information about the account. This value is not used when creating accounts."},"email":{"$ref":"#/definitions/EmailAddress","description":"The email address of the owner to assign to the account. The email address must not already be associated with another AWS account. You must use a valid email address. The address must be a minimum of 6 and a maximum of 64 characters long. All characters must be 7-bit ASCII characters There must be one and only one @ symbol, which separates the local name from the domain name. The local name can\u2019t contain any of the following characters: whitespace, \u201d \u2018 ( ) < > [ ] : ; , | % & The local name can\u2019t begin with a dot (.) The domain name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) The domain name can\u2019t begin or end with a hyphen (-) or dot (.) The domain name must contain at least one dot"},"enableGovCloud":{"description":"Indicates whether or not a GovCloud partition account should be created.","type":"boolean"},"name":{"$ref":"#/definitions/NonEmptyNoSpaceString","description":"The friendly name that is assigned to the account for reference within the Accelerator. The name will be used to reference this account in other configuration files and not to lookup the account in AWS.\n\nFor pre-existing accounts this does not need to match the AWS account name.\n\nWhen creating new accounts with the Accelerator, this name will be used as the AWS account name.\n\nThe name should not contain any spaces as this isn't supported by the Accelerator."},"organizationalUnit":{"$ref":"#/definitions/NonEmptyString","description":"The friendly name for the Organizational Unit that this account is a member of. This Organizational Unit must exist in the organization-config.yaml file."}},"required":["email","name"],"type":"object"},"NonEmptyNoSpaceString":{"description":"A string that contains no spaces","minLength":1,"pattern":"^[^\\s]*$","type":"string"},"NonEmptyString":{"description":"A string that has at least 1 character","minLength":1,"type":"string"}}}
|
Provide a JSON object that satisfies the schema "accounts-config". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
accounts-config
|
schema-store
|
schema_store_22
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"properties\":{\"typescript\":{\"description\":\"Is project written in Typescript or not\",\"type\":\"boolean\"},\"exceptionHandlerNamespace\":{\"description\":\"Http server exception handler namespace\",\"type\":\"string\"},\"assetsDriver\":{\"description\":\"The driver to use for assets bundling\",\"type\":\"string\",\"enum\":[\"encore\",\"vite\",\"fake\"]},\"preloads\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"file\":{\"type\":\"string\"},\"environment\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"web\",\"console\",\"test\",\"repl\"]}},\"optional\":{\"type\":\"boolean\"}},\"required\":[\"file\"],\"additionalProperties\":false}]}},\"metaFiles\":{\"type\":\"array\",\"items\":{\"uniqueItems\":true,\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"pattern\":{\"type\":\"string\"},\"reloadServer\":{\"type\":\"boolean\"}},\"required\":[\"pattern\"]}]}},\"commands\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"providers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"aceProviders\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"testProviders\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"directories\":{\"type\":\"object\",\"properties\":{\"config\":{\"type\":\"string\"},\"public\":{\"type\":\"string\"},\"contracts\":{\"type\":\"string\"},\"providers\":{\"type\":\"string\"},\"database\":{\"type\":\"string\"},\"migrations\":{\"type\":\"string\"},\"seeds\":{\"type\":\"string\"},\"resources\":{\"type\":\"string\"},\"views\":{\"type\":\"string\"},\"start\":{\"type\":\"string\"},\"tmp\":{\"type\":\"string\"},\"tests\":{\"type\":\"string\"}},\"additionalProperties\":{\"type\":\"string\"}},\"commandsAliases\":{\"type\":\"object\",\"patternProperties\":{\"^.*$\":{\"type\":\"string\"}}},\"aliases\":{\"type\":\"object\",\"patternProperties\":{\"^.*$\":{\"type\":\"string\"}}},\"namespaces\":{\"type\":\"object\",\"properties\":{\"models\":{\"type\":\"string\"},\"exceptions\":{\"type\":\"string\"},\"middleware\":{\"type\":\"string\"},\"httpControllers\":{\"type\":\"string\"},\"eventListeners\":{\"type\":\"string\"},\"redisListeners\":{\"type\":\"string\"},\"validators\":{\"type\":\"string\"}},\"additionalProperties\":{\"type\":\"string\"}},\"tests\":{\"type\":\"object\",\"properties\":{\"suites\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"files\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"timeout\":{\"type\":\"number\"}},\"required\":[\"name\",\"files\"]}},\"timeout\":{\"type\":\"number\"},\"forceExit\":{\"type\":\"boolean\"}},\"required\":[\"suites\"]}},\"required\":[\"typescript\",\"providers\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"adonisrc.schema\". Here are the required top‑level fields: typescript, providers. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"typescript":{"description":"Is project written in Typescript or not","type":"boolean"},"exceptionHandlerNamespace":{"description":"Http server exception handler namespace","type":"string"},"assetsDriver":{"description":"The driver to use for assets bundling","type":"string","enum":["encore","vite","fake"]},"preloads":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"type":"string"},{"type":"object","properties":{"file":{"type":"string"},"environment":{"type":"array","items":{"type":"string","enum":["web","console","test","repl"]}},"optional":{"type":"boolean"}},"required":["file"],"additionalProperties":false}]}},"metaFiles":{"type":"array","items":{"uniqueItems":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"pattern":{"type":"string"},"reloadServer":{"type":"boolean"}},"required":["pattern"]}]}},"commands":{"type":"array","items":{"type":"string"}},"providers":{"type":"array","items":{"type":"string"},"uniqueItems":true},"aceProviders":{"type":"array","items":{"type":"string"},"uniqueItems":true},"testProviders":{"type":"array","items":{"type":"string"},"uniqueItems":true},"directories":{"type":"object","properties":{"config":{"type":"string"},"public":{"type":"string"},"contracts":{"type":"string"},"providers":{"type":"string"},"database":{"type":"string"},"migrations":{"type":"string"},"seeds":{"type":"string"},"resources":{"type":"string"},"views":{"type":"string"},"start":{"type":"string"},"tmp":{"type":"string"},"tests":{"type":"string"}},"additionalProperties":{"type":"string"}},"commandsAliases":{"type":"object","patternProperties":{"^.*$":{"type":"string"}}},"aliases":{"type":"object","patternProperties":{"^.*$":{"type":"string"}}},"namespaces":{"type":"object","properties":{"models":{"type":"string"},"exceptions":{"type":"string"},"middleware":{"type":"string"},"httpControllers":{"type":"string"},"eventListeners":{"type":"string"},"redisListeners":{"type":"string"},"validators":{"type":"string"}},"additionalProperties":{"type":"string"}},"tests":{"type":"object","properties":{"suites":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"files":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"timeout":{"type":"number"}},"required":["name","files"]}},"timeout":{"type":"number"},"forceExit":{"type":"boolean"}},"required":["suites"]}},"required":["typescript","providers"]}
|
Provide a JSON object that satisfies the schema "adonisrc.schema". Here are the required top‑level fields: typescript, providers. Return only the valid JSON object.
|
adonisrc.schema
|
schema-store
|
schema_store_23
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"title\":\"aerleon.yml\",\"description\":\"Configure Aerleon's aclgen, aclcheck, and pol2yaml command line tools\",\"type\":\"object\",\"properties\":{\"base_directory\":{\"type\":\"string\",\"description\":\"aclgen and pol2yaml will search this directory recursively for policy files to process, except if the flag `--policy_file` is used to give a specific input file (aclgen only).\\n\\nRelative paths that appear in 'include' directives will be resolved against base_directory.\\n\\nThe default value is './policies'.\",\"minLength\":1},\"definitions_directory\":{\"type\":\"string\",\"description\":\"All network and service definition files in this directory will be loaded and used to resolve symbolic network and service names. \\n\\nUnlike base_directory, definitions_directory is not searched recursively for input files.\\n\\nThe default value is './def'.\",\"minLength\":1},\"output_directory\":{\"type\":\"string\",\"description\":\"aclgen will place all generated ACLs in this directory. For `aclgen` the default value is the current directory.\\n\\npol2yaml will place each converted file adjacent to its input file by default. If output_directory is given, pol2yaml will mirror the directory structure of the input files in the output_directory, potentially creating directories in the process.\",\"minLength\":1},\"optimize\":{\"type\":\"boolean\",\"description\":\"Causes aclgen to produce a more compact address book by collapsing adjacent or overlapping CIDR expressions within the same network.\\n\\nOn some platforms (Juniper SRX and platforms configured with the 'object-group' option) address book compression is restricted to only collapse addresses that share the same network token (name).\\n\\nThis flag is not enabled by default, although a secondary address book compression pass is always performed for Juniper SRX and Palo Alto Networks firewalls regardless of this setting.\"},\"recursive\":{\"type\":\"boolean\",\"description\":\"UNUSED. This field is not used.\"},\"debug\":{\"type\":\"boolean\",\"description\":\"Causes aclgen to display very detailed log messages if true. The default value is false.\"},\"verbose\":{\"type\":\"boolean\",\"description\":\"UNUSED. This field is not used. To get detailed log messages, use 'debug'.\"},\"max_renderers\":{\"type\":\"integer\",\"description\":\"Controls the number of parallel processes used by aclgen to render ACLs. The aclgen program uses Python's OS process-based multiprocessing, so setting max_renderers to '2' would cause aclgen to spawn two OS processes that will generate ACLs.\\n\\nSetting max_renderers to '1' will disable multiprocessing.\\n\\nBy default, max_renderers is set to '10'. Users may wish to set this to the number of available CPUs on the current system.\"},\"shade_check\":{\"type\":\"boolean\",\"description\":\"Causes aclgen to produce a warning if any unreachable term is encountered if true. The default value is false.\"},\"exp_info\":{\"type\":\"integer\",\"description\":\"aclgen will produce a warning if it encounters a term set to expire in the near future. Expired terms are ignored. Setting exp_info controls the number of weeks ahead that aclgen will check for soon-to-expire terms.\\n\\nThe default value is '2' (two weeks).\"}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aerleon.yml\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","title":"aerleon.yml","description":"Configure Aerleon's aclgen, aclcheck, and pol2yaml command line tools","type":"object","properties":{"base_directory":{"type":"string","description":"aclgen and pol2yaml will search this directory recursively for policy files to process, except if the flag `--policy_file` is used to give a specific input file (aclgen only).\n\nRelative paths that appear in 'include' directives will be resolved against base_directory.\n\nThe default value is './policies'.","minLength":1},"definitions_directory":{"type":"string","description":"All network and service definition files in this directory will be loaded and used to resolve symbolic network and service names. \n\nUnlike base_directory, definitions_directory is not searched recursively for input files.\n\nThe default value is './def'.","minLength":1},"output_directory":{"type":"string","description":"aclgen will place all generated ACLs in this directory. For `aclgen` the default value is the current directory.\n\npol2yaml will place each converted file adjacent to its input file by default. If output_directory is given, pol2yaml will mirror the directory structure of the input files in the output_directory, potentially creating directories in the process.","minLength":1},"optimize":{"type":"boolean","description":"Causes aclgen to produce a more compact address book by collapsing adjacent or overlapping CIDR expressions within the same network.\n\nOn some platforms (Juniper SRX and platforms configured with the 'object-group' option) address book compression is restricted to only collapse addresses that share the same network token (name).\n\nThis flag is not enabled by default, although a secondary address book compression pass is always performed for Juniper SRX and Palo Alto Networks firewalls regardless of this setting."},"recursive":{"type":"boolean","description":"UNUSED. This field is not used."},"debug":{"type":"boolean","description":"Causes aclgen to display very detailed log messages if true. The default value is false."},"verbose":{"type":"boolean","description":"UNUSED. This field is not used. To get detailed log messages, use 'debug'."},"max_renderers":{"type":"integer","description":"Controls the number of parallel processes used by aclgen to render ACLs. The aclgen program uses Python's OS process-based multiprocessing, so setting max_renderers to '2' would cause aclgen to spawn two OS processes that will generate ACLs.\n\nSetting max_renderers to '1' will disable multiprocessing.\n\nBy default, max_renderers is set to '10'. Users may wish to set this to the number of available CPUs on the current system."},"shade_check":{"type":"boolean","description":"Causes aclgen to produce a warning if any unreachable term is encountered if true. The default value is false."},"exp_info":{"type":"integer","description":"aclgen will produce a warning if it encounters a term set to expire in the near future. Expired terms are ignored. Setting exp_info controls the number of weeks ahead that aclgen will check for soon-to-expire terms.\n\nThe default value is '2' (two weeks)."}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "aerleon.yml". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
aerleon.yml
|
schema-store
|
schema_store_24
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"urn:aerleon:schemas:aerleon-definitions:1.0.0\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$comment\":\"https://aerleon.readthedocs.io/en/latest/reference/naming/\",\"title\":\"Aerleon Network & Service Definitions\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"networks\":{\"title\":\"Network Definition Section\",\"description\":\"Policy files can reference the networks in this section by name. A network is a list of IP addresses or CIDR IP address ranges and may contain other networks.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/networkDefinition\"},\"propertyNames\":{\"$ref\":\"#/$defs/token\"}},\"services\":{\"title\":\"Service Definition Section\",\"description\":\"Policy files can reference the services in this section by name. A service is a list of port/protocol pairs (e.g. port: 80, protocol: tcp) and can include port ranges. A service can include other services.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/$defs/serviceDefinition\"},\"propertyNames\":{\"$ref\":\"#/$defs/token\"}}},\"$defs\":{\"token\":{\"type\":\"string\",\"pattern\":\"^[-_a-zA-Z0-9]+$\"},\"comment\":{\"description\":\"Attach a comment directly to a value. This comment may be included in generated output on platforms that support it.\",\"type\":\"string\"},\"address\":{\"description\":\"Specifies an IP address or CIDR IP address range expression.\",\"type\":\"string\"},\"fqdn\":{\"description\":\"Specifies a fully qualified domain name with two or more labels.\",\"type\":\"string\",\"pattern\":\"^(?!.*://)(?=.{1,255}$)((.{1,63}\\\\.){1,127}(?![0-9]*$)[a-z0-9-]+\\\\.?)$\"},\"port\":{\"description\":\"Specifies a port or port range.\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\d+-\\\\d+|^\\\\d+$\"},{\"type\":\"integer\"}]},\"protocol\":{\"description\":\"Specifies a protocol by name or number.\",\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]},\"networkDefinition\":{\"type\":\"object\",\"title\":\"Network Definition\",\"description\":\"Defines a named network, composed of IP addresses, IP address ranges, and references to other networks.\\nAn object with the \\\"address\\\" property adds that address or address range to the network.\\nAn object with the \\\"name\\\" property includes the contents of that network into this one.\\nA single string also includes the content of that network into this one.\",\"additionalProperties\":false,\"required\":[\"values\"],\"properties\":{\"values\":{\"description\":\"Defines a named network, composed of IP addresses, IP address ranges, and references to other networks.\\nAn object with the \\\"address\\\" property adds that address or address range to the network.\\nAn object with the \\\"name\\\" property includes the contents of that network into this one.\\nA single string also includes the content of that network into this one.\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"title\":\"Network Reference\",\"description\":\"Include another network by name.\",\"$ref\":\"#/$defs/token\"},{\"type\":\"object\",\"required\":[\"address\"],\"properties\":{\"address\":{\"$ref\":\"#/$defs/address\"},\"comment\":{\"$ref\":\"#/$defs/comment\"}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"fqdn\"],\"properties\":{\"fqdn\":{\"$ref\":\"#/$defs/fqdn\"},\"comment\":{\"$ref\":\"#/$defs/comment\"}},\"additionalProperties\":false},{\"type\":\"object\",\"title\":\"Network Reference\",\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"Include another network by name.\",\"$ref\":\"#/$defs/token\"},\"comment\":{\"$ref\":\"#/$defs/comment\"}},\"additionalProperties\":false}]}}}},\"serviceDefinition\":{\"type\":\"array\",\"title\":\"Service Definition\",\"description\":\"Defines a named service, composed of portocol, port pairs and/or references to other services.\",\"items\":{\"oneOf\":[{\"type\":\"object\",\"required\":[\"port\",\"protocol\"],\"properties\":{\"port\":{\"$ref\":\"#/$defs/port\"},\"protocol\":{\"$ref\":\"#/$defs/protocol\"},\"comment\":{\"$ref\":\"#/$defs/comment\"}},\"additionalProperties\":false},{\"type\":\"object\",\"title\":\"Service Reference\",\"description\":\"Include another service by name.\",\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"Include another service by name.\",\"$ref\":\"#/$defs/token\"},\"comment\":{\"$ref\":\"#/$defs/comment\"}},\"additionalProperties\":false}]}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Aerleon Network & Service Definitions\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"urn:aerleon:schemas:aerleon-definitions:1.0.0","$schema":"http://json-schema.org/draft-07/schema#","$comment":"https://aerleon.readthedocs.io/en/latest/reference/naming/","title":"Aerleon Network & Service Definitions","type":"object","additionalProperties":false,"properties":{"networks":{"title":"Network Definition Section","description":"Policy files can reference the networks in this section by name. A network is a list of IP addresses or CIDR IP address ranges and may contain other networks.","type":"object","additionalProperties":{"$ref":"#/$defs/networkDefinition"},"propertyNames":{"$ref":"#/$defs/token"}},"services":{"title":"Service Definition Section","description":"Policy files can reference the services in this section by name. A service is a list of port/protocol pairs (e.g. port: 80, protocol: tcp) and can include port ranges. A service can include other services.","type":"object","additionalProperties":{"$ref":"#/$defs/serviceDefinition"},"propertyNames":{"$ref":"#/$defs/token"}}},"$defs":{"token":{"type":"string","pattern":"^[-_a-zA-Z0-9]+$"},"comment":{"description":"Attach a comment directly to a value. This comment may be included in generated output on platforms that support it.","type":"string"},"address":{"description":"Specifies an IP address or CIDR IP address range expression.","type":"string"},"fqdn":{"description":"Specifies a fully qualified domain name with two or more labels.","type":"string","pattern":"^(?!.*://)(?=.{1,255}$)((.{1,63}\\.){1,127}(?![0-9]*$)[a-z0-9-]+\\.?)$"},"port":{"description":"Specifies a port or port range.","oneOf":[{"type":"string","pattern":"^\\d+-\\d+|^\\d+$"},{"type":"integer"}]},"protocol":{"description":"Specifies a protocol by name or number.","oneOf":[{"type":"integer"},{"type":"string"}]},"networkDefinition":{"type":"object","title":"Network Definition","description":"Defines a named network, composed of IP addresses, IP address ranges, and references to other networks.\nAn object with the \"address\" property adds that address or address range to the network.\nAn object with the \"name\" property includes the contents of that network into this one.\nA single string also includes the content of that network into this one.","additionalProperties":false,"required":["values"],"properties":{"values":{"description":"Defines a named network, composed of IP addresses, IP address ranges, and references to other networks.\nAn object with the \"address\" property adds that address or address range to the network.\nAn object with the \"name\" property includes the contents of that network into this one.\nA single string also includes the content of that network into this one.","type":"array","items":{"oneOf":[{"type":"string","title":"Network Reference","description":"Include another network by name.","$ref":"#/$defs/token"},{"type":"object","required":["address"],"properties":{"address":{"$ref":"#/$defs/address"},"comment":{"$ref":"#/$defs/comment"}},"additionalProperties":false},{"type":"object","required":["fqdn"],"properties":{"fqdn":{"$ref":"#/$defs/fqdn"},"comment":{"$ref":"#/$defs/comment"}},"additionalProperties":false},{"type":"object","title":"Network Reference","required":["name"],"properties":{"name":{"description":"Include another network by name.","$ref":"#/$defs/token"},"comment":{"$ref":"#/$defs/comment"}},"additionalProperties":false}]}}}},"serviceDefinition":{"type":"array","title":"Service Definition","description":"Defines a named service, composed of portocol, port pairs and/or references to other services.","items":{"oneOf":[{"type":"object","required":["port","protocol"],"properties":{"port":{"$ref":"#/$defs/port"},"protocol":{"$ref":"#/$defs/protocol"},"comment":{"$ref":"#/$defs/comment"}},"additionalProperties":false},{"type":"object","title":"Service Reference","description":"Include another service by name.","required":["name"],"properties":{"name":{"description":"Include another service by name.","$ref":"#/$defs/token"},"comment":{"$ref":"#/$defs/comment"}},"additionalProperties":false}]}}}}
|
Provide a JSON object that satisfies the schema "Aerleon Network & Service Definitions". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Aerleon Network & Service Definitions
|
schema-store
|
schema_store_25
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"urn:aerleon:schemas:aerleon-policy-yaml:1.0.0\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$comment\":\"https://aerleon.readthedocs.io/en/latest/reference/yaml_reference/\",\"title\":\"Aerleon Policy File\",\"oneOf\":[{\"$ref\":\"#/$defs/policyTermIncludeFile\"},{\"$ref\":\"#/$defs/policyFilterIncludeFile\"},{\"$ref\":\"#/$defs/policyFile\"}],\"$defs\":{\"policyFile\":{\"type\":\"object\",\"title\":\"Policy File\",\"required\":[\"filters\"],\"properties\":{\"filters\":{\"description\":\"A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/filter\"}}}},\"policyFilterIncludeFile\":{\"type\":\"object\",\"title\":\"Policy File\",\"required\":[\"filters_include_only\"],\"properties\":{\"filters_include_only\":{\"description\":\"A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.\\n\\nfilters_include_only defines a list of filters that will not be directly converted into an ACL, but can be included by other files.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/filter\"}}}},\"policyTermIncludeFile\":{\"type\":\"object\",\"title\":\"Policy Include File\",\"required\":[\"terms\"],\"properties\":{\"terms\":{\"description\":\"A policy include file contains a single list of terms. Other policy files can insert this list using the include directive. This file can include other files, but be careful not to exceed the include depth limit of 5.\\n\\nEach entry in this list is a term and must have a 'name' property defined.\\n\\nCommon lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/term\"}}}},\"filter\":{\"oneOf\":[{\"type\":\"object\",\"required\":[\"header\",\"terms\"],\"properties\":{\"header\":{\"type\":\"object\",\"title\":\"Filter Header\",\"description\":\"The filter header lists the generator target platforms and their options. Other filter-level settings can be defined in the header.\",\"required\":[\"targets\"],\"properties\":{\"targets\":{\"title\":\"Filter Targets\",\"description\":\"aclgen will generate an ACL for each target platforms identified here.\",\"type\":\"object\"}}},\"terms\":{\"title\":\"Term List\",\"description\":\"The ACL rules for this filter. Each entry in this list is a term and must have a 'name' property defined.\\n\\nCommon lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/$defs/term\"}}},\"additionalProperties\":true},{\"type\":\"object\",\"required\":[\"include\"],\"properties\":{\"include\":{\"type\":\"string\",\"title\":\"Filter List Include\",\"description\":\"Common filters shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.\"}},\"additionalProperties\":false}]},\"term\":{\"oneOf\":[{\"title\":\"Term\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"}},\"additionalProperties\":true},{\"title\":\"Include Term List\",\"type\":\"object\",\"required\":[\"include\"],\"properties\":{\"include\":{\"description\":\"Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.\",\"type\":\"string\"}},\"additionalProperties\":false}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Aerleon Policy File\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"urn:aerleon:schemas:aerleon-policy-yaml:1.0.0","$schema":"http://json-schema.org/draft-07/schema#","$comment":"https://aerleon.readthedocs.io/en/latest/reference/yaml_reference/","title":"Aerleon Policy File","oneOf":[{"$ref":"#/$defs/policyTermIncludeFile"},{"$ref":"#/$defs/policyFilterIncludeFile"},{"$ref":"#/$defs/policyFile"}],"$defs":{"policyFile":{"type":"object","title":"Policy File","required":["filters"],"properties":{"filters":{"description":"A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.","type":"array","items":{"$ref":"#/$defs/filter"}}}},"policyFilterIncludeFile":{"type":"object","title":"Policy File","required":["filters_include_only"],"properties":{"filters_include_only":{"description":"A policy file contains one or more filters. Each filter has a header that lists the generator target platforms and their options. The filter ACL rules appear in the terms section.\n\nfilters_include_only defines a list of filters that will not be directly converted into an ACL, but can be included by other files.","type":"array","items":{"$ref":"#/$defs/filter"}}}},"policyTermIncludeFile":{"type":"object","title":"Policy Include File","required":["terms"],"properties":{"terms":{"description":"A policy include file contains a single list of terms. Other policy files can insert this list using the include directive. This file can include other files, but be careful not to exceed the include depth limit of 5.\n\nEach entry in this list is a term and must have a 'name' property defined.\n\nCommon lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.","type":"array","items":{"$ref":"#/$defs/term"}}}},"filter":{"oneOf":[{"type":"object","required":["header","terms"],"properties":{"header":{"type":"object","title":"Filter Header","description":"The filter header lists the generator target platforms and their options. Other filter-level settings can be defined in the header.","required":["targets"],"properties":{"targets":{"title":"Filter Targets","description":"aclgen will generate an ACL for each target platforms identified here.","type":"object"}}},"terms":{"title":"Term List","description":"The ACL rules for this filter. Each entry in this list is a term and must have a 'name' property defined.\n\nCommon lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file.","type":"array","items":{"$ref":"#/$defs/term"}}},"additionalProperties":true},{"type":"object","required":["include"],"properties":{"include":{"type":"string","title":"Filter List Include","description":"Common filters shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default."}},"additionalProperties":false}]},"term":{"oneOf":[{"title":"Term","type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":true},{"title":"Include Term List","type":"object","required":["include"],"properties":{"include":{"description":"Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.","type":"string"}},"additionalProperties":false}]}}}
|
Provide a JSON object that satisfies the schema "Aerleon Policy File". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Aerleon Policy File
|
schema-store
|
schema_store_26
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"id\":\"https://json.schemastore.org/agripparc-1.4.json\",\"properties\":{\"$schema\":{\"description\":\"Link to https://www.schemastore.org/agripparc-1.4.json\",\"type\":\"string\",\"enum\":[\"https://www.schemastore.org/agripparc-1.4.json\"]},\"props\":{\"description\":\"Which prop declaration method to use\",\"type\":\"string\",\"enum\":[\"ts\",\"jsdoc\",\"prop-types\",\"none\"]},\"children\":{\"description\":\"Whether the component is meant to have children (FC) or not (VFC)\",\"type\":\"boolean\"},\"typescript\":{\"description\":\"Whether to use Typescript\",\"type\":\"boolean\"},\"flat\":{\"description\":\"Whether to create a new, dedicated dir for the component (false) or not (true)\",\"type\":\"boolean\"},\"styling\":{\"description\":\"Which styling solution to use\",\"type\":\"string\",\"enum\":[\"css\",\"scss\",\"jss\",\"mui\",\"react-native\",\"styled-components\",\"none\"]},\"stylingModule\":{\"description\":\"Relevant for `css` or `scss` styling. If true, generates a scoped `module` stylesheet\",\"type\":\"boolean\"},\"importReact\":{\"description\":\"Whether to import React\",\"type\":\"boolean\"},\"overwrite\":{\"description\":\"Whether to overwrite existing files, if any are found\",\"type\":\"boolean\"},\"postCommand\":{\"description\":\"A command to run after a component was successfully generated\",\"type\":\"string\"},\"baseDir\":{\"description\":\"Path to a base directory which components should be genenrated in or relative to\",\"type\":\"string\"},\"destination\":{\"description\":\"The path in which the component folder/files should be generated, relative to baseDir\",\"type\":\"string\"},\"allowOutsideBase\":{\"description\":\"If true, allows components to be generated outside the resolved baseDir\",\"type\":\"boolean\"},\"exportType\":{\"description\":\"Whether to use a named export or a default export for the component\",\"type\":\"string\",\"enum\":[\"named\",\"default\"]},\"declaration\":{\"description\":\"Whether to declare the component as a const with an arrow function or a function declaration\",\"type\":\"string\",\"enum\":[\"const\",\"function\"]},\"tsPropsDeclaration\":{\"description\":\"For TS components, whether to declare props as an interface or a type\",\"type\":\"string\",\"enum\":[\"interface\",\"type\"]},\"memo\":{\"description\":\"Whether to generate a memo() component. Overrides the declaration option\",\"type\":\"boolean\"},\"separateIndex\":{\"description\":\"Whether to use a dedicated index file (recommended)\",\"type\":\"boolean\"},\"reactNative\":{\"description\":\"Whether to generate React Native components\"},\"debug\":{\"description\":\"Whether to log additional debug information\",\"type\":\"boolean\"}},\"title\":\"JSON schema for the Agrippa config file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for the Agrippa config file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"id":"https://json.schemastore.org/agripparc-1.4.json","properties":{"$schema":{"description":"Link to https://www.schemastore.org/agripparc-1.4.json","type":"string","enum":["https://www.schemastore.org/agripparc-1.4.json"]},"props":{"description":"Which prop declaration method to use","type":"string","enum":["ts","jsdoc","prop-types","none"]},"children":{"description":"Whether the component is meant to have children (FC) or not (VFC)","type":"boolean"},"typescript":{"description":"Whether to use Typescript","type":"boolean"},"flat":{"description":"Whether to create a new, dedicated dir for the component (false) or not (true)","type":"boolean"},"styling":{"description":"Which styling solution to use","type":"string","enum":["css","scss","jss","mui","react-native","styled-components","none"]},"stylingModule":{"description":"Relevant for `css` or `scss` styling. If true, generates a scoped `module` stylesheet","type":"boolean"},"importReact":{"description":"Whether to import React","type":"boolean"},"overwrite":{"description":"Whether to overwrite existing files, if any are found","type":"boolean"},"postCommand":{"description":"A command to run after a component was successfully generated","type":"string"},"baseDir":{"description":"Path to a base directory which components should be genenrated in or relative to","type":"string"},"destination":{"description":"The path in which the component folder/files should be generated, relative to baseDir","type":"string"},"allowOutsideBase":{"description":"If true, allows components to be generated outside the resolved baseDir","type":"boolean"},"exportType":{"description":"Whether to use a named export or a default export for the component","type":"string","enum":["named","default"]},"declaration":{"description":"Whether to declare the component as a const with an arrow function or a function declaration","type":"string","enum":["const","function"]},"tsPropsDeclaration":{"description":"For TS components, whether to declare props as an interface or a type","type":"string","enum":["interface","type"]},"memo":{"description":"Whether to generate a memo() component. Overrides the declaration option","type":"boolean"},"separateIndex":{"description":"Whether to use a dedicated index file (recommended)","type":"boolean"},"reactNative":{"description":"Whether to generate React Native components"},"debug":{"description":"Whether to log additional debug information","type":"boolean"}},"title":"JSON schema for the Agrippa config file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for the Agrippa config file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for the Agrippa config file
|
schema-store
|
schema_store_27
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"ProActions AI-Kit Configuration Schema\",\"description\":\"Schema for ProActions AI-Kit configuration files\",\"type\":\"object\",\"required\":[\"AI_KIT\"],\"properties\":{\"AI_KIT\":{\"type\":\"object\",\"description\":\"Root configuration object for AI-Kit\",\"properties\":{\"SERVICES\":{\"oneOf\":[{\"$ref\":\"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-services.schema.json\"},{\"type\":\"string\",\"description\":\"Path to an external services file using !include directive\"}]},\"TEXT_MENU\":{\"oneOf\":[{\"$ref\":\"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-floatingMenu.schema.json\"},{\"type\":\"string\",\"description\":\"Path to an external text menu file using !include directive\"}]},\"ONECLICK_MENU\":{\"oneOf\":[{\"$ref\":\"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-floatingMenu.schema.json\"},{\"type\":\"string\",\"description\":\"Path to an external oneclick menu file using !include directive\"}]},\"SLASH_MENU\":{\"oneOf\":[{\"$ref\":\"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-floatingMenu.schema.json\"},{\"type\":\"string\",\"description\":\"Path to an external slash menu file using !include directive\"}]},\"TEMPLATES\":{\"oneOf\":[{\"$ref\":\"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-templates.schema.json\"},{\"type\":\"string\",\"description\":\"Path to an external file using !include directive\"}]},\"SECTIONS\":{\"type\":\"array\",\"description\":\"Sections defining the grouping of actions in the UI\",\"items\":{\"oneOf\":[{\"$ref\":\"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-section.schema.json\"},{\"type\":\"string\",\"description\":\"Path to an external file using !include directive\"}]}}},\"additionalProperties\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ProActions AI-Kit Configuration Schema\". Here are the required top‑level fields: AI_KIT. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"ProActions AI-Kit Configuration Schema","description":"Schema for ProActions AI-Kit configuration files","type":"object","required":["AI_KIT"],"properties":{"AI_KIT":{"type":"object","description":"Root configuration object for AI-Kit","properties":{"SERVICES":{"oneOf":[{"$ref":"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-services.schema.json"},{"type":"string","description":"Path to an external services file using !include directive"}]},"TEXT_MENU":{"oneOf":[{"$ref":"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-floatingMenu.schema.json"},{"type":"string","description":"Path to an external text menu file using !include directive"}]},"ONECLICK_MENU":{"oneOf":[{"$ref":"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-floatingMenu.schema.json"},{"type":"string","description":"Path to an external oneclick menu file using !include directive"}]},"SLASH_MENU":{"oneOf":[{"$ref":"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-floatingMenu.schema.json"},{"type":"string","description":"Path to an external slash menu file using !include directive"}]},"TEMPLATES":{"oneOf":[{"$ref":"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-templates.schema.json"},{"type":"string","description":"Path to an external file using !include directive"}]},"SECTIONS":{"type":"array","description":"Sections defining the grouping of actions in the UI","items":{"oneOf":[{"$ref":"https://raw.githubusercontent.com/em-al-wi/proactions-schema/main/schema/partial-section.schema.json"},{"type":"string","description":"Path to an external file using !include directive"}]}}},"additionalProperties":false}}}
|
Provide a JSON object that satisfies the schema "ProActions AI-Kit Configuration Schema". Here are the required top‑level fields: AI_KIT. Return only the valid JSON object.
|
ProActions AI-Kit Configuration Schema
|
schema-store
|
schema_store_28
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/aiconfig-1.0.json\",\"additionalProperties\":{},\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"Friendly name descriptor for the AIConfig. Could default to the filename if not specified.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the AIConfig.\\nIf you have a collection of different AIConfigs, this may be used for dynamic prompt routing.\",\"type\":\"string\"},\"schema_version\":{\"$ref\":\"#/definitions/SchemaVersion\",\"description\":\"The version of the AIConfig schema.\"},\"metadata\":{\"description\":\"Root-level metadata that applies to the entire AIConfig.\",\"type\":\"object\",\"additionalProperties\":{},\"properties\":{\"parameters\":{\"description\":\"Parameter definitions that are accessible to all prompts in this AIConfig.\\nThese parameters can be referenced in the prompts using {{param_name}} handlebars syntax.\\nFor more information, see https://handlebarsjs.com/guide/#basic-usage.\",\"type\":\"object\",\"additionalProperties\":{}},\"models\":{\"description\":\"Globally defined model settings. Any prompts that use these models will have these settings applied by default,\\nunless they override them with their own model settings.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":{}}},\"default_model\":{\"description\":\"Default model to use for prompts that do not specify a model.\",\"type\":\"string\"},\"model_parsers\":{\"description\":\"Model ID to ModelParser ID mapping.\\nThis is useful if you want to use a custom ModelParser for a model, or if a single ModelParser can handle multiple models.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}}},\"prompts\":{\"description\":\"Array of prompts that make up the AIConfig.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"A unique identifier for the prompt. This is used to reference the prompt in other parts of the AIConfig (such as other prompts)\",\"type\":\"string\"},\"input\":{\"$ref\":\"#/definitions/PromptInput\",\"description\":\"The prompt string, or a more complex prompt object.\"},\"metadata\":{\"type\":\"object\",\"additionalProperties\":{},\"properties\":{\"parameters\":{\"description\":\"Parameter definitions that are accessible to this prompt.\\nThese parameters can be referenced in the prompt using {{param_name}} handlebars syntax.\\nFor more information, see https://handlebarsjs.com/guide/#basic-usage.\",\"type\":\"object\",\"additionalProperties\":{}},\"model\":{\"description\":\"Model name/settings that apply to this prompt.\\nThese settings override any global model settings that may have been defined in the AIConfig metadata.\\nIf this is a string, it is assumed to be the model name.\\nIf this is undefined, the default model specified in the default_model property will be used for this Prompt.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The ID of the model to use.\",\"type\":\"string\"},\"settings\":{\"description\":\"Model inference settings that apply to this prompt.\",\"type\":\"object\",\"additionalProperties\":{}}},\"required\":[\"name\"]},{\"type\":\"string\"}]},\"tags\":{\"description\":\"Tags for this prompt. Tags must be unique, and must not contain commas.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"outputs\":{\"description\":\"Execution, display, or stream outputs.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Output\"}}},\"required\":[\"input\",\"name\"]}}},\"required\":[\"metadata\",\"name\",\"prompts\",\"schema_version\"],\"definitions\":{\"SchemaVersion\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"major\":{\"type\":\"number\"},\"minor\":{\"type\":\"number\"}},\"required\":[\"major\",\"minor\"]},{\"enum\":[\"latest\",\"v1\"],\"type\":\"string\"}]},\"PromptInput\":{\"anyOf\":[{\"type\":\"object\",\"additionalProperties\":{},\"properties\":{\"data\":{\"description\":\"Input to the model. This can represent a single input, or multiple inputs.\\nThe structure of the data object is up to the ModelParser. Attachments field should be leveraged for non-text inputs (e.g. image, audio).\"},\"attachments\":{\"description\":\"Used to include non-text inputs (e.g. image, audio) of specified MIME types in the prompt\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Attachment\"}}}},{\"type\":\"string\"}]},\"Attachment\":{\"description\":\"Data of specified MIME type to attach to a prompt\",\"type\":\"object\",\"required\":[\"data\"],\"properties\":{\"mime_type\":{\"description\":\"MIME type of the attachment. If not specified, the MIME type will be assumed to be text/plain.\",\"type\":\"string\"},\"data\":{\"description\":\"Data representing the attachment\"},\"metadata\":{\"description\":\"Attachment metadata.\",\"type\":\"object\",\"additionalProperties\":{}}}},\"Output\":{\"description\":\"Model inference result.\",\"anyOf\":[{\"description\":\"Result of executing a prompt.\",\"type\":\"object\",\"properties\":{\"output_type\":{\"description\":\"Type of output.\",\"type\":\"string\",\"const\":\"execute_result\"},\"execution_count\":{\"description\":\"A result's prompt number.\",\"type\":\"number\"},\"data\":{\"description\":\"The result of executing the prompt.\"},\"mime_type\":{\"description\":\"The MIME type of the result. If not specified, the MIME type will be assumed to be plain text.\",\"type\":\"string\"},\"metadata\":{\"description\":\"Output metadata.\",\"type\":\"object\",\"additionalProperties\":{}}},\"required\":[\"data\",\"output_type\"]},{\"description\":\"Output of an error that occurred during inference.\",\"type\":\"object\",\"properties\":{\"output_type\":{\"description\":\"Type of output.\",\"type\":\"string\",\"const\":\"error\"},\"ename\":{\"description\":\"The name of the error.\",\"type\":\"string\"},\"evalue\":{\"description\":\"The value, or message, of the error.\",\"type\":\"string\"},\"traceback\":{\"description\":\"The error's traceback, represented as an array of strings.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[\"ename\",\"evalue\",\"output_type\",\"traceback\"]}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aiconfig-1.0\". Here are the required top‑level fields: metadata, name, prompts, schema_version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/aiconfig-1.0.json","additionalProperties":{},"type":"object","properties":{"name":{"description":"Friendly name descriptor for the AIConfig. Could default to the filename if not specified.","type":"string"},"description":{"description":"Description of the AIConfig.\nIf you have a collection of different AIConfigs, this may be used for dynamic prompt routing.","type":"string"},"schema_version":{"$ref":"#/definitions/SchemaVersion","description":"The version of the AIConfig schema."},"metadata":{"description":"Root-level metadata that applies to the entire AIConfig.","type":"object","additionalProperties":{},"properties":{"parameters":{"description":"Parameter definitions that are accessible to all prompts in this AIConfig.\nThese parameters can be referenced in the prompts using {{param_name}} handlebars syntax.\nFor more information, see https://handlebarsjs.com/guide/#basic-usage.","type":"object","additionalProperties":{}},"models":{"description":"Globally defined model settings. Any prompts that use these models will have these settings applied by default,\nunless they override them with their own model settings.","type":"object","additionalProperties":{"type":"object","additionalProperties":{}}},"default_model":{"description":"Default model to use for prompts that do not specify a model.","type":"string"},"model_parsers":{"description":"Model ID to ModelParser ID mapping.\nThis is useful if you want to use a custom ModelParser for a model, or if a single ModelParser can handle multiple models.","type":"object","additionalProperties":{"type":"string"}}}},"prompts":{"description":"Array of prompts that make up the AIConfig.","type":"array","items":{"type":"object","properties":{"name":{"description":"A unique identifier for the prompt. This is used to reference the prompt in other parts of the AIConfig (such as other prompts)","type":"string"},"input":{"$ref":"#/definitions/PromptInput","description":"The prompt string, or a more complex prompt object."},"metadata":{"type":"object","additionalProperties":{},"properties":{"parameters":{"description":"Parameter definitions that are accessible to this prompt.\nThese parameters can be referenced in the prompt using {{param_name}} handlebars syntax.\nFor more information, see https://handlebarsjs.com/guide/#basic-usage.","type":"object","additionalProperties":{}},"model":{"description":"Model name/settings that apply to this prompt.\nThese settings override any global model settings that may have been defined in the AIConfig metadata.\nIf this is a string, it is assumed to be the model name.\nIf this is undefined, the default model specified in the default_model property will be used for this Prompt.","anyOf":[{"type":"object","properties":{"name":{"description":"The ID of the model to use.","type":"string"},"settings":{"description":"Model inference settings that apply to this prompt.","type":"object","additionalProperties":{}}},"required":["name"]},{"type":"string"}]},"tags":{"description":"Tags for this prompt. Tags must be unique, and must not contain commas.","type":"array","items":{"type":"string"}}}},"outputs":{"description":"Execution, display, or stream outputs.","type":"array","items":{"$ref":"#/definitions/Output"}}},"required":["input","name"]}}},"required":["metadata","name","prompts","schema_version"],"definitions":{"SchemaVersion":{"anyOf":[{"type":"object","properties":{"major":{"type":"number"},"minor":{"type":"number"}},"required":["major","minor"]},{"enum":["latest","v1"],"type":"string"}]},"PromptInput":{"anyOf":[{"type":"object","additionalProperties":{},"properties":{"data":{"description":"Input to the model. This can represent a single input, or multiple inputs.\nThe structure of the data object is up to the ModelParser. Attachments field should be leveraged for non-text inputs (e.g. image, audio)."},"attachments":{"description":"Used to include non-text inputs (e.g. image, audio) of specified MIME types in the prompt","type":"array","items":{"$ref":"#/definitions/Attachment"}}}},{"type":"string"}]},"Attachment":{"description":"Data of specified MIME type to attach to a prompt","type":"object","required":["data"],"properties":{"mime_type":{"description":"MIME type of the attachment. If not specified, the MIME type will be assumed to be text/plain.","type":"string"},"data":{"description":"Data representing the attachment"},"metadata":{"description":"Attachment metadata.","type":"object","additionalProperties":{}}}},"Output":{"description":"Model inference result.","anyOf":[{"description":"Result of executing a prompt.","type":"object","properties":{"output_type":{"description":"Type of output.","type":"string","const":"execute_result"},"execution_count":{"description":"A result's prompt number.","type":"number"},"data":{"description":"The result of executing the prompt."},"mime_type":{"description":"The MIME type of the result. If not specified, the MIME type will be assumed to be plain text.","type":"string"},"metadata":{"description":"Output metadata.","type":"object","additionalProperties":{}}},"required":["data","output_type"]},{"description":"Output of an error that occurred during inference.","type":"object","properties":{"output_type":{"description":"Type of output.","type":"string","const":"error"},"ename":{"description":"The name of the error.","type":"string"},"evalue":{"description":"The value, or message, of the error.","type":"string"},"traceback":{"description":"The error's traceback, represented as an array of strings.","type":"array","items":{"type":"string"}}},"required":["ename","evalue","output_type","traceback"]}]}}}
|
Provide a JSON object that satisfies the schema "aiconfig-1.0". Here are the required top‑level fields: metadata, name, prompts, schema_version. Return only the valid JSON object.
|
aiconfig-1.0
|
schema-store
|
schema_store_29
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/aider-0.82.json\",\"title\":\"Aider CLI Options Schema\",\"type\":\"object\",\"properties\":{\"model\":{\"type\":\"string\",\"description\":\"Specify the model to use for the main chat. Default: None\"},\"openai-api-key\":{\"type\":\"string\",\"description\":\"Specify the OpenAI API key. Default: None\"},\"anthropic-api-key\":{\"type\":\"string\",\"description\":\"Specify the Anthropic API key. Default: None\"},\"openai-api-base\":{\"type\":\"string\",\"description\":\"Specify the api base url. Default: None\"},\"openai-api-type\":{\"type\":\"string\",\"description\":\"Specify the OpenAI API type. Default: None\"},\"openai-api-version\":{\"type\":\"string\",\"description\":\"Specify the OpenAI API version. Default: None\"},\"openai-api-deployment-id\":{\"type\":\"string\",\"description\":\"Specify the OpenAI API deployment ID. Default: None\"},\"openai-organization-id\":{\"type\":\"string\",\"description\":\"Specify the OpenAI organization ID. Default: None\"},\"set-env\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Set environment variables. Default: []\"},\"api-key\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Set an API key for a provider. Default: []\"},\"list-models\":{\"type\":\"string\",\"description\":\"List known models which match the (partial) MODEL name. Default: None\"},\"model-settings-file\":{\"type\":\"string\",\"description\":\"Specify a file with aider model settings for unknown models. Default: .aider.model.settings.yml\",\"default\":\".aider.model.settings.yml\"},\"model-metadata-file\":{\"type\":\"string\",\"description\":\"Specify a file with context window and costs for unknown models. Default: .aider.model.metadata.json\",\"default\":\".aider.model.metadata.json\"},\"alias\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Add a model alias. Default: []\"},\"reasoning-effort\":{\"type\":\"string\",\"description\":\"Set the reasoning_effort API parameter. Default: None\"},\"thinking-tokens\":{\"type\":\"string\",\"description\":\"Set the thinking token budget for models that support it. Default: None\"},\"verify-ssl\":{\"type\":\"boolean\",\"description\":\"Verify the SSL cert when connecting to models. Default: true\",\"default\":true},\"timeout\":{\"type\":\"string\",\"description\":\"Timeout in seconds for API calls. Default: None\"},\"edit-format\":{\"type\":\"string\",\"description\":\"Specify what edit format the LLM should use. Default: None\"},\"architect\":{\"type\":\"boolean\",\"description\":\"Use architect edit format for the main chat. Default: None\"},\"auto-accept-architect\":{\"type\":\"boolean\",\"description\":\"Enable/disable automatic acceptance of architect changes. Default: true\",\"default\":true},\"weak-model\":{\"type\":\"string\",\"description\":\"Specify the model to use for commit messages and chat history summarization. Default: None\"},\"editor-model\":{\"type\":\"string\",\"description\":\"Specify the model to use for editor tasks. Default: None\"},\"editor-edit-format\":{\"type\":\"string\",\"description\":\"Specify the edit format for the editor model. Default: None\"},\"show-model-warnings\":{\"type\":\"boolean\",\"description\":\"Only work with models that have meta-data available. Default: true\",\"default\":true},\"check-model-accepts-settings\":{\"type\":\"boolean\",\"description\":\"Check if model accepts settings like reasoning_effort/thinking_tokens. Default: true\",\"default\":true},\"max-chat-history-tokens\":{\"type\":\"string\",\"description\":\"Soft limit on tokens for chat history, after which summarization begins. Default: None\"},\"cache-prompts\":{\"type\":\"boolean\",\"description\":\"Enable caching of prompts. Default: false\",\"default\":false},\"cache-keepalive-pings\":{\"type\":\"string\",\"description\":\"Number of times to ping at 5min intervals to keep prompt cache warm. Default: 0\",\"default\":\"0\"},\"map-tokens\":{\"type\":\"string\",\"description\":\"Suggested number of tokens to use for repo map. Default: None\"},\"map-refresh\":{\"type\":\"string\",\"description\":\"Control how often the repo map is refreshed. Default: auto\",\"default\":\"auto\"},\"map-multiplier-no-files\":{\"type\":\"string\",\"description\":\"Multiplier for map tokens when no files are specified. Default: 2\",\"default\":\"2\"},\"input-history-file\":{\"type\":\"string\",\"description\":\"Specify the chat input history file. Default: .aider.input.history\",\"default\":\".aider.input.history\"},\"chat-history-file\":{\"type\":\"string\",\"description\":\"Specify the chat history file. Default: .aider.chat.history.md\",\"default\":\".aider.chat.history.md\"},\"restore-chat-history\":{\"type\":\"boolean\",\"description\":\"Restore the previous chat history messages. Default: false\",\"default\":false},\"llm-history-file\":{\"type\":\"string\",\"description\":\"Log the conversation with the LLM to this file. Default: None\"},\"dark-mode\":{\"type\":\"boolean\",\"description\":\"Use colors suitable for a dark terminal background. Default: false\",\"default\":false},\"light-mode\":{\"type\":\"boolean\",\"description\":\"Use colors suitable for a light terminal background. Default: false\",\"default\":false},\"pretty\":{\"type\":\"boolean\",\"description\":\"Enable/disable pretty, colorized output. Default: true\",\"default\":true},\"stream\":{\"type\":\"boolean\",\"description\":\"Enable/disable streaming responses. Default: true\",\"default\":true},\"user-input-color\":{\"type\":\"string\",\"description\":\"Set the color for user input. Default: #00cc00\",\"default\":\"#00cc00\"},\"tool-output-color\":{\"type\":\"string\",\"description\":\"Set the color for tool output. Default: None\"},\"tool-error-color\":{\"type\":\"string\",\"description\":\"Set the color for tool error messages. Default: #FF2222\",\"default\":\"#FF2222\"},\"tool-warning-color\":{\"type\":\"string\",\"description\":\"Set the color for tool warning messages. Default: #FFA500\",\"default\":\"#FFA500\"},\"assistant-output-color\":{\"type\":\"string\",\"description\":\"Set the color for assistant output. Default: #0088ff\",\"default\":\"#0088ff\"},\"completion-menu-color\":{\"type\":\"string\",\"description\":\"Set the color for the completion menu. Default: None\"},\"completion-menu-bg-color\":{\"type\":\"string\",\"description\":\"Set the background color for the completion menu. Default: None\"},\"completion-menu-current-color\":{\"type\":\"string\",\"description\":\"Set the color for the current item in the completion menu. Default: None\"},\"completion-menu-current-bg-color\":{\"type\":\"string\",\"description\":\"Set the background color for the current item in the completion menu. Default: None\"},\"code-theme\":{\"type\":\"string\",\"description\":\"Set the markdown code theme. Default: default\",\"default\":\"default\"},\"show-diffs\":{\"type\":\"boolean\",\"description\":\"Show diffs when committing changes. Default: false\",\"default\":false},\"git\":{\"type\":\"boolean\",\"description\":\"Enable/disable looking for a git repo. Default: true\",\"default\":true},\"gitignore\":{\"type\":\"boolean\",\"description\":\"Enable/disable adding .aider* to .gitignore. Default: true\",\"default\":true},\"aiderignore\":{\"type\":\"string\",\"description\":\"Specify the aider ignore file. Default: .aiderignore\",\"default\":\".aiderignore\"},\"subtree-only\":{\"type\":\"boolean\",\"description\":\"Only consider files in the current subtree of the git repository. Default: false\",\"default\":false},\"auto-commits\":{\"type\":\"boolean\",\"description\":\"Enable/disable auto commit of LLM changes. Default: true\",\"default\":true},\"dirty-commits\":{\"type\":\"boolean\",\"description\":\"Enable/disable commits when repo is found dirty. Default: true\",\"default\":true},\"attribute-author\":{\"type\":\"boolean\",\"description\":\"Attribute aider code changes in the git author name. Default: None\"},\"attribute-committer\":{\"type\":\"boolean\",\"description\":\"Attribute aider commits in the git committer name. Default: None\"},\"attribute-commit-message-author\":{\"type\":\"boolean\",\"description\":\"Prefix commit messages with \\u2018aider: \\u2018 if aider authored the changes. Default: false\",\"default\":false},\"attribute-commit-message-committer\":{\"type\":\"boolean\",\"description\":\"Prefix all commit messages with \\u2018aider: \\u2018. Default: false\",\"default\":false},\"attribute-co-authored-by\":{\"type\":\"boolean\",\"description\":\"Attribute aider edits using the Co-authored-by trailer in the commit message. Default: false\",\"default\":false},\"git-commit-verify\":{\"type\":\"boolean\",\"description\":\"Enable/disable git pre-commit hooks with \\u2013no-verify. Default: false\",\"default\":false},\"commit\":{\"type\":\"boolean\",\"description\":\"Commit all pending changes with a suitable commit message, then exit. Default: false\",\"default\":false},\"commit-prompt\":{\"type\":\"string\",\"description\":\"Specify a custom prompt for generating commit messages. Default: None\"},\"dry-run\":{\"type\":\"boolean\",\"description\":\"Perform a dry run without modifying files. Default: false\",\"default\":false},\"skip-sanity-check-repo\":{\"type\":\"boolean\",\"description\":\"Skip the sanity check for the git repository. Default: false\",\"default\":false},\"watch-files\":{\"type\":\"boolean\",\"description\":\"Enable/disable watching files for ai coding comments. Default: false\",\"default\":false},\"lint\":{\"type\":\"boolean\",\"description\":\"Lint and fix provided files, or dirty files if none provided. Default: false\",\"default\":false},\"lint-cmd\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Specify lint commands to run for different languages. Default: []\"},\"auto-lint\":{\"type\":\"boolean\",\"description\":\"Enable/disable automatic linting after changes. Default: true\",\"default\":true},\"test-cmd\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Specify command to run tests. Default: []\"},\"auto-test\":{\"type\":\"boolean\",\"description\":\"Enable/disable automatic testing after changes. Default: false\",\"default\":false},\"test\":{\"type\":\"boolean\",\"description\":\"Run tests, fix problems found and then exit. Default: false\",\"default\":false},\"analytics\":{\"type\":\"boolean\",\"description\":\"Enable/disable analytics for current session. Default: None\"},\"analytics-log\":{\"type\":\"string\",\"description\":\"Specify a file to log analytics events. Default: None\"},\"analytics-disable\":{\"type\":\"boolean\",\"description\":\"Permanently disable analytics. Default: false\",\"default\":false},\"just-check-update\":{\"type\":\"boolean\",\"description\":\"Check for updates and return status in the exit code. Default: false\",\"default\":false},\"check-update\":{\"type\":\"boolean\",\"description\":\"Check for new aider versions on launch. Default: true\",\"default\":true},\"show-release-notes\":{\"type\":\"boolean\",\"description\":\"Show release notes on first run of new version. Default: None\"},\"install-main-branch\":{\"type\":\"boolean\",\"description\":\"Install the latest version from the main branch. Default: false\",\"default\":false},\"upgrade\":{\"type\":\"boolean\",\"description\":\"Upgrade aider to the latest version from PyPI. Default: false\",\"default\":false},\"version\":{\"type\":\"boolean\",\"description\":\"Show the version number and exit. Default: None\"},\"message\":{\"type\":\"string\",\"description\":\"Specify a single message to send the LLM, process reply then exit. Default: None\"},\"message-file\":{\"type\":\"string\",\"description\":\"Specify a file containing the message to send the LLM, process reply, then exit. Default: None\"},\"gui\":{\"type\":\"boolean\",\"description\":\"Run aider in your browser. Default: false\",\"default\":false},\"copy-paste\":{\"type\":\"boolean\",\"description\":\"Enable automatic copy/paste of chat between aider and web UI. Default: false\",\"default\":false},\"apply\":{\"type\":\"string\",\"description\":\"Apply the changes from the given file instead of running the chat. Default: None\"},\"apply-clipboard-edits\":{\"type\":\"boolean\",\"description\":\"Apply clipboard contents as edits using the main model\\u2019s editor format. Default: false\",\"default\":false},\"exit\":{\"type\":\"boolean\",\"description\":\"Do all startup activities then exit before accepting user input. Default: false\",\"default\":false},\"show-repo-map\":{\"type\":\"boolean\",\"description\":\"Print the repo map and exit. Default: false\",\"default\":false},\"show-prompts\":{\"type\":\"boolean\",\"description\":\"Print the system prompts and exit. Default: false\",\"default\":false},\"voice-format\":{\"type\":\"string\",\"description\":\"Audio format for voice recording. Default: wav\",\"default\":\"wav\"},\"voice-language\":{\"type\":\"string\",\"description\":\"Specify the language for voice using ISO 639-1 code. Default: en\",\"default\":\"en\"},\"voice-input-device\":{\"type\":\"string\",\"description\":\"Specify the input device name for voice recording. Default: None\"},\"disable-playwright\":{\"type\":\"boolean\",\"description\":\"Never prompt for or attempt to install Playwright for web scraping. Default: false\",\"default\":false},\"file\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Specify a file to edit. Default: []\"},\"read\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"description\":\"Specify a read-only file. Default: []\"},\"vim\":{\"type\":\"boolean\",\"description\":\"Use VI editing mode in the terminal. Default: false\",\"default\":false},\"chat-language\":{\"type\":\"string\",\"description\":\"Specify the language to use in the chat. Default: None\"},\"yes-always\":{\"type\":\"boolean\",\"description\":\"Always say yes to every confirmation. Default: None\"},\"verbose\":{\"type\":\"boolean\",\"description\":\"Enable verbose output. Default: false\",\"default\":false},\"load\":{\"type\":\"string\",\"description\":\"Load and execute /commands from a file on launch. Default: None\"},\"encoding\":{\"type\":\"string\",\"description\":\"Specify the encoding for input and output. Default: utf-8\",\"default\":\"utf-8\"},\"line-endings\":{\"type\":\"string\",\"description\":\"Line endings to use when writing files. Default: platform\",\"default\":\"platform\"},\"config\":{\"type\":\"string\",\"description\":\"Specify the config file. Default: None\"},\"env-file\":{\"type\":\"string\",\"description\":\"Specify the .env file to load. Default: .env\",\"default\":\".env\"},\"suggest-shell-commands\":{\"type\":\"boolean\",\"description\":\"Enable/disable suggesting shell commands. Default: true\",\"default\":true},\"fancy-input\":{\"type\":\"boolean\",\"description\":\"Enable/disable fancy input with history and completion. Default: true\",\"default\":true},\"multiline\":{\"type\":\"boolean\",\"description\":\"Enable/disable multi-line input mode with Meta-Enter to submit. Default: false\",\"default\":false},\"notifications\":{\"type\":\"boolean\",\"description\":\"Enable/disable terminal bell notifications when LLM responses are ready. Default: false\",\"default\":false},\"notifications-command\":{\"type\":\"string\",\"description\":\"Specify a command to run for notifications instead of the terminal bell. Default: None\"},\"detect-urls\":{\"type\":\"boolean\",\"description\":\"Enable/disable detection and offering to add URLs to chat. Default: true\",\"default\":true},\"editor\":{\"type\":\"string\",\"description\":\"Specify which editor to use for the /editor command. Default: None\"},\"opus\":{\"type\":\"boolean\",\"description\":\"Use claude-3-opus-20240229 model for the main chat. Default: false\",\"default\":false},\"sonnet\":{\"type\":\"boolean\",\"description\":\"Use anthropic/claude-3-7-sonnet-20250219 model for the main chat. Default: false\",\"default\":false},\"haiku\":{\"type\":\"boolean\",\"description\":\"Use claude-3-5-haiku-20241022 model for the main chat. Default: false\",\"default\":false},\"mini\":{\"type\":\"boolean\",\"description\":\"Use gpt-4o-mini model for the main chat. Default: false\",\"default\":false},\"deepseek\":{\"type\":\"boolean\",\"description\":\"Use deepseek/deepseek-chat model for the main chat. Default: false\",\"default\":false},\"o1-mini\":{\"type\":\"boolean\",\"description\":\"Use o1-mini model for the main chat. Default: false\",\"default\":false},\"o1-preview\":{\"type\":\"boolean\",\"description\":\"Use o1-preview model for the main chat. Default: false\",\"default\":false},\"4\":{\"type\":\"boolean\",\"description\":\"Use gpt-4-0613 model for the main chat. Default: false\",\"default\":false},\"4o\":{\"type\":\"boolean\",\"description\":\"Use gpt-4o model for the main chat. Default: false\",\"default\":false},\"4-turbo\":{\"type\":\"boolean\",\"description\":\"Use gpt-4-1106-preview model for the main chat. Default: false\",\"default\":false},\"35turbo\":{\"type\":\"boolean\",\"description\":\"Use gpt-3.5-turbo model for the main chat. Default: false\",\"default\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Aider CLI Options Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/aider-0.82.json","title":"Aider CLI Options Schema","type":"object","properties":{"model":{"type":"string","description":"Specify the model to use for the main chat. Default: None"},"openai-api-key":{"type":"string","description":"Specify the OpenAI API key. Default: None"},"anthropic-api-key":{"type":"string","description":"Specify the Anthropic API key. Default: None"},"openai-api-base":{"type":"string","description":"Specify the api base url. Default: None"},"openai-api-type":{"type":"string","description":"Specify the OpenAI API type. Default: None"},"openai-api-version":{"type":"string","description":"Specify the OpenAI API version. Default: None"},"openai-api-deployment-id":{"type":"string","description":"Specify the OpenAI API deployment ID. Default: None"},"openai-organization-id":{"type":"string","description":"Specify the OpenAI organization ID. Default: None"},"set-env":{"type":"array","items":{"type":"string"},"description":"Set environment variables. Default: []"},"api-key":{"type":"array","items":{"type":"string"},"description":"Set an API key for a provider. Default: []"},"list-models":{"type":"string","description":"List known models which match the (partial) MODEL name. Default: None"},"model-settings-file":{"type":"string","description":"Specify a file with aider model settings for unknown models. Default: .aider.model.settings.yml","default":".aider.model.settings.yml"},"model-metadata-file":{"type":"string","description":"Specify a file with context window and costs for unknown models. Default: .aider.model.metadata.json","default":".aider.model.metadata.json"},"alias":{"type":"array","items":{"type":"string"},"description":"Add a model alias. Default: []"},"reasoning-effort":{"type":"string","description":"Set the reasoning_effort API parameter. Default: None"},"thinking-tokens":{"type":"string","description":"Set the thinking token budget for models that support it. Default: None"},"verify-ssl":{"type":"boolean","description":"Verify the SSL cert when connecting to models. Default: true","default":true},"timeout":{"type":"string","description":"Timeout in seconds for API calls. Default: None"},"edit-format":{"type":"string","description":"Specify what edit format the LLM should use. Default: None"},"architect":{"type":"boolean","description":"Use architect edit format for the main chat. Default: None"},"auto-accept-architect":{"type":"boolean","description":"Enable/disable automatic acceptance of architect changes. Default: true","default":true},"weak-model":{"type":"string","description":"Specify the model to use for commit messages and chat history summarization. Default: None"},"editor-model":{"type":"string","description":"Specify the model to use for editor tasks. Default: None"},"editor-edit-format":{"type":"string","description":"Specify the edit format for the editor model. Default: None"},"show-model-warnings":{"type":"boolean","description":"Only work with models that have meta-data available. Default: true","default":true},"check-model-accepts-settings":{"type":"boolean","description":"Check if model accepts settings like reasoning_effort/thinking_tokens. Default: true","default":true},"max-chat-history-tokens":{"type":"string","description":"Soft limit on tokens for chat history, after which summarization begins. Default: None"},"cache-prompts":{"type":"boolean","description":"Enable caching of prompts. Default: false","default":false},"cache-keepalive-pings":{"type":"string","description":"Number of times to ping at 5min intervals to keep prompt cache warm. Default: 0","default":"0"},"map-tokens":{"type":"string","description":"Suggested number of tokens to use for repo map. Default: None"},"map-refresh":{"type":"string","description":"Control how often the repo map is refreshed. Default: auto","default":"auto"},"map-multiplier-no-files":{"type":"string","description":"Multiplier for map tokens when no files are specified. Default: 2","default":"2"},"input-history-file":{"type":"string","description":"Specify the chat input history file. Default: .aider.input.history","default":".aider.input.history"},"chat-history-file":{"type":"string","description":"Specify the chat history file. Default: .aider.chat.history.md","default":".aider.chat.history.md"},"restore-chat-history":{"type":"boolean","description":"Restore the previous chat history messages. Default: false","default":false},"llm-history-file":{"type":"string","description":"Log the conversation with the LLM to this file. Default: None"},"dark-mode":{"type":"boolean","description":"Use colors suitable for a dark terminal background. Default: false","default":false},"light-mode":{"type":"boolean","description":"Use colors suitable for a light terminal background. Default: false","default":false},"pretty":{"type":"boolean","description":"Enable/disable pretty, colorized output. Default: true","default":true},"stream":{"type":"boolean","description":"Enable/disable streaming responses. Default: true","default":true},"user-input-color":{"type":"string","description":"Set the color for user input. Default: #00cc00","default":"#00cc00"},"tool-output-color":{"type":"string","description":"Set the color for tool output. Default: None"},"tool-error-color":{"type":"string","description":"Set the color for tool error messages. Default: #FF2222","default":"#FF2222"},"tool-warning-color":{"type":"string","description":"Set the color for tool warning messages. Default: #FFA500","default":"#FFA500"},"assistant-output-color":{"type":"string","description":"Set the color for assistant output. Default: #0088ff","default":"#0088ff"},"completion-menu-color":{"type":"string","description":"Set the color for the completion menu. Default: None"},"completion-menu-bg-color":{"type":"string","description":"Set the background color for the completion menu. Default: None"},"completion-menu-current-color":{"type":"string","description":"Set the color for the current item in the completion menu. Default: None"},"completion-menu-current-bg-color":{"type":"string","description":"Set the background color for the current item in the completion menu. Default: None"},"code-theme":{"type":"string","description":"Set the markdown code theme. Default: default","default":"default"},"show-diffs":{"type":"boolean","description":"Show diffs when committing changes. Default: false","default":false},"git":{"type":"boolean","description":"Enable/disable looking for a git repo. Default: true","default":true},"gitignore":{"type":"boolean","description":"Enable/disable adding .aider* to .gitignore. Default: true","default":true},"aiderignore":{"type":"string","description":"Specify the aider ignore file. Default: .aiderignore","default":".aiderignore"},"subtree-only":{"type":"boolean","description":"Only consider files in the current subtree of the git repository. Default: false","default":false},"auto-commits":{"type":"boolean","description":"Enable/disable auto commit of LLM changes. Default: true","default":true},"dirty-commits":{"type":"boolean","description":"Enable/disable commits when repo is found dirty. Default: true","default":true},"attribute-author":{"type":"boolean","description":"Attribute aider code changes in the git author name. Default: None"},"attribute-committer":{"type":"boolean","description":"Attribute aider commits in the git committer name. Default: None"},"attribute-commit-message-author":{"type":"boolean","description":"Prefix commit messages with \u2018aider: \u2018 if aider authored the changes. Default: false","default":false},"attribute-commit-message-committer":{"type":"boolean","description":"Prefix all commit messages with \u2018aider: \u2018. Default: false","default":false},"attribute-co-authored-by":{"type":"boolean","description":"Attribute aider edits using the Co-authored-by trailer in the commit message. Default: false","default":false},"git-commit-verify":{"type":"boolean","description":"Enable/disable git pre-commit hooks with \u2013no-verify. Default: false","default":false},"commit":{"type":"boolean","description":"Commit all pending changes with a suitable commit message, then exit. Default: false","default":false},"commit-prompt":{"type":"string","description":"Specify a custom prompt for generating commit messages. Default: None"},"dry-run":{"type":"boolean","description":"Perform a dry run without modifying files. Default: false","default":false},"skip-sanity-check-repo":{"type":"boolean","description":"Skip the sanity check for the git repository. Default: false","default":false},"watch-files":{"type":"boolean","description":"Enable/disable watching files for ai coding comments. Default: false","default":false},"lint":{"type":"boolean","description":"Lint and fix provided files, or dirty files if none provided. Default: false","default":false},"lint-cmd":{"type":"array","items":{"type":"string"},"description":"Specify lint commands to run for different languages. Default: []"},"auto-lint":{"type":"boolean","description":"Enable/disable automatic linting after changes. Default: true","default":true},"test-cmd":{"type":"array","items":{"type":"string"},"description":"Specify command to run tests. Default: []"},"auto-test":{"type":"boolean","description":"Enable/disable automatic testing after changes. Default: false","default":false},"test":{"type":"boolean","description":"Run tests, fix problems found and then exit. Default: false","default":false},"analytics":{"type":"boolean","description":"Enable/disable analytics for current session. Default: None"},"analytics-log":{"type":"string","description":"Specify a file to log analytics events. Default: None"},"analytics-disable":{"type":"boolean","description":"Permanently disable analytics. Default: false","default":false},"just-check-update":{"type":"boolean","description":"Check for updates and return status in the exit code. Default: false","default":false},"check-update":{"type":"boolean","description":"Check for new aider versions on launch. Default: true","default":true},"show-release-notes":{"type":"boolean","description":"Show release notes on first run of new version. Default: None"},"install-main-branch":{"type":"boolean","description":"Install the latest version from the main branch. Default: false","default":false},"upgrade":{"type":"boolean","description":"Upgrade aider to the latest version from PyPI. Default: false","default":false},"version":{"type":"boolean","description":"Show the version number and exit. Default: None"},"message":{"type":"string","description":"Specify a single message to send the LLM, process reply then exit. Default: None"},"message-file":{"type":"string","description":"Specify a file containing the message to send the LLM, process reply, then exit. Default: None"},"gui":{"type":"boolean","description":"Run aider in your browser. Default: false","default":false},"copy-paste":{"type":"boolean","description":"Enable automatic copy/paste of chat between aider and web UI. Default: false","default":false},"apply":{"type":"string","description":"Apply the changes from the given file instead of running the chat. Default: None"},"apply-clipboard-edits":{"type":"boolean","description":"Apply clipboard contents as edits using the main model\u2019s editor format. Default: false","default":false},"exit":{"type":"boolean","description":"Do all startup activities then exit before accepting user input. Default: false","default":false},"show-repo-map":{"type":"boolean","description":"Print the repo map and exit. Default: false","default":false},"show-prompts":{"type":"boolean","description":"Print the system prompts and exit. Default: false","default":false},"voice-format":{"type":"string","description":"Audio format for voice recording. Default: wav","default":"wav"},"voice-language":{"type":"string","description":"Specify the language for voice using ISO 639-1 code. Default: en","default":"en"},"voice-input-device":{"type":"string","description":"Specify the input device name for voice recording. Default: None"},"disable-playwright":{"type":"boolean","description":"Never prompt for or attempt to install Playwright for web scraping. Default: false","default":false},"file":{"type":"array","items":{"type":"string"},"description":"Specify a file to edit. Default: []"},"read":{"type":"array","items":{"type":"string"},"description":"Specify a read-only file. Default: []"},"vim":{"type":"boolean","description":"Use VI editing mode in the terminal. Default: false","default":false},"chat-language":{"type":"string","description":"Specify the language to use in the chat. Default: None"},"yes-always":{"type":"boolean","description":"Always say yes to every confirmation. Default: None"},"verbose":{"type":"boolean","description":"Enable verbose output. Default: false","default":false},"load":{"type":"string","description":"Load and execute /commands from a file on launch. Default: None"},"encoding":{"type":"string","description":"Specify the encoding for input and output. Default: utf-8","default":"utf-8"},"line-endings":{"type":"string","description":"Line endings to use when writing files. Default: platform","default":"platform"},"config":{"type":"string","description":"Specify the config file. Default: None"},"env-file":{"type":"string","description":"Specify the .env file to load. Default: .env","default":".env"},"suggest-shell-commands":{"type":"boolean","description":"Enable/disable suggesting shell commands. Default: true","default":true},"fancy-input":{"type":"boolean","description":"Enable/disable fancy input with history and completion. Default: true","default":true},"multiline":{"type":"boolean","description":"Enable/disable multi-line input mode with Meta-Enter to submit. Default: false","default":false},"notifications":{"type":"boolean","description":"Enable/disable terminal bell notifications when LLM responses are ready. Default: false","default":false},"notifications-command":{"type":"string","description":"Specify a command to run for notifications instead of the terminal bell. Default: None"},"detect-urls":{"type":"boolean","description":"Enable/disable detection and offering to add URLs to chat. Default: true","default":true},"editor":{"type":"string","description":"Specify which editor to use for the /editor command. Default: None"},"opus":{"type":"boolean","description":"Use claude-3-opus-20240229 model for the main chat. Default: false","default":false},"sonnet":{"type":"boolean","description":"Use anthropic/claude-3-7-sonnet-20250219 model for the main chat. Default: false","default":false},"haiku":{"type":"boolean","description":"Use claude-3-5-haiku-20241022 model for the main chat. Default: false","default":false},"mini":{"type":"boolean","description":"Use gpt-4o-mini model for the main chat. Default: false","default":false},"deepseek":{"type":"boolean","description":"Use deepseek/deepseek-chat model for the main chat. Default: false","default":false},"o1-mini":{"type":"boolean","description":"Use o1-mini model for the main chat. Default: false","default":false},"o1-preview":{"type":"boolean","description":"Use o1-preview model for the main chat. Default: false","default":false},"4":{"type":"boolean","description":"Use gpt-4-0613 model for the main chat. Default: false","default":false},"4o":{"type":"boolean","description":"Use gpt-4o model for the main chat. Default: false","default":false},"4-turbo":{"type":"boolean","description":"Use gpt-4-1106-preview model for the main chat. Default: false","default":false},"35turbo":{"type":"boolean","description":"Use gpt-3.5-turbo model for the main chat. Default: false","default":false}}}
|
Provide a JSON object that satisfies the schema "Aider CLI Options Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Aider CLI Options Schema
|
schema-store
|
schema_store_30
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"description\":\"Settings for project analysis by the Application Inspector\",\"id\":\"https://json.schemastore.org/aiproj-1.6.json\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"Version\":{\"type\":\"string\",\"enum\":[\"1.0\",\"1.1\",\"1.2\",\"1.3\",\"1.4\",\"1.5\",\"1.6\"]},\"BlackBoxSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Black box and autocheck options\",\"additionalProperties\":false,\"properties\":{\"AdditionalHttpHeaders\":{\"title\":\"Additional HTTP headers\",\"description\":\"Dictionary of additional HTTP headers\",\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"object\",\"properties\":{\"Key\":{\"title\":\"Header\",\"type\":\"string\"},\"Value\":{\"type\":\"string\",\"title\":\"value\"}}}},\"WhiteListedAddresses\":{\"type\":[\"array\",\"null\"],\"title\":\"Whitelisted addresses\",\"description\":\"Addresses, that was added in white list\",\"items\":{\"type\":\"object\",\"properties\":{\"Address\":{\"title\":\"Address\",\"description\":\"Address value\",\"type\":\"string\"},\"Format\":{\"type\":\"string\",\"title\":\"Address format\",\"description\":\"Type of address\",\"enum\":[\"Wildcard\",\"ExactMatch\",\"RegExp\"]}}}},\"BlackListedAddresses\":{\"type\":[\"array\",\"null\"],\"title\":\"Blacklisted addresses\",\"description\":\"Addresses, that was added in black list\",\"items\":{\"type\":\"object\",\"properties\":{\"Address\":{\"title\":\"Address\",\"description\":\"Address value\",\"type\":\"string\"},\"Format\":{\"type\":\"string\",\"title\":\"Address format\",\"description\":\"Type of address\",\"enum\":[\"Wildcard\",\"ExactMatch\",\"RegExp\"]}}}},\"Authentication\":{\"oneOf\":[{\"type\":\"object\",\"required\":[\"Cookie\",\"Type\"],\"properties\":{\"Type\":{\"enum\":[\"RawCookie\"]},\"Cookie\":{\"type\":\"object\"}}},{\"type\":\"object\",\"required\":[\"Form\",\"Type\"],\"properties\":{\"Type\":{\"enum\":[\"Form\"]},\"Form\":{\"type\":\"object\"}}},{\"type\":\"object\",\"required\":[\"Http\",\"Type\"],\"properties\":{\"Type\":{\"enum\":[\"Http\"]},\"Http\":{\"type\":\"object\"}}},{\"type\":\"object\",\"required\":[\"Type\"],\"properties\":{\"Type\":{\"enum\":[\"None\"]}}},{\"type\":\"null\"}],\"type\":[\"object\",\"null\"],\"title\":\"Authentication options\",\"additionalProperties\":false,\"properties\":{\"Cookie\":{\"type\":[\"object\",\"null\"],\"title\":\"Cookie options\",\"description\":\"Cookie authentication options\",\"required\":[\"Cookie\",\"ValidationAddress\",\"ValidationTemplate\"],\"additionalProperties\":false,\"properties\":{\"Cookie\":{\"title\":\"Cookie\",\"type\":\"string\"},\"ValidationAddress\":{\"title\":\"Validation address\",\"description\":\"Verification address\",\"type\":\"string\"},\"ValidationTemplate\":{\"title\":\"Validation template\",\"description\":\"String to search for\",\"type\":\"string\"}}},\"Form\":{\"type\":[\"object\",\"null\"],\"title\":\"Form\",\"description\":\"Form-based authentication options\",\"additionalProperties\":false,\"properties\":{\"FormDetection\":{\"type\":\"string\",\"title\":\"Detection\",\"description\":\"Type of form authentication detection\",\"enum\":[\"Auto\",\"Manual\"]},\"FormAddress\":{\"title\":\"Sign-in form URL\"},\"FormXPath\":{\"title\":\"Sign-in form XPath\"},\"Login\":{\"title\":\"User\"},\"LoginKey\":{\"title\":\"User identifier\"},\"Password\":{\"title\":\"Password\"},\"PasswordKey\":{\"title\":\"Password identifier\"},\"ValidationTemplate\":{\"title\":\"Validation template\",\"description\":\"String to search for\"}},\"anyOf\":[{\"properties\":{\"FormDetection\":{\"enum\":[\"Auto\"]},\"FormAddress\":{\"type\":[\"string\"]},\"FormXPath\":{\"type\":[\"null\",\"string\"]},\"Login\":{\"type\":\"string\"},\"LoginKey\":{\"type\":[\"null\",\"string\"]},\"Password\":{\"type\":\"string\"},\"PasswordKey\":{\"type\":[\"null\",\"string\"]},\"ValidationTemplate\":{\"type\":[\"string\"]}},\"required\":[\"FormDetection\",\"Login\",\"Password\",\"FormAddress\",\"ValidationTemplate\"]},{\"properties\":{\"FormDetection\":{\"enum\":[\"Manual\"]},\"FormAddress\":{\"type\":[\"string\"]},\"FormXPath\":{\"type\":[\"string\"]},\"Login\":{\"type\":\"string\"},\"LoginKey\":{\"type\":[\"string\"]},\"Password\":{\"type\":\"string\"},\"PasswordKey\":{\"type\":[\"string\"]},\"ValidationTemplate\":{\"type\":[\"string\"]}},\"required\":[\"FormDetection\",\"Login\",\"Password\",\"FormAddress\",\"ValidationTemplate\",\"LoginKey\",\"PasswordKey\",\"FormXPath\"]}]},\"Http\":{\"type\":[\"object\",\"null\"],\"title\":\"Http\",\"description\":\"HTTP Basic authentication options\",\"additionalProperties\":false,\"required\":[\"Login\",\"Password\",\"ValidationAddress\"],\"properties\":{\"Login\":{\"title\":\"User\",\"type\":\"string\"},\"Password\":{\"title\":\"Password\",\"type\":\"string\"},\"ValidationAddress\":{\"title\":\"Validation address\",\"type\":\"string\"}}},\"Type\":{\"title\":\"Type of authentication\",\"type\":\"string\",\"enum\":[\"Form\",\"Http\",\"RawCookie\",\"None\"]}}},\"Level\":{\"title\":\"Search mode\",\"type\":\"string\",\"enum\":[\"None\",\"Fast\",\"Full\",\"Normal\"]},\"ProxySettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Proxy settings\",\"description\":\"Proxy server settings\",\"additionalProperties\":false,\"properties\":{\"Enabled\":{\"title\":\"Enabled\",\"type\":\"boolean\"},\"Host\":{\"title\":\"Address\",\"type\":[\"null\",\"string\"]},\"Login\":{\"title\":\"User\",\"type\":[\"null\",\"string\"]},\"Password\":{\"title\":\"Password\",\"type\":[\"null\",\"string\"]},\"Port\":{\"title\":\"Port\",\"type\":\"integer\"},\"Type\":{\"title\":\"Type of proxy\",\"type\":\"string\",\"enum\":[\"Http\",\"Socks4\",\"Socks5\"]}}},\"RunAutocheckAfterScan\":{\"title\":\"Run autocheck\",\"description\":\"Autocheck vulnerabilities after scanning\",\"type\":\"boolean\"},\"ScanScope\":{\"title\":\"Scan scope\",\"type\":\"string\",\"enum\":[\"Domain\",\"Folder\",\"Path\"]},\"Site\":{\"title\":\"Website address\",\"type\":\"string\"},\"SslCheck\":{\"title\":\"Check ssl connection\",\"type\":\"boolean\"}}},\"WindowsDotNetSettings\":{\"type\":[\"object\",\"null\"],\"title\":\".NET scan options\",\"additionalProperties\":false,\"properties\":{\"ProjectType\":{\"title\":\"Type of application\",\"type\":\"string\",\"enum\":[\"None\",\"Solution\",\"WebSite\"]},\"SolutionFile\":{\"title\":\"Solution file\",\"description\":\"Path to a solution or project\",\"type\":[\"null\",\"string\"]},\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"DownloadDependencies\":{\"title\":\"Download dependencies\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom DotNet kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"DotNetSettings\":{\"type\":[\"object\",\"null\"],\"title\":\".NET scan options\",\"additionalProperties\":false,\"properties\":{\"ProjectType\":{\"title\":\"Type of application\",\"type\":\"string\",\"enum\":[\"None\",\"Solution\",\"WebSite\"]},\"SolutionFile\":{\"title\":\"Solution file\",\"description\":\"Path to a solution or project\",\"type\":[\"null\",\"string\"]},\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"DownloadDependencies\":{\"title\":\"Download dependencies\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom DotNet kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"GoSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Go scan options\",\"additionalProperties\":false,\"properties\":{\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom Go kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"JavaSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Java scan options\",\"additionalProperties\":false,\"properties\":{\"Parameters\":{\"title\":\"JVM start options\",\"type\":[\"null\",\"string\"]},\"UnpackUserPackages\":{\"title\":\"Unpack custom JAR files\",\"type\":\"boolean\"},\"UserPackagePrefixes\":{\"title\":\"Prefixes of custom packages\",\"type\":[\"null\",\"string\"]},\"Version\":{\"title\":\"JDK version\",\"type\":\"string\",\"enum\":[\"8\",\"11\",\"17\",\"21\"]},\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"DownloadDependencies\":{\"title\":\"Download dependencies\",\"type\":[\"null\",\"boolean\"]},\"DependenciesPath\":{\"title\":\"Dependencies path\",\"description\":\"Path that the Java kernel will use as a classPath\",\"type\":[\"null\",\"string\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom Java kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"JavaScriptSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"JavaScript scan options\",\"additionalProperties\":false,\"properties\":{\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"UseTaintAnalysis\":{\"title\":\"Use taint analysis method\",\"type\":[\"null\",\"boolean\"]},\"UseJsaAnalysis\":{\"title\":\"Use jsa core for analysis\",\"type\":[\"null\",\"boolean\"]},\"DownloadDependencies\":{\"title\":\"Download dependencies\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom JavaScript kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"PhpSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Php scan options\",\"additionalProperties\":false,\"properties\":{\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"DownloadDependencies\":{\"title\":\"Download dependencies\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom Php kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"PmTaintSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"PmTaint scan options\",\"additionalProperties\":false,\"properties\":{\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom PmTaint kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"PygrepSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Pygrep scan options\",\"additionalProperties\":false,\"properties\":{\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom Pygrep kernel startup parameters\",\"type\":[\"null\",\"string\"]},\"RulesDirPath\":{\"title\":\"Custom rules\",\"description\":\"Path to the custom rules directory\",\"type\":[\"null\",\"string\"]}}},\"PythonSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Python scan options\",\"additionalProperties\":false,\"properties\":{\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"DownloadDependencies\":{\"title\":\"Download dependencies\",\"type\":[\"null\",\"boolean\"]},\"DependenciesPath\":{\"title\":\"Dependencies path\",\"description\":\"Path to venv or path to directory with dependencies if venv was not used to restore them\",\"type\":[\"null\",\"string\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom Python kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"MailingProjectSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Mail settings\",\"description\":\"Report mailing options\",\"additionalProperties\":false,\"properties\":{\"Enabled\":{\"title\":\"Send a report by email after scanning\",\"type\":\"boolean\"},\"MailProfileName\":{\"title\":\"Email profile name\",\"type\":[\"null\",\"string\"]},\"EmailRecipients\":{\"title\":\"List of recipients\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"email\"}}},\"oneOf\":[{\"type\":\"object\",\"properties\":{\"Enabled\":{\"enum\":[true]},\"MailProfileName\":{\"type\":\"string\",\"minLength\":1},\"EmailRecipients\":{\"type\":\"array\",\"minItems\":1,\"maxItems\":10}},\"required\":[\"Enabled\",\"MailProfileName\",\"EmailRecipients\"]},{\"properties\":{\"Enabled\":{\"enum\":[false]},\"MailProfileName\":{\"type\":[\"null\",\"string\"]},\"EmailRecipients\":{\"type\":\"array\",\"minItems\":0,\"maxItems\":10}},\"required\":[\"Enabled\"]}]},\"RubySettings\":{\"type\":[\"object\",\"null\"],\"title\":\"Ruby scan options\",\"additionalProperties\":false,\"properties\":{\"UsePublicAnalysisMethod\":{\"title\":\"Use public analysis method\",\"type\":[\"null\",\"boolean\"]},\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom Ruby kernel startup parameters\",\"type\":[\"null\",\"string\"]}}},\"ScaSettings\":{\"type\":[\"object\",\"null\"],\"title\":\"SCA scan options\",\"additionalProperties\":false,\"properties\":{\"CustomParameters\":{\"title\":\"Custom parameters\",\"description\":\"Custom SCA kernel startup parameters\",\"type\":[\"null\",\"string\"]},\"BuildDependenciesGraph\":{\"title\":\"Build bependencies graph\",\"type\":[\"null\",\"boolean\"]}}},\"ProgrammingLanguages\":{\"title\":\"Active scanning languages\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"enum\":[\"Java\",\"CSharp (Windows, Linux)\",\"CSharp (Windows)\",\"VB\",\"Php\",\"JavaScript\",\"Python\",\"ObjectiveC\",\"Swift\",\"CAndCPlusPlus\",\"Go\",\"Kotlin\",\"Sql\",\"Ruby\",\"Solidity\"]}},\"ProjectName\":{\"title\":\"Project name\",\"type\":\"string\"},\"ScanModules\":{\"title\":\"Enabled modules\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"enum\":[\"Configuration\",\"Components\",\"BlackBox\",\"PatternMatching\",\"StaticCodeAnalysis\",\"SoftwareCompositionAnalysis\"]}},\"Tags\":{\"title\":\"Project tags\",\"type\":[\"array\",\"null\"],\"uniqueItems\":true,\"items\":{\"additionalProperties\":false,\"type\":\"object\",\"properties\":{\"Type\":{\"type\":\"string\",\"enum\":[\"Repo\",\"Branch\"]},\"Value\":{\"type\":\"string\"}}}},\"SkipGitIgnoreFiles\":{\"title\":\"Skip .gitignore files\",\"description\":\"Exclude from scanning the files from the .gitignore file\",\"type\":\"boolean\"},\"UseSastRules\":{\"title\":\"Use SAST rules\",\"description\":\"Enable SAST Analysis rules\",\"type\":\"boolean\"},\"UseCustomPmRules\":{\"title\":\"Use custom PM rules\",\"description\":\"Enable custom PM rules\",\"type\":\"boolean\"},\"UseSecurityPolicies\":{\"title\":\"Use security policies\",\"description\":\"Check for compliance with the security policy\",\"type\":\"boolean\"}},\"required\":[\"ProjectName\",\"ProgrammingLanguages\",\"ScanModules\"],\"title\":\"aiproj\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aiproj\". Here are the required top‑level fields: ProjectName, ProgrammingLanguages, ScanModules. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"Settings for project analysis by the Application Inspector","id":"https://json.schemastore.org/aiproj-1.6.json","properties":{"$schema":{"type":"string"},"Version":{"type":"string","enum":["1.0","1.1","1.2","1.3","1.4","1.5","1.6"]},"BlackBoxSettings":{"type":["object","null"],"title":"Black box and autocheck options","additionalProperties":false,"properties":{"AdditionalHttpHeaders":{"title":"Additional HTTP headers","description":"Dictionary of additional HTTP headers","type":["array","null"],"items":{"type":"object","properties":{"Key":{"title":"Header","type":"string"},"Value":{"type":"string","title":"value"}}}},"WhiteListedAddresses":{"type":["array","null"],"title":"Whitelisted addresses","description":"Addresses, that was added in white list","items":{"type":"object","properties":{"Address":{"title":"Address","description":"Address value","type":"string"},"Format":{"type":"string","title":"Address format","description":"Type of address","enum":["Wildcard","ExactMatch","RegExp"]}}}},"BlackListedAddresses":{"type":["array","null"],"title":"Blacklisted addresses","description":"Addresses, that was added in black list","items":{"type":"object","properties":{"Address":{"title":"Address","description":"Address value","type":"string"},"Format":{"type":"string","title":"Address format","description":"Type of address","enum":["Wildcard","ExactMatch","RegExp"]}}}},"Authentication":{"oneOf":[{"type":"object","required":["Cookie","Type"],"properties":{"Type":{"enum":["RawCookie"]},"Cookie":{"type":"object"}}},{"type":"object","required":["Form","Type"],"properties":{"Type":{"enum":["Form"]},"Form":{"type":"object"}}},{"type":"object","required":["Http","Type"],"properties":{"Type":{"enum":["Http"]},"Http":{"type":"object"}}},{"type":"object","required":["Type"],"properties":{"Type":{"enum":["None"]}}},{"type":"null"}],"type":["object","null"],"title":"Authentication options","additionalProperties":false,"properties":{"Cookie":{"type":["object","null"],"title":"Cookie options","description":"Cookie authentication options","required":["Cookie","ValidationAddress","ValidationTemplate"],"additionalProperties":false,"properties":{"Cookie":{"title":"Cookie","type":"string"},"ValidationAddress":{"title":"Validation address","description":"Verification address","type":"string"},"ValidationTemplate":{"title":"Validation template","description":"String to search for","type":"string"}}},"Form":{"type":["object","null"],"title":"Form","description":"Form-based authentication options","additionalProperties":false,"properties":{"FormDetection":{"type":"string","title":"Detection","description":"Type of form authentication detection","enum":["Auto","Manual"]},"FormAddress":{"title":"Sign-in form URL"},"FormXPath":{"title":"Sign-in form XPath"},"Login":{"title":"User"},"LoginKey":{"title":"User identifier"},"Password":{"title":"Password"},"PasswordKey":{"title":"Password identifier"},"ValidationTemplate":{"title":"Validation template","description":"String to search for"}},"anyOf":[{"properties":{"FormDetection":{"enum":["Auto"]},"FormAddress":{"type":["string"]},"FormXPath":{"type":["null","string"]},"Login":{"type":"string"},"LoginKey":{"type":["null","string"]},"Password":{"type":"string"},"PasswordKey":{"type":["null","string"]},"ValidationTemplate":{"type":["string"]}},"required":["FormDetection","Login","Password","FormAddress","ValidationTemplate"]},{"properties":{"FormDetection":{"enum":["Manual"]},"FormAddress":{"type":["string"]},"FormXPath":{"type":["string"]},"Login":{"type":"string"},"LoginKey":{"type":["string"]},"Password":{"type":"string"},"PasswordKey":{"type":["string"]},"ValidationTemplate":{"type":["string"]}},"required":["FormDetection","Login","Password","FormAddress","ValidationTemplate","LoginKey","PasswordKey","FormXPath"]}]},"Http":{"type":["object","null"],"title":"Http","description":"HTTP Basic authentication options","additionalProperties":false,"required":["Login","Password","ValidationAddress"],"properties":{"Login":{"title":"User","type":"string"},"Password":{"title":"Password","type":"string"},"ValidationAddress":{"title":"Validation address","type":"string"}}},"Type":{"title":"Type of authentication","type":"string","enum":["Form","Http","RawCookie","None"]}}},"Level":{"title":"Search mode","type":"string","enum":["None","Fast","Full","Normal"]},"ProxySettings":{"type":["object","null"],"title":"Proxy settings","description":"Proxy server settings","additionalProperties":false,"properties":{"Enabled":{"title":"Enabled","type":"boolean"},"Host":{"title":"Address","type":["null","string"]},"Login":{"title":"User","type":["null","string"]},"Password":{"title":"Password","type":["null","string"]},"Port":{"title":"Port","type":"integer"},"Type":{"title":"Type of proxy","type":"string","enum":["Http","Socks4","Socks5"]}}},"RunAutocheckAfterScan":{"title":"Run autocheck","description":"Autocheck vulnerabilities after scanning","type":"boolean"},"ScanScope":{"title":"Scan scope","type":"string","enum":["Domain","Folder","Path"]},"Site":{"title":"Website address","type":"string"},"SslCheck":{"title":"Check ssl connection","type":"boolean"}}},"WindowsDotNetSettings":{"type":["object","null"],"title":".NET scan options","additionalProperties":false,"properties":{"ProjectType":{"title":"Type of application","type":"string","enum":["None","Solution","WebSite"]},"SolutionFile":{"title":"Solution file","description":"Path to a solution or project","type":["null","string"]},"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"DownloadDependencies":{"title":"Download dependencies","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom DotNet kernel startup parameters","type":["null","string"]}}},"DotNetSettings":{"type":["object","null"],"title":".NET scan options","additionalProperties":false,"properties":{"ProjectType":{"title":"Type of application","type":"string","enum":["None","Solution","WebSite"]},"SolutionFile":{"title":"Solution file","description":"Path to a solution or project","type":["null","string"]},"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"DownloadDependencies":{"title":"Download dependencies","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom DotNet kernel startup parameters","type":["null","string"]}}},"GoSettings":{"type":["object","null"],"title":"Go scan options","additionalProperties":false,"properties":{"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom Go kernel startup parameters","type":["null","string"]}}},"JavaSettings":{"type":["object","null"],"title":"Java scan options","additionalProperties":false,"properties":{"Parameters":{"title":"JVM start options","type":["null","string"]},"UnpackUserPackages":{"title":"Unpack custom JAR files","type":"boolean"},"UserPackagePrefixes":{"title":"Prefixes of custom packages","type":["null","string"]},"Version":{"title":"JDK version","type":"string","enum":["8","11","17","21"]},"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"DownloadDependencies":{"title":"Download dependencies","type":["null","boolean"]},"DependenciesPath":{"title":"Dependencies path","description":"Path that the Java kernel will use as a classPath","type":["null","string"]},"CustomParameters":{"title":"Custom parameters","description":"Custom Java kernel startup parameters","type":["null","string"]}}},"JavaScriptSettings":{"type":["object","null"],"title":"JavaScript scan options","additionalProperties":false,"properties":{"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"UseTaintAnalysis":{"title":"Use taint analysis method","type":["null","boolean"]},"UseJsaAnalysis":{"title":"Use jsa core for analysis","type":["null","boolean"]},"DownloadDependencies":{"title":"Download dependencies","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom JavaScript kernel startup parameters","type":["null","string"]}}},"PhpSettings":{"type":["object","null"],"title":"Php scan options","additionalProperties":false,"properties":{"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"DownloadDependencies":{"title":"Download dependencies","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom Php kernel startup parameters","type":["null","string"]}}},"PmTaintSettings":{"type":["object","null"],"title":"PmTaint scan options","additionalProperties":false,"properties":{"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom PmTaint kernel startup parameters","type":["null","string"]}}},"PygrepSettings":{"type":["object","null"],"title":"Pygrep scan options","additionalProperties":false,"properties":{"CustomParameters":{"title":"Custom parameters","description":"Custom Pygrep kernel startup parameters","type":["null","string"]},"RulesDirPath":{"title":"Custom rules","description":"Path to the custom rules directory","type":["null","string"]}}},"PythonSettings":{"type":["object","null"],"title":"Python scan options","additionalProperties":false,"properties":{"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"DownloadDependencies":{"title":"Download dependencies","type":["null","boolean"]},"DependenciesPath":{"title":"Dependencies path","description":"Path to venv or path to directory with dependencies if venv was not used to restore them","type":["null","string"]},"CustomParameters":{"title":"Custom parameters","description":"Custom Python kernel startup parameters","type":["null","string"]}}},"MailingProjectSettings":{"type":["object","null"],"title":"Mail settings","description":"Report mailing options","additionalProperties":false,"properties":{"Enabled":{"title":"Send a report by email after scanning","type":"boolean"},"MailProfileName":{"title":"Email profile name","type":["null","string"]},"EmailRecipients":{"title":"List of recipients","type":"array","items":{"type":"string","format":"email"}}},"oneOf":[{"type":"object","properties":{"Enabled":{"enum":[true]},"MailProfileName":{"type":"string","minLength":1},"EmailRecipients":{"type":"array","minItems":1,"maxItems":10}},"required":["Enabled","MailProfileName","EmailRecipients"]},{"properties":{"Enabled":{"enum":[false]},"MailProfileName":{"type":["null","string"]},"EmailRecipients":{"type":"array","minItems":0,"maxItems":10}},"required":["Enabled"]}]},"RubySettings":{"type":["object","null"],"title":"Ruby scan options","additionalProperties":false,"properties":{"UsePublicAnalysisMethod":{"title":"Use public analysis method","type":["null","boolean"]},"CustomParameters":{"title":"Custom parameters","description":"Custom Ruby kernel startup parameters","type":["null","string"]}}},"ScaSettings":{"type":["object","null"],"title":"SCA scan options","additionalProperties":false,"properties":{"CustomParameters":{"title":"Custom parameters","description":"Custom SCA kernel startup parameters","type":["null","string"]},"BuildDependenciesGraph":{"title":"Build bependencies graph","type":["null","boolean"]}}},"ProgrammingLanguages":{"title":"Active scanning languages","type":"array","uniqueItems":true,"items":{"type":"string","enum":["Java","CSharp (Windows, Linux)","CSharp (Windows)","VB","Php","JavaScript","Python","ObjectiveC","Swift","CAndCPlusPlus","Go","Kotlin","Sql","Ruby","Solidity"]}},"ProjectName":{"title":"Project name","type":"string"},"ScanModules":{"title":"Enabled modules","type":"array","uniqueItems":true,"items":{"type":"string","enum":["Configuration","Components","BlackBox","PatternMatching","StaticCodeAnalysis","SoftwareCompositionAnalysis"]}},"Tags":{"title":"Project tags","type":["array","null"],"uniqueItems":true,"items":{"additionalProperties":false,"type":"object","properties":{"Type":{"type":"string","enum":["Repo","Branch"]},"Value":{"type":"string"}}}},"SkipGitIgnoreFiles":{"title":"Skip .gitignore files","description":"Exclude from scanning the files from the .gitignore file","type":"boolean"},"UseSastRules":{"title":"Use SAST rules","description":"Enable SAST Analysis rules","type":"boolean"},"UseCustomPmRules":{"title":"Use custom PM rules","description":"Enable custom PM rules","type":"boolean"},"UseSecurityPolicies":{"title":"Use security policies","description":"Check for compliance with the security policy","type":"boolean"}},"required":["ProjectName","ProgrammingLanguages","ScanModules"],"title":"aiproj","type":"object"}
|
Provide a JSON object that satisfies the schema "aiproj". Here are the required top‑level fields: ProjectName, ProgrammingLanguages, ScanModules. Return only the valid JSON object.
|
aiproj
|
schema-store
|
schema_store_31
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"TomlOptions\",\"description\":\"The Rust representation of `air.toml`\\n\\nThe names and types of the fields in this struct determine the names and types that can be specified in the `air.toml`.\\n\\nEvery field is optional at this point, nothing is \\\"finalized\\\". Finalization is done in [TomlOptions::into_settings].\\n\\nGlobal options are specified at top level in the TOML file. All other options are nested within their own `[table]`.\",\"type\":\"object\",\"properties\":{\"format\":{\"description\":\"Options to configure code formatting.\",\"anyOf\":[{\"$ref\":\"#/definitions/FormatTomlOptions\"},{\"type\":\"null\"}]}},\"additionalProperties\":false,\"definitions\":{\"FormatTomlOptions\":{\"description\":\"Configures the way air formats your code.\",\"type\":\"object\",\"properties\":{\"default-exclude\":{\"description\":\"Air automatically excludes a default set of folders and files. If this option is set to `false`, these files will be formatted as well.\\n\\nThe default set of excluded patterns are: - `.git/` - `renv/` - `revdep/` - `cpp11.R` - `RcppExports.R` - `extendr-wrappers.R` - `import-standalone-*.R`\",\"type\":[\"boolean\",\"null\"]},\"exclude\":{\"description\":\"By default, Air will refuse to format files matched by patterns listed in `default-exclude`. Use this option to supply an additional list of exclude patterns.\\n\\nExclude patterns are modeled after what you can provide in a [.gitignore](https://git-scm.com/docs/gitignore), and are resolved relative to the parent directory that your `air.toml` is contained within. For example, if your `air.toml` was located at `root/air.toml`, then:\\n\\n- `file.R` excludes a file named `file.R` located anywhere below `root/`. This is equivalent to `**/file.R`.\\n\\n- `folder/` excludes a directory named `folder` (and all of its children) located anywhere below `root/`. You can also just use `folder`, but this would technically also match a file named `folder`, so the trailing slash is preferred when targeting directories. This is equivalent to `**/folder/`.\\n\\n- `/file.R` excludes a file named `file.R` located at `root/file.R`.\\n\\n- `/folder/` excludes a directory named `folder` (and all of its children) located at `root/folder/`.\\n\\n- `file-*.R` excludes R files named like `file-this.R` and `file-that.R` located anywhere below `root/`.\\n\\n- `folder/*.R` excludes all R files located at `root/folder/`. Note that R files in directories under `folder/` are not excluded in this case (such as `root/folder/subfolder/file.R`).\\n\\n- `folder/**/*.R` excludes all R files located anywhere below `root/folder/`.\\n\\n- `**/folder/*.R` excludes all R files located directly inside a `folder/` directory, where the `folder/` directory itself can /// appear anywhere.\\n\\nSee the full [.gitignore](https://git-scm.com/docs/gitignore) documentation for all of the patterns you can provide.\",\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\"}},\"indent-style\":{\"description\":\"Whether to use spaces or tabs for indentation.\\n\\n`indent-style = \\\"space\\\"` (default):\\n\\n```r fn <- function() { cat(\\\"Hello\\\") # Spaces indent the `cat()` call. } ```\\n\\n`indent-style = \\\"tab\\\"`:\\n\\n```r fn <- function() { cat(\\\"Hello\\\") # A tab `\\\\t` indents the `cat()` call. } ```\\n\\nAir defaults to spaces due to the overwhelming amount of existing R code written in this style, but consider using tabs for new projects to improve accessibility.\\n\\nSee `indent-width` to configure the number of spaces per indentation and the tab width.\",\"anyOf\":[{\"$ref\":\"#/definitions/IndentStyle\"},{\"type\":\"null\"}]},\"indent-width\":{\"description\":\"The number of spaces per indentation level (tab).\\n\\nThe value must be greater than or equal to `1` and less than or equal to `24`. The default value is `2`.\\n\\nUsed by the formatter to determine the visual width of a tab.\\n\\nThis option changes the number of spaces the formatter inserts when using `indent-style = \\\"space\\\"`. It also represents the width of a tab when `indent-style = \\\"tab\\\"` for the purposes of computing the `line-width`.\",\"anyOf\":[{\"$ref\":\"#/definitions/IndentWidth\"},{\"type\":\"null\"}]},\"line-ending\":{\"description\":\"The character air uses at the end of a line.\\n\\n- `auto`: The newline style is detected automatically on a file per file basis. Files with mixed line endings will be converted to the first detected line ending. Defaults to `\\\\n` for files that contain no line endings. - `lf`: Line endings will be converted to `\\\\n`. The default line ending on Unix. - `crlf`: Line endings will be converted to `\\\\r\\\\n`. The default line ending on Windows. - `native`: Line endings will be converted to `\\\\n` on Unix and `\\\\r\\\\n` on Windows.\",\"anyOf\":[{\"$ref\":\"#/definitions/LineEnding\"},{\"type\":\"null\"}]},\"line-width\":{\"description\":\"The line width at which the formatter prefers to wrap lines.\\n\\nThe value must be greater than or equal to `1` and less than or equal to `320`.\\n\\nNote: While the formatter will attempt to format lines such that they remain within the `line-width`, it isn't a hard upper bound, and formatted lines may exceed the `line-width`.\",\"anyOf\":[{\"$ref\":\"#/definitions/LineWidth\"},{\"type\":\"null\"}]},\"persistent-line-breaks\":{\"description\":\"Air respects a small set of persistent line breaks as an indication that certain function calls or function signatures should be left expanded. If this option is set to `false`, persistent line breaks are ignored.\\n\\nIt may be preferable to ignore persistent line breaks if you prefer that `line-width` should be the only value that influences line breaks.\",\"type\":[\"boolean\",\"null\"]},\"skip\":{\"description\":\"Air typically formats every function call it comes across. To skip formatting of a single one-off function call, you can use a `# fmt: skip` comment. However, if you know of particular functions that you use a lot that are part of a custom domain specific language that doesn't follow conventional formatting rules, you can entirely opt out of formatting for those functions by providing them here.\\n\\nFor example, using `skip = [\\\"graph_from_literal\\\"]` would automatically skip formatting of:\\n\\n```r igraph::graph_from_literal(Alice +--+ Bob) ```\\n\\nIn the short term, we also anticipate that this will be useful to avoid formatting of `tibble::tribble()` calls. In the long term, we may have more sophisticated features for automatically formatting using a specified alignment.\",\"anyOf\":[{\"$ref\":\"#/definitions/Skip\"},{\"type\":\"null\"}]}},\"additionalProperties\":false},\"IndentStyle\":{\"oneOf\":[{\"description\":\"Tab\",\"type\":\"string\",\"enum\":[\"tab\"]},{\"description\":\"Space\",\"type\":\"string\",\"enum\":[\"space\"]}]},\"IndentWidth\":{\"description\":\"Validated value for the `indent-width` formatter options\\n\\nThe allowed range of values is 1..=24\",\"type\":\"integer\",\"format\":\"uint8\",\"maximum\":24.0,\"minimum\":1.0},\"LineEnding\":{\"oneOf\":[{\"description\":\"The newline style is detected automatically on a file per file basis. Files with mixed line endings will be converted to the first detected line ending. Defaults to [`LineEnding::Lf`] for a files that contain no line endings.\",\"type\":\"string\",\"enum\":[\"auto\"]},{\"description\":\"Line endings will be converted to `\\\\n` as is common on Unix.\",\"type\":\"string\",\"enum\":[\"lf\"]},{\"description\":\"Line endings will be converted to `\\\\r\\\\n` as is common on Windows.\",\"type\":\"string\",\"enum\":[\"crlf\"]},{\"description\":\"Line endings will be converted to `\\\\n` on Unix and `\\\\r\\\\n` on Windows.\",\"type\":\"string\",\"enum\":[\"native\"]}]},\"LineWidth\":{\"description\":\"Validated value for the `line-width` formatter options\\n\\nThe allowed range of values is 1..=320\",\"type\":\"integer\",\"format\":\"uint16\",\"maximum\":320.0,\"minimum\":1.0},\"Skip\":{\"description\":\"Function names that are automatically skipped without the need for a `fmt: skip` comment.\\n\\n# Notes\\n\\nInternally wrapped in an [Arc] for cheap cloning, since we know the function names are immutable and can be shared. Must be an [Arc] because settings are shared across threads when doing parallel file discovery.\\n\\nClippy recommends [Arc] wrapping the immutable `[String]` over the mutable `Vec<String>` because with [Arc] you are basically promising not to mutate the inner object, and [Arc] provides a special `From<Vec<T>> for Arc<[T]>` for exactly this use case, which we invoke in [Skip::new()].\\n\\n# Safety\\n\\nThis vector is sorted at creation, for use with binary search during lookups.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"TomlOptions\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"TomlOptions","description":"The Rust representation of `air.toml`\n\nThe names and types of the fields in this struct determine the names and types that can be specified in the `air.toml`.\n\nEvery field is optional at this point, nothing is \"finalized\". Finalization is done in [TomlOptions::into_settings].\n\nGlobal options are specified at top level in the TOML file. All other options are nested within their own `[table]`.","type":"object","properties":{"format":{"description":"Options to configure code formatting.","anyOf":[{"$ref":"#/definitions/FormatTomlOptions"},{"type":"null"}]}},"additionalProperties":false,"definitions":{"FormatTomlOptions":{"description":"Configures the way air formats your code.","type":"object","properties":{"default-exclude":{"description":"Air automatically excludes a default set of folders and files. If this option is set to `false`, these files will be formatted as well.\n\nThe default set of excluded patterns are: - `.git/` - `renv/` - `revdep/` - `cpp11.R` - `RcppExports.R` - `extendr-wrappers.R` - `import-standalone-*.R`","type":["boolean","null"]},"exclude":{"description":"By default, Air will refuse to format files matched by patterns listed in `default-exclude`. Use this option to supply an additional list of exclude patterns.\n\nExclude patterns are modeled after what you can provide in a [.gitignore](https://git-scm.com/docs/gitignore), and are resolved relative to the parent directory that your `air.toml` is contained within. For example, if your `air.toml` was located at `root/air.toml`, then:\n\n- `file.R` excludes a file named `file.R` located anywhere below `root/`. This is equivalent to `**/file.R`.\n\n- `folder/` excludes a directory named `folder` (and all of its children) located anywhere below `root/`. You can also just use `folder`, but this would technically also match a file named `folder`, so the trailing slash is preferred when targeting directories. This is equivalent to `**/folder/`.\n\n- `/file.R` excludes a file named `file.R` located at `root/file.R`.\n\n- `/folder/` excludes a directory named `folder` (and all of its children) located at `root/folder/`.\n\n- `file-*.R` excludes R files named like `file-this.R` and `file-that.R` located anywhere below `root/`.\n\n- `folder/*.R` excludes all R files located at `root/folder/`. Note that R files in directories under `folder/` are not excluded in this case (such as `root/folder/subfolder/file.R`).\n\n- `folder/**/*.R` excludes all R files located anywhere below `root/folder/`.\n\n- `**/folder/*.R` excludes all R files located directly inside a `folder/` directory, where the `folder/` directory itself can /// appear anywhere.\n\nSee the full [.gitignore](https://git-scm.com/docs/gitignore) documentation for all of the patterns you can provide.","type":["array","null"],"items":{"type":"string"}},"indent-style":{"description":"Whether to use spaces or tabs for indentation.\n\n`indent-style = \"space\"` (default):\n\n```r fn <- function() { cat(\"Hello\") # Spaces indent the `cat()` call. } ```\n\n`indent-style = \"tab\"`:\n\n```r fn <- function() { cat(\"Hello\") # A tab `\\t` indents the `cat()` call. } ```\n\nAir defaults to spaces due to the overwhelming amount of existing R code written in this style, but consider using tabs for new projects to improve accessibility.\n\nSee `indent-width` to configure the number of spaces per indentation and the tab width.","anyOf":[{"$ref":"#/definitions/IndentStyle"},{"type":"null"}]},"indent-width":{"description":"The number of spaces per indentation level (tab).\n\nThe value must be greater than or equal to `1` and less than or equal to `24`. The default value is `2`.\n\nUsed by the formatter to determine the visual width of a tab.\n\nThis option changes the number of spaces the formatter inserts when using `indent-style = \"space\"`. It also represents the width of a tab when `indent-style = \"tab\"` for the purposes of computing the `line-width`.","anyOf":[{"$ref":"#/definitions/IndentWidth"},{"type":"null"}]},"line-ending":{"description":"The character air uses at the end of a line.\n\n- `auto`: The newline style is detected automatically on a file per file basis. Files with mixed line endings will be converted to the first detected line ending. Defaults to `\\n` for files that contain no line endings. - `lf`: Line endings will be converted to `\\n`. The default line ending on Unix. - `crlf`: Line endings will be converted to `\\r\\n`. The default line ending on Windows. - `native`: Line endings will be converted to `\\n` on Unix and `\\r\\n` on Windows.","anyOf":[{"$ref":"#/definitions/LineEnding"},{"type":"null"}]},"line-width":{"description":"The line width at which the formatter prefers to wrap lines.\n\nThe value must be greater than or equal to `1` and less than or equal to `320`.\n\nNote: While the formatter will attempt to format lines such that they remain within the `line-width`, it isn't a hard upper bound, and formatted lines may exceed the `line-width`.","anyOf":[{"$ref":"#/definitions/LineWidth"},{"type":"null"}]},"persistent-line-breaks":{"description":"Air respects a small set of persistent line breaks as an indication that certain function calls or function signatures should be left expanded. If this option is set to `false`, persistent line breaks are ignored.\n\nIt may be preferable to ignore persistent line breaks if you prefer that `line-width` should be the only value that influences line breaks.","type":["boolean","null"]},"skip":{"description":"Air typically formats every function call it comes across. To skip formatting of a single one-off function call, you can use a `# fmt: skip` comment. However, if you know of particular functions that you use a lot that are part of a custom domain specific language that doesn't follow conventional formatting rules, you can entirely opt out of formatting for those functions by providing them here.\n\nFor example, using `skip = [\"graph_from_literal\"]` would automatically skip formatting of:\n\n```r igraph::graph_from_literal(Alice +--+ Bob) ```\n\nIn the short term, we also anticipate that this will be useful to avoid formatting of `tibble::tribble()` calls. In the long term, we may have more sophisticated features for automatically formatting using a specified alignment.","anyOf":[{"$ref":"#/definitions/Skip"},{"type":"null"}]}},"additionalProperties":false},"IndentStyle":{"oneOf":[{"description":"Tab","type":"string","enum":["tab"]},{"description":"Space","type":"string","enum":["space"]}]},"IndentWidth":{"description":"Validated value for the `indent-width` formatter options\n\nThe allowed range of values is 1..=24","type":"integer","format":"uint8","maximum":24.0,"minimum":1.0},"LineEnding":{"oneOf":[{"description":"The newline style is detected automatically on a file per file basis. Files with mixed line endings will be converted to the first detected line ending. Defaults to [`LineEnding::Lf`] for a files that contain no line endings.","type":"string","enum":["auto"]},{"description":"Line endings will be converted to `\\n` as is common on Unix.","type":"string","enum":["lf"]},{"description":"Line endings will be converted to `\\r\\n` as is common on Windows.","type":"string","enum":["crlf"]},{"description":"Line endings will be converted to `\\n` on Unix and `\\r\\n` on Windows.","type":"string","enum":["native"]}]},"LineWidth":{"description":"Validated value for the `line-width` formatter options\n\nThe allowed range of values is 1..=320","type":"integer","format":"uint16","maximum":320.0,"minimum":1.0},"Skip":{"description":"Function names that are automatically skipped without the need for a `fmt: skip` comment.\n\n# Notes\n\nInternally wrapped in an [Arc] for cheap cloning, since we know the function names are immutable and can be shared. Must be an [Arc] because settings are shared across threads when doing parallel file discovery.\n\nClippy recommends [Arc] wrapping the immutable `[String]` over the mutable `Vec<String>` because with [Arc] you are basically promising not to mutate the inner object, and [Arc] provides a special `From<Vec<T>> for Arc<[T]>` for exactly this use case, which we invoke in [Skip::new()].\n\n# Safety\n\nThis vector is sorted at creation, for use with binary search during lookups.","type":"array","items":{"type":"string"}}}}
|
Provide a JSON object that satisfies the schema "TomlOptions". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
TomlOptions
|
schema-store
|
schema_store_32
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/airlock-microgateway-3.2.json\",\"additionalProperties\":false,\"definitions\":{\"DefaultActionDto\":{\"title\":\"dto action\",\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Enable this default header action\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the default header action\"}},\"additionalProperties\":false},\"ExpertSettingsDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"apache\":{\"type\":[\"string\",\"null\"],\"description\":\"Expert settings for the Apache httpd.\"},\"security_gate\":{\"type\":[\"string\",\"null\"],\"description\":\"Expert settings for the Security Gate.\"}},\"additionalProperties\":false},\"PatternDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"ignore_case\":{\"type\":\"boolean\",\"description\":\"Whether to ignore case.\",\"default\":\"true\"},\"inverted\":{\"type\":\"boolean\",\"description\":\"Whether to invert the match.\",\"default\":\"false\"},\"pattern\":{\"type\":\"string\",\"description\":\"A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \\\".*\\\"\"}},\"required\":[\"pattern\"],\"additionalProperties\":false},\"PatternWithRewriteDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"regex\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"The regular expression, which matches the parts which should be rewritten.\"}]},\"substitution\":{\"type\":[\"string\",\"null\"],\"description\":\"The rewrite expression.\"}},\"additionalProperties\":false},\"PatternWithoutInvertDto\":{\"title\":\"pattern\",\"type\":\"object\",\"properties\":{\"ignore_case\":{\"type\":\"boolean\",\"description\":\"Whether to ignore case.\",\"default\":\"true\"},\"pattern\":{\"type\":\"string\",\"description\":\"A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \\\".*\\\"\"}},\"required\":[\"pattern\"],\"additionalProperties\":false},\"PatternWithoutInvertDto-nullable\":{\"anyOf\":[{\"type\":\"null\"},{\"$ref\":\"#/definitions/PatternWithoutInvertDto\"}]},\"RemoveHeaderActionDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"name\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern for the header name.\"}]},\"value\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern for the header value.\"}]}},\"additionalProperties\":false},\"RewriteHeaderValueDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"name\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern for the header name.\"}]},\"replace\":{\"type\":[\"string\",\"null\"],\"description\":\"A string to rewrite the header value with. Can make back-references to the header value pattern.\"},\"value\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern for the header value.\"}]}},\"additionalProperties\":false},\"SimpleHeaderActionDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"The name of the header to add.\"},\"value\":{\"type\":[\"string\",\"null\"],\"description\":\"The value of the header to add.\"}},\"additionalProperties\":false},\"SimplePatternDto-nullable\":{\"type\":[\"object\",\"null\"],\"properties\":{\"pattern\":{\"type\":[\"string\",\"null\"],\"description\":\"The actual pattern.\"}},\"additionalProperties\":false}},\"properties\":{\"apps\":{\"type\":\"array\",\"items\":{\"title\":\"application\",\"type\":\"object\",\"properties\":{\"mappings\":{\"type\":\"array\",\"items\":{\"title\":\"mapping\",\"type\":\"object\",\"properties\":{\"access_token\":{\"type\":[\"object\",\"null\"],\"properties\":{\"audittoken\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If the 'sub' claim should be extracted from the JWT and be used as audit token of the current session\",\"default\":\"false\"},\"claims\":{\"description\":\"All specified claims are checked and must match the claim's value of the decoded token. If a claim is an array, at least one entry must match the specified regex.\",\"type\":\"array\",\"items\":{\"title\":\"claim\",\"type\":\"object\",\"properties\":{\"claim\":{\"type\":[\"string\",\"null\"],\"description\":\"The name of the claim you want to restrict.\"},\"regex\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"The regular expression that must match the value of the specified claim name.\"}]}},\"additionalProperties\":false}},\"expiry_checked\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If the JWT standard claims expiry (exp) and not before (nbf) will be checked and must be valid.\",\"default\":\"false\"},\"extraction\":{\"type\":[\"object\",\"null\"],\"properties\":{\"cookie\":{\"type\":[\"string\",\"null\"],\"description\":\"From which cookie the token should be extracted.\"},\"header\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithRewriteDto-nullable\"},{\"description\":\"How the token should be extracted from the request headers.\"}]},\"mode\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"header\",\"parameter\",\"cookie\"]}],\"description\":\"From which part of the request the token should be extracted. Possible values are 'header', 'parameter', 'cookie'.\",\"default\":\"header\"},\"parameter\":{\"type\":[\"string\",\"null\"],\"description\":\"From which query parameter the token should be extracted.\"}},\"additionalProperties\":false,\"description\":\"How the token should be extracted.\"},\"jwks_providers\":{\"description\":\"List of JWKS service providers referenced by their name. Can be local or remote providers.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"mandatory\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If disabled, requests without a token are accepted. However, if a token is present,it is extracted and validated and the configured restrictions and role extractions are applied. \",\"default\":\"false\"},\"roles\":{\"description\":\"Specifies which roles should be extracted from the claims.\",\"type\":\"array\",\"items\":{\"title\":\"role\",\"type\":\"object\",\"properties\":{\"claim\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of the claim you want to extract a role from.\"},\"extraction\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithRewriteDto-nullable\"},{\"description\":\"The regular expression to match the role extraction and the rewrite expression of the role.\"}]},\"token_lifetime\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, the expiry claim (exp) of the JWT will be used as the role lifetime.\",\"default\":\"false\"}},\"additionalProperties\":false}},\"signature_mandatory\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Enforce a signed JWT\",\"default\":\"true\"},\"skew\":{\"type\":[\"integer\",\"null\"],\"description\":\"The allowed skew when checking expiry / not before in seconds.\",\"default\":\"10\"},\"tech_client_id_claim\":{\"type\":[\"string\",\"null\"],\"description\":\"The claim to extract the technical client id from.\"}},\"additionalProperties\":false},\"allow_rules\":{\"type\":\"array\",\"items\":{\"title\":\"allowed roles\",\"type\":\"object\",\"properties\":{\"content_type\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern to match the content type for this allow rule.\"}]},\"enabled\":{\"type\":\"boolean\",\"description\":\"Enable the allow rule.\",\"default\":\"true\"},\"log_only\":{\"type\":\"boolean\",\"description\":\"Whether to log requests not matching this allow rule instead of blocking them.\",\"default\":\"false\"},\"method\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern to match the http method for this allow rule.\"}]},\"name\":{\"type\":\"string\",\"description\":\"Unique name for the allow rule. If omitted, a unique name will be generated. To enable/disable the default allow rule or one from a mapping_template_file, use the same name.\",\"default\":\"Allow all\"},\"path\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern to match the path.\"}]}},\"additionalProperties\":false}},\"api_security\":{\"type\":[\"object\",\"null\"],\"properties\":{\"json_content_type\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"JSON objects are parsed only if their content-type matches the specified pattern.\",\"default\":\"json\"}]},\"openapi\":{\"type\":[\"object\",\"null\"],\"properties\":{\"log_only\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, potential attack requests are only logged but not blocked.\",\"default\":\"false\"},\"path_matching\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"client_view\",\"backend_view\"]}],\"description\":\"The Microgateway mapping can be configured to rewrite the incoming URL to a different back-end URL (asymmetric mappings). Due to this rewriting, the incoming URL path (client_view) will be different from the back-end URL path (backend_view).\",\"default\":\"client_view\"},\"response_validation\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Check responses against API specification.\",\"default\":\"false\"},\"spec\":{\"type\":[\"string\",\"null\"],\"description\":\"The OpenAPI specification.\"},\"spec_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The OpenAPI file path.\",\"default\":\"/config/openapi.json\"}},\"additionalProperties\":false,\"description\":\"The specification to validate against.\"},\"treat_json_objects_as_parameters\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, Microgateway parses JSON objects in requests and filters JSON attributes with allow rules and deny rules.\",\"default\":\"true\"},\"treat_path_segments_as_parameters\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, each path segment is interpreted as a separate parameter value and the deny rules for parameter values are applied to it.\",\"default\":\"true\"}},\"additionalProperties\":false},\"auth\":{\"type\":[\"object\",\"null\"],\"properties\":{\"access\":{\"description\":\"A list of access restrictions can be created. Each request matching the combination of HTTP method and path of a access restriction must have at least one of the specified roles to access the service. All matching restrictions must be satisfied to gain access.\",\"type\":\"array\",\"items\":{\"title\":\"access restriction\",\"type\":\"object\",\"properties\":{\"method\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"Can contain regular expressions that are applied when the HTTP method of a request matches one of the expressions. Use an empty pattern if all HTTP methods should match.\"}]},\"path\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"Can contain regular expressions that are applied when the requested path of the query matches the expressions. Use an empty pattern if all paths should match.\"}]},\"roles\":{\"description\":\"Can contain a list of roles for this service. Only sessions that have at least one of these roles will be able to access the service.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false}},\"client_certificate\":{\"type\":[\"object\",\"null\"],\"properties\":{\"verification\":{\"type\":\"string\",\"enum\":[\"inherit\",\"optional\",\"required\"],\"description\":\"The client certificate verification mode to use on this mapping. This can be used to override the setting from the virtual host with a stronger verification level (e.g. off -> optional or optional -> required). Possible values are 'inherit', 'optional' or 'required'.\",\"default\":\"inherit\"}},\"additionalProperties\":false},\"denied_access_url\":{\"type\":[\"string\",\"null\"],\"description\":\"Defines the location of the authentication service. In case the required role for the mapping is missing on the current session, Airlock Gateway will redirect the client to this location. If this value is missing (default), the Global Denied Access URL will be used.\",\"default\":\"/auth/check-login\"},\"flow\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"redirect\",\"deny_access\",\"one_shot\",\"one_shot_with_body\",\"ntlm\"]}],\"description\":\"The authentication flow, allowed values are: redirect, deny_access, one_shot, one_shot_with_body, ntlm\",\"default\":\"redirect\"},\"logout_propagation_path\":{\"type\":[\"string\",\"null\"],\"description\":\"In order to allow clean session termination on back-end systems when an Airlock Gateway session terminates, the administrator can configure one logout path per mapping.\"}},\"additionalProperties\":false},\"backend\":{\"type\":[\"object\",\"null\"],\"properties\":{\"expert_settings\":{\"type\":[\"object\",\"null\"],\"properties\":{\"security_gate\":{\"type\":[\"string\",\"null\"],\"description\":\"Expert settings for the Security Gate.\"}},\"additionalProperties\":false},\"hosts\":{\"type\":\"array\",\"items\":{\"title\":\"host\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The hostname of the back-end host. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.\",\"default\":\"backend\",\"pattern\":\"^[A-Za-z0-9.\\\\-_:]+$\"},\"port\":{\"type\":\"integer\",\"description\":\"Configuring a back-end port.\",\"default\":\"8080\",\"minimum\":1,\"maximum\":65535},\"protocol\":{\"type\":\"string\",\"enum\":[\"https\",\"http\"],\"description\":\"Allowed values are: http, https\",\"default\":\"http\"}},\"additionalProperties\":false}},\"name\":{\"type\":\"string\",\"description\":\"The unique name of the back-end. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.\",\"default\":\"backendGroup\",\"pattern\":\"^[A-Za-z0-9.\\\\-_:]+$\"}},\"additionalProperties\":false},\"backend_path\":{\"type\":[\"string\",\"null\"],\"description\":\"The back-end path specifies the internal back-end path, i.e. the path of the request sent to the application server.\",\"default\":\"/\"},\"compress_response_traffic\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Specifies whether Airlock Microgateway should compress the output on-the-fly for the client browser if supported and requested by the browser.\",\"default\":\"false\"},\"control_api\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Specifies whether the connected back-end service is allowed to use the Airlock Microgateway Control API via the control cookie mechanism. The Control API is normally used by authentication applications to communicate with the Microgateway.\",\"default\":\"false\"},\"cookies\":{\"type\":[\"object\",\"null\"],\"properties\":{\"encrypted\":{\"allOf\":[{\"$ref\":\"#/definitions/SimplePatternDto-nullable\"},{\"description\":\"Cookies that should be cryptographically encrypted before being sent to the client.\"}]},\"passthrough\":{\"allOf\":[{\"$ref\":\"#/definitions/SimplePatternDto-nullable\"},{\"description\":\"Cookies that should be passed in plain format to the client.\"}]}},\"additionalProperties\":false},\"csrf_token\":{\"type\":[\"object\",\"null\"],\"properties\":{\"enabled\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Whether to enable automatic CSRF token injection and validation on this mapping.\",\"default\":\"false\"},\"exceptions\":{\"description\":\"All incoming URLs that match one of these patterns are accepted by Airlock Microgateway without a valid CSRF token.\",\"type\":[\"array\",\"null\"],\"items\":{\"title\":\"exception\",\"type\":\"object\",\"properties\":{\"path\":{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"}},\"additionalProperties\":false}},\"invalid_token_redirect_location\":{\"type\":[\"string\",\"null\"],\"description\":\"Specifies the location (e.g. /index.html) to which the client is redirected if a missing or invalid CSRF token is detected.\",\"default\":\"/%ENTRYPATH%\"}},\"additionalProperties\":false},\"deny_rule_groups\":{\"type\":\"array\",\"items\":{\"title\":\"denied rule groups\",\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Enable deny rule group\",\"default\":\"true\"},\"exceptions\":{\"type\":\"array\",\"items\":{\"title\":\"exception\",\"type\":\"object\",\"properties\":{\"content_type\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"header_name\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"header_value\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"method\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"parameter_name\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"parameter_value\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"path\":{\"$ref\":\"#/definitions/PatternDto-nullable\"}},\"additionalProperties\":false}},\"level\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"basic\",\"standard\",\"strict\"]}],\"description\":\"Allowed values are: basic, standard, strict.\",\"default\":\"standard\"},\"log_only\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, offending requests are not blocked but only logged\",\"default\":\"false\"},\"rule_group_keys\":{\"description\":\"If deny rule group key is defined, the settings will only affect the specific deny rule group.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false}},\"entry_path\":{\"type\":[\"object\",\"null\"],\"properties\":{\"enforce_trailing_slashes\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Whether a trailing slash is mandatory at the end of the entry path or not.\",\"default\":\"false\"},\"ignore_case\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Whether to ignore case.\",\"default\":\"false\"},\"type\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"directory\",\"regex\"]}],\"description\":\"Allowed values are: directory, regex.\",\"default\":\"directory\"},\"value\":{\"type\":[\"string\",\"null\"],\"description\":\"This specifies the external URL path.\",\"default\":\"/\"}},\"additionalProperties\":false,\"description\":\"The entry path specifies the external URL path the mapping should be available under.\"},\"env_cookies\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Specifies whether Airlock environment cookies containing useful request information are sent to the connected back-end.\",\"default\":\"false\"},\"expert_settings\":{\"$ref\":\"#/definitions/ExpertSettingsDto-nullable\"},\"limits\":{\"type\":[\"object\",\"null\"],\"properties\":{\"http_limits\":{\"type\":[\"object\",\"null\"],\"properties\":{\"max_parameter_name_length\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum length of a parameter name in bytes.\",\"default\":\"128\"},\"max_parameter_value_length\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum length for a parameter value in bytes.\",\"default\":\"1024\"},\"max_parameters\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum number of parameters inside the request.\",\"default\":\"128\"},\"parameter_length_exception\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A regular expression which specifies any parameters which should not be checked against these length checks.\"}]}},\"additionalProperties\":false,\"description\":\"The limits for HTTP parameters.\"},\"json_limits\":{\"type\":[\"object\",\"null\"],\"properties\":{\"max_array_items\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum number of items in a single JSON array (non-recursive).\",\"default\":\"500\"},\"max_key_length\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum length for a JSON key, also known as 'JSON property' or 'JSON object member' in bytes.\",\"default\":\"256\"},\"max_keys\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum number of keys of a single JSON object (non-recursive).\",\"default\":\"250\"},\"max_length_exception\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"Defines a regular expression to exclude JSON keys and the corresponding values from the length checks. The exceptions must be specified in the '#json' format for a JSON key.\"}]},\"max_nesting_depth\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum depth of nesting for JSON objects and JSON arrays.\",\"default\":\"100\"},\"max_total_entries\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum number of keys and array items in the whole JSON document (recursive).\",\"default\":\"150000\"},\"max_value_length\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum length for a JSON value (string or numbers) in bytes.\",\"default\":\"8192\"}},\"additionalProperties\":false,\"description\":\"The limits for JSON structures.\"},\"max_path_length\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the maximum path length for requests to the current mapping in bytes.\",\"default\":\"1024\"},\"max_request_body_size\":{\"type\":[\"integer\",\"null\"],\"description\":\"The maximum allowed total size of the request body in bytes. It specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in the request body. To restrict the size of file uploads, set this limit to the maximum combined size of all files uploaded at once.\",\"default\":\"104857600\"}},\"additionalProperties\":false},\"mapping_template_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The Airlock Gateway mapping template file path.\",\"default\":\"/config/mapping.xml\"},\"name\":{\"type\":[\"string\",\"null\"],\"description\":\"The unique name of the mapping.\",\"default\":\"root\"},\"operational_mode\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"production\",\"integration\"]}],\"description\":\"Allowed values are: production, integration.\",\"default\":\"production\"},\"parameter_pollution\":{\"type\":[\"object\",\"null\"],\"properties\":{\"mixed_type\":{\"type\":[\"object\",\"null\"],\"properties\":{\"block_duplicates\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, requests are blocked if they contain the same parameter names with different parameter types (e.g. \\\"id\\\" is present as a POST parameter and as a query parameter simultaneously).\",\"default\":\"true\"},\"log_only\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, offending requests are not blocked but only logged.\",\"default\":\"false\"},\"parameter_name_exception\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"Exception pattern to exclude parameters from the parameter pollution detection.\"}]}},\"additionalProperties\":false},\"same_type\":{\"type\":[\"object\",\"null\"],\"properties\":{\"join_duplicates\":{\"type\":[\"boolean\",\"null\"],\"description\":\"If enabled, all the different values of a repeated parameter are joined by comma (in order of appearance). The aggregate value is then checked against deny rules (instead of the individual values).\",\"default\":\"true\"}},\"additionalProperties\":false}},\"additionalProperties\":false},\"priority\":{\"type\":[\"integer\",\"null\"],\"description\":\"Specifies the priority of this mapping (highest: -999, lowest: 999) when a request matches the entry path of multiple mappings.\\nAll mappings with entry_path.type regex must have a unique priority.\",\"default\":\"0\",\"minimum\":-999,\"maximum\":999},\"request\":{\"type\":[\"object\",\"null\"],\"properties\":{\"custom_actions\":{\"description\":\"A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.\",\"type\":[\"array\",\"null\"],\"items\":{\"title\":\"custom action\",\"type\":\"object\",\"properties\":{\"add_header\":{\"allOf\":[{\"$ref\":\"#/definitions/SimpleHeaderActionDto-nullable\"},{\"description\":\"An action to add a header to all requests.\"}]},\"add_missing_header\":{\"allOf\":[{\"$ref\":\"#/definitions/SimpleHeaderActionDto-nullable\"},{\"description\":\"An action to add a header to all requests if it is not already present.\"}]},\"add_or_replace_header\":{\"allOf\":[{\"$ref\":\"#/definitions/SimpleHeaderActionDto-nullable\"},{\"description\":\"An action to add or replace an existing header to all requests.\"}]},\"geolocation_redirect\":{\"type\":[\"object\",\"null\"],\"properties\":{\"continent_codes\":{\"description\":\"A list of alpha-2 continent codes to redirect clients from. See here: https://en.wikipedia.org/wiki/List_of_sovereign_states_and_dependent_territories_by_continent_(data_file)\",\"default\":\"[]\",\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\",\"default\":\"[]\"}},\"country_codes\":{\"description\":\"A list of country codes to redirect clients from. See here for alpha-2 codes to use: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\",\"default\":\"[]\",\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\",\"default\":\"[]\"}},\"status_code\":{\"type\":[\"integer\",\"null\"],\"description\":\"The http status code to use on redirect\",\"default\":\"303\"},\"target_url\":{\"type\":[\"string\",\"null\"],\"description\":\"The url to redirect to.\"}},\"additionalProperties\":false,\"description\":\"An action to redirect to a URL based on the geographic location of the request source IP.\"},\"header_redirect\":{\"type\":[\"object\",\"null\"],\"properties\":{\"name\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern for the header name.\"}]},\"status_code\":{\"type\":[\"integer\",\"null\"],\"description\":\"The http status code to use on redirect\",\"default\":\"303\"},\"target_url\":{\"type\":[\"string\",\"null\"],\"description\":\"The url to redirect to.\"},\"value\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern for the header value.\"}]}},\"additionalProperties\":false,\"description\":\"An action to redirect to a URL based on a header name or value either matching the given name or value pattern on requests.\"},\"name\":{\"type\":\"string\",\"description\":\"A unique name for this action; if not specified, a unique name will be generated.\"},\"remove_header\":{\"allOf\":[{\"$ref\":\"#/definitions/RemoveHeaderActionDto-nullable\"},{\"description\":\"An action to remove a header either matching given name or value pattern on requests.\"}]},\"rewrite_header_value\":{\"allOf\":[{\"$ref\":\"#/definitions/RewriteHeaderValueDto-nullable\"},{\"description\":\"An action to rewrite a header value either matching given name or value pattern on requests.\"}]}},\"additionalProperties\":false}},\"default_actions\":{\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/DefaultActionDto\"}}},\"additionalProperties\":false},\"response\":{\"type\":[\"object\",\"null\"],\"properties\":{\"custom_actions\":{\"description\":\"A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.\",\"type\":[\"array\",\"null\"],\"items\":{\"title\":\"custom action\",\"type\":\"object\",\"properties\":{\"add_header\":{\"allOf\":[{\"$ref\":\"#/definitions/SimpleHeaderActionDto-nullable\"},{\"description\":\"An action to add a header to all responses.\"}]},\"add_missing_header\":{\"allOf\":[{\"$ref\":\"#/definitions/SimpleHeaderActionDto-nullable\"},{\"description\":\"An action to add a header to all responses if it is not already present.\"}]},\"add_or_replace_header\":{\"allOf\":[{\"$ref\":\"#/definitions/SimpleHeaderActionDto-nullable\"},{\"description\":\"An action to add or replace an existing header on all responses.\"}]},\"name\":{\"type\":\"string\",\"description\":\"A unique name for this action; if not specified, a unique name will be generated.\"},\"remove_header\":{\"allOf\":[{\"$ref\":\"#/definitions/RemoveHeaderActionDto-nullable\"},{\"description\":\"An action to remove a header either matching given name or value pattern on responses.\"}]},\"rewrite_cookie\":{\"type\":[\"object\",\"null\"],\"properties\":{\"cookie\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternDto-nullable\"},{\"description\":\"A pattern to match the name of the cookie to rewrite. If this is set the name of the cookie must match this pattern for the rewrite to happen.\"}]},\"domain\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"A pattern to match the domain, or part of the domain of a cookie to rewrite it.\"}]},\"domain_replace\":{\"type\":[\"string\",\"null\"],\"description\":\"What to replace the domain with; Can make back references to the pattern used to match.\"},\"http_only_mode\":{\"type\":\"string\",\"enum\":[\"auto\",\"keep\",\"remove\",\"add\"],\"description\":\"Whether to `add`, `keep` or `remove` the `HttpOnly` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#HttpOnly) flag on cookies. AUTO will set the flag for encrypted cookies and KEEP it for others.\",\"default\":\"auto\"},\"path\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"A pattern to match the path of a response to rewrite.\"}]},\"path_replace\":{\"type\":[\"string\",\"null\"],\"description\":\"What to replace the path with; Can make back references to the pattern used to match.\"},\"secure_mode\":{\"type\":\"string\",\"enum\":[\"auto\",\"keep\",\"remove\",\"add\"],\"description\":\"Whether to `add`, `keep` or `remove` the `Secure` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Secure) flag on cookies. AUTO will set the flag on all connections that use HTTPS and remove it on others.\",\"default\":\"auto\"}},\"additionalProperties\":false,\"description\":\"An action to rewrite a cookie based on patterns for cookie name, domain etc.\"},\"rewrite_header_value\":{\"allOf\":[{\"$ref\":\"#/definitions/RewriteHeaderValueDto-nullable\"},{\"description\":\"An action to rewrite a header value either matching given name or value pattern on responses.\"}]},\"rewrite_raw_cookie\":{\"type\":[\"object\",\"null\"],\"properties\":{\"replace\":{\"type\":[\"string\",\"null\"],\"description\":\"A string to rewrite value pattern matches in the cookie value. Can make back references to the pattern used for matching.\"},\"value\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"A pattern for the cookie value to apply for matching.\"}]}},\"additionalProperties\":false,\"description\":\"An action to rewrite the raw value of a cookie matching the given pattern.\"}},\"additionalProperties\":false}},\"default_actions\":{\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/DefaultActionDto\"}},\"error_page_replacements\":{\"description\":\"Replacement rules for error responses returned by backend systems.\",\"type\":[\"array\",\"null\"],\"items\":{\"title\":\"error page replacement\",\"type\":\"object\",\"properties\":{\"page\":{\"type\":[\"string\",\"null\"],\"description\":\"Error page file name that will be delivered to the client. (eg. 400.html)\"},\"status_code\":{\"allOf\":[{\"$ref\":\"#/definitions/SimplePatternDto-nullable\"},{\"description\":\"The http response with the matching status code that should be replaced.\"}]}},\"additionalProperties\":false}},\"rewrites\":{\"type\":[\"object\",\"null\"],\"properties\":{\"any\":{\"description\":\"Rewrite the body of HTTP response.\",\"type\":\"array\",\"items\":{\"title\":\"rewrite\",\"type\":\"object\",\"properties\":{\"content\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"This regular expression pattern defines the content to rewrite.\"}]},\"content_type\":{\"type\":\"string\",\"description\":\"A response from the back-end server is rewritten only if the response header \\u00abContent-Type\\u00bb matches this regular expression.\",\"default\":\"^(?:text|application)/(?:html|xhtml)\"},\"to\":{\"type\":[\"string\",\"null\"],\"description\":\"This is the target string which will replace the string matched by Content Pattern\"}},\"additionalProperties\":false}},\"html\":{\"description\":\"Rewriting HTML content may be necessary to modify URLs in the HTML content if the application creates absolute or incorrect links because it is not reverse proxy compatible\",\"type\":\"array\",\"items\":{\"title\":\"html\",\"type\":\"object\",\"properties\":{\"options\":{\"description\":\"This list defines the content to rewrite. Possible values are 'url', event', 'embedded'.\",\"default\":\"[ url ]\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"url\",\"event\",\"embedded\"],\"default\":\"[ url ]\"}},\"to\":{\"type\":[\"string\",\"null\"],\"description\":\"This is the target string which will replace the string matched by URL Pattern\"},\"url\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"The URL pattern.\"}]}},\"additionalProperties\":false}},\"json\":{\"description\":\"Rewrite the json body of http responses.\",\"type\":\"array\",\"items\":{\"title\":\"json\",\"type\":\"object\",\"properties\":{\"content\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"This regular expression pattern defines the content to rewrite.\"}]},\"path\":{\"type\":\"string\",\"description\":\"The json path of the the property to rewrite.\"},\"replace\":{\"type\":\"string\",\"description\":\"This is the target content to replace the matched part with.\"}},\"additionalProperties\":false}},\"location_header\":{\"description\":\"Rewrite option to modify the HTTP redirect location header sent from the back-end server before it is sent to the client.\",\"type\":\"array\",\"items\":{\"title\":\"location header\",\"type\":\"object\",\"properties\":{\"to\":{\"type\":[\"string\",\"null\"],\"description\":\"This is the target string which will replace the string matched by URL Pattern\"},\"url\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto-nullable\"},{\"description\":\"The redirect URL pattern.\"}]}},\"additionalProperties\":false}}},\"additionalProperties\":false}},\"additionalProperties\":false},\"session_handling\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"enforce_session\",\"optional_session\",\"optional_session_no_refresh\",\"ignore_session\"]}],\"description\":\"Allowed values are: enforce_session, optional_session, optional_session_no_refresh, ignore_session\",\"default\":\"ignore_session\"},\"threat_handling\":{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\",\"enum\":[\"terminate_session\",\"block\",\"notify\"]}],\"description\":\"Allowed values are: block, terminate_session, notify.\",\"default\":\"block\"},\"timeouts\":{\"type\":[\"object\",\"null\"],\"properties\":{\"backend_http_response\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the time in seconds Airlock Microgateway will wait for the back-end HTTP response. In case the request runs into the timeout, Airlock Microgateway will deliver an error page with the corresponding HTTP 503 status code.\",\"default\":\"120\"},\"idle_session\":{\"type\":[\"integer\",\"null\"],\"description\":\"Defines the minimum session idle time in seconds for this mapping. The value will be ignored if minimum session idle timeout is smaller or equal to the global session idle timeout setting.\",\"default\":\"0\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"virtual_host\":{\"type\":[\"object\",\"null\"],\"properties\":{\"aliases\":{\"description\":\"Additional hostnames which refer to this virtual host.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"auth\":{\"type\":[\"object\",\"null\"],\"properties\":{\"client_certificate\":{\"type\":[\"object\",\"null\"],\"properties\":{\"ca_selection\":{\"type\":[\"string\",\"null\"],\"description\":\"The concatenated certificates of the CAs which are sent to the client during the SSL handshake, in PEM format.\"},\"ca_selection_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The file containing the selection CA certificates.\",\"default\":\"/secret/auth/client_certificate/selection.crt\"},\"ca_validation\":{\"type\":[\"string\",\"null\"],\"description\":\"The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format.\"},\"ca_validation_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The file containing the validation CA certificates.\",\"default\":\"/secret/auth/client_certificate/validation.crt\"},\"crl\":{\"type\":[\"string\",\"null\"],\"description\":\"PEM representation of certificate revocation lists. If a client certificate is on such a list it will not be accepted. Although Airlock provides this functionality, it is recommended to check certificates against CRLs and other types of blacklists within the authentication service and not in Airlock.\"},\"crl_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The file containing the crl.\",\"default\":\"/secret/auth/client_certificate/client.crl\"},\"verification\":{\"type\":\"string\",\"enum\":[\"off\",\"optional\",\"required\"],\"description\":\"Defines the default verification mode for client certificates on this virtual host. Possible values are 'off', 'optional' or 'required'.\",\"default\":\"off\"},\"verification_depth\":{\"type\":\"integer\",\"description\":\"Maximum number of intermediate certificate issuers.\",\"default\":\"1\"}},\"additionalProperties\":false}},\"additionalProperties\":false},\"certificate\":{\"type\":[\"object\",\"null\"],\"properties\":{\"ca_chain\":{\"type\":[\"string\",\"null\"],\"description\":\"List of certificates of the CA chain for the certificate.\"},\"ca_chain_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The CA chain file path.\",\"default\":\"/secret/tls/frontend-server-ca.crt\"},\"certificate\":{\"type\":[\"string\",\"null\"],\"description\":\"The certificate in PEM format.\"},\"certificate_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The certificate file path.\",\"default\":\"/secret/tls/frontend-server.crt\"},\"privatekey\":{\"type\":[\"string\",\"null\"],\"description\":\"The private key for the certificate in PEM format.\"},\"privatekey_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The private key file path\",\"default\":\"/secret/tls/frontend-server.key\"}},\"additionalProperties\":false},\"encoded_slashes\":{\"type\":\"boolean\",\"description\":\"Specifies whether encoded slashes (%2F) are allowed in URL path. Attention: combinations of client certificates per mapping and enabled encoded slashes in the same virtual host might result in configurations where client certificate evaluation might be evaded.\",\"default\":\"false\"},\"expert_settings\":{\"$ref\":\"#/definitions/ExpertSettingsDto-nullable\"},\"hostname\":{\"type\":\"string\",\"description\":\"The hostname of the virtual host.\",\"default\":\"microgateway\"},\"http2_enabled\":{\"type\":\"boolean\",\"description\":\"Specifies whether HTTP/2 connections are enabled for this host.\",\"default\":\"true\"},\"http_enabled\":{\"type\":\"boolean\",\"description\":\"Specifies whether HTTP connections are enabled for this host.\",\"default\":\"true\"},\"http_port\":{\"type\":\"integer\",\"description\":\"Specifies the port on which this host listens for HTTP connections.\",\"default\":\"8080\",\"minimum\":1,\"maximum\":65535},\"https_enabled\":{\"type\":\"boolean\",\"description\":\"Specifies whether HTTPS connections are enabled for this host.\",\"default\":\"true\"},\"https_port\":{\"type\":\"integer\",\"description\":\"Specifies the port on which this host listens for HTTPS connections.\",\"default\":\"8443\",\"minimum\":1,\"maximum\":65535},\"name\":{\"type\":\"string\",\"description\":\"The logical name of the virtual host.\",\"default\":\"microgateway\"},\"redirects\":{\"type\":[\"array\",\"null\"],\"items\":{\"title\":\"redirect\",\"type\":\"object\",\"properties\":{\"dest\":{\"type\":\"string\",\"description\":\"The destination can be relative to the current virtual host or an absolute URL including protocol and host. Relative redirect paths are extended with the incoming scheme and host header.\",\"minLength\":1,\"pattern\":\"^(http://|https://|ftp://|/)\\\\S*?$\"},\"path\":{\"allOf\":[{\"$ref\":\"#/definitions/PatternWithoutInvertDto\"},{\"description\":\"The absolute path starting with '/' as a regular expression from which to redirect.\"}]},\"status_code\":{\"type\":\"integer\",\"description\":\"The returned status code. Must be one of: [301, 302, 303, 307, 308]\",\"default\":\"303\",\"minimum\":301,\"maximum\":308}},\"required\":[\"dest\",\"path\"],\"additionalProperties\":false}},\"session_cookie_domain\":{\"type\":[\"string\",\"null\"],\"description\":\"Specifies the domain for Airlock's session cookie if the cookie is created inside this virtual host.\"},\"session_cookie_path\":{\"type\":\"string\",\"description\":\"Specifies the cookie path for Airlock's session cookie if the cookie is created inside this virtual host.\",\"default\":\"/\"},\"strict_fqdn\":{\"type\":\"boolean\",\"description\":\"Specifies whether a virtual host should reply only to requests that match the hostname or any of its server alias names.\",\"default\":\"false\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"deny_rule_groups\":{\"description\":\"Custom deny rule groups that can be referenced in mappings on top of the built in Airlock deny rules.\",\"type\":\"array\",\"items\":{\"title\":\"denied rule groups\",\"type\":\"object\",\"properties\":{\"deny_rules\":{\"description\":\"Filter rule that blocks requests based on the evaluation of different request attributes.\",\"type\":\"array\",\"items\":{\"title\":\"denied rules\",\"type\":\"object\",\"properties\":{\"content_type\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"header_name\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"header_value\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"method\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"name\":{\"type\":\"string\",\"description\":\"Unique name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.\",\"pattern\":\"^(?![ \\\\t\\\\n]*\\\\(default(.*)\\\\))[\\\\s\\\\S]*\"},\"parameter_name\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"parameter_value\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"path\":{\"$ref\":\"#/definitions/PatternDto-nullable\"},\"rule_key\":{\"type\":\"string\",\"description\":\"Unique short name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.\",\"pattern\":\"^(?![ \\\\t\\\\n]*\\\\(default(.*)\\\\))[\\\\s\\\\S]*\"}},\"additionalProperties\":false}},\"name\":{\"type\":\"string\",\"description\":\"Unique name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.\",\"pattern\":\"^(?![ \\\\t\\\\n]*\\\\(default(.*)\\\\))[\\\\s\\\\S]*\"},\"rule_group_key\":{\"type\":\"string\",\"description\":\"Unique short name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.\",\"pattern\":\"^(?![ \\\\t\\\\n]*\\\\(default(.*)\\\\))[\\\\s\\\\S]*\"}},\"additionalProperties\":false}},\"expert_settings\":{\"$ref\":\"#/definitions/ExpertSettingsDto-nullable\"},\"jwks_providers\":{\"type\":[\"object\",\"null\"],\"properties\":{\"local\":{\"description\":\"JWKS providers that are configured statically.\",\"default\":\"[]\",\"type\":\"array\",\"items\":{\"title\":\"provider\",\"type\":\"object\",\"properties\":{\"issuer\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of JWKS issuer. Corresponds to the 'Issuer' field in JWT.\"},\"jwks\":{\"type\":[\"string\",\"null\"],\"description\":\"JSON Object that represents the set of JWKS.\"},\"jwks_file\":{\"type\":[\"string\",\"null\"],\"description\":\"JSON file with the definitions of JWKS.\"},\"name\":{\"type\":\"string\",\"description\":\"Name by which provider is referenced. Must be unique.\"}},\"required\":[\"name\"],\"additionalProperties\":false,\"default\":\"[]\"}},\"refresh_interval\":{\"type\":\"integer\",\"description\":\"Refresh interval for fetching from remote JWKS providers in seconds.\",\"default\":\"86400\"},\"remote\":{\"description\":\"Remote JWKS providers which are fetched according to the jwks_providers.refresh_interval.\",\"default\":\"[]\",\"type\":\"array\",\"items\":{\"title\":\"provider\",\"type\":\"object\",\"properties\":{\"issuer\":{\"type\":[\"string\",\"null\"],\"description\":\"Name of JWKS issuer. This value is used to restrict the usage of the JWKS to JWTs with a matching issuer (claim 'iss').\"},\"name\":{\"type\":\"string\",\"description\":\"Name by which provider is referenced. Must be unique.\"},\"service_url\":{\"type\":\"string\",\"description\":\"URL of JWKS service provider.\"},\"tls\":{\"title\":\"tls\",\"type\":\"object\",\"properties\":{\"cipher_suite\":{\"type\":\"string\",\"description\":\"The TLS cipher suite to use. For documentation visit www.openssl.org and search for 'ciphers'.\",\"default\":\"DEFAULT\"},\"client\":{\"type\":[\"object\",\"null\"],\"properties\":{\"ca_chain\":{\"type\":[\"string\",\"null\"],\"description\":\"List of certificates of the CA chain for the certificate.\"},\"ca_chain_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The CA chain file path.\",\"default\":\"/secret/auth/jwks/tls/client/client-ca.crt\"},\"certificate\":{\"type\":[\"string\",\"null\"],\"description\":\"The certificate in PEM format.\"},\"certificate_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The certificate file path.\",\"default\":\"/secret/auth/jwks/tls/client/client.crt\"},\"privatekey\":{\"type\":[\"string\",\"null\"],\"description\":\"The private key for the certificate in PEM format.\"},\"privatekey_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The private key file path\",\"default\":\"/secret/auth/jwks/tls/client/client.key\"}},\"additionalProperties\":false},\"force_new_session\":{\"type\":\"boolean\",\"description\":\"Force new session for each request.\",\"default\":\"false\"},\"protocol\":{\"type\":\"string\",\"enum\":[\"DEFAULT\",\"TLSv1_0\",\"TLSv1_1\",\"TLSv1_2\",\"TLSv1_3\"],\"description\":\"The TLS protocol to use. For the description of the default values see the Gateway documentation for 'Supported SSL/TLS versions'.\",\"default\":\"DEFAULT\"},\"server\":{\"type\":[\"object\",\"null\"],\"properties\":{\"ca_validation\":{\"type\":[\"string\",\"null\"],\"description\":\"The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format.\"},\"ca_validation_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The file containing the validation CA certificates.\",\"default\":\"/secret/auth/jwks/tls/server/server-validation.crt\"},\"host_name_verification\":{\"type\":\"boolean\",\"description\":\"Verification which involves a server identity check to mitigate man in the middle attacks.\",\"default\":\"false\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"required\":[\"name\",\"service_url\"],\"additionalProperties\":false,\"default\":\"[]\"}}},\"additionalProperties\":false,\"description\":\"JWKS Providers which can be referenced in apps[].mappings[].access_token.\"},\"license\":{\"type\":[\"string\",\"null\"],\"description\":\"The encoded license.\"},\"license_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The license file path.\",\"default\":\"/secret/license\"},\"log\":{\"type\":[\"object\",\"null\"],\"properties\":{\"level\":{\"type\":\"string\",\"enum\":[\"info\",\"trace\"],\"description\":\"Allowed values are: info, trace\",\"default\":\"info\"}},\"additionalProperties\":false},\"metrics\":{\"title\":\"metrics\",\"type\":\"object\",\"properties\":{\"statsd\":{\"title\":\"statsd\",\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Enable sending of statsd metrics. Default is 'true'\",\"default\":\"true\"}},\"additionalProperties\":false,\"description\":\"Use this to enable sending metrics using the statsd protocol.\"}},\"additionalProperties\":false,\"description\":\"Configuration for metrics sending.\"},\"remote_ip\":{\"type\":[\"object\",\"null\"],\"properties\":{\"header\":{\"type\":\"string\",\"description\":\"If set, Airlock Microgateway will treat the value of this header field as the useragent IP address.<br />Common values are 'X-Forwarded-For' or 'X-Client-IP'.<br /><strong>Warning</strong>: Make sure that internal_proxies is correctly configured for your setup.\"},\"internal_proxies\":{\"description\":\"List of hostnames, IP addresses or IP address ranges (e.g. 10.0.0.0/8) to trust as presenting a valid Remote-IP header.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[\"header\",\"internal_proxies\"],\"additionalProperties\":false},\"session\":{\"type\":[\"object\",\"null\"],\"properties\":{\"encryption_passphrase\":{\"type\":[\"string\",\"null\"],\"description\":\"Specifies the passphrase for the passphrase based encryption mechanism (PBE).\"},\"encryption_passphrase_file\":{\"type\":[\"string\",\"null\"],\"description\":\"The path of the passphrase file.\",\"default\":\"/secret/passphrase\"},\"idle_timeout\":{\"type\":\"integer\",\"description\":\"Specifies the amount of idle time in seconds, after which an Airlock Microgateway session is terminated. This timeout should be smaller than all other session timeouts of your back-end applications. Even if the timeout can be configured in seconds, per default the resolution of the idle session timeout check is 5 seconds only.\",\"default\":\"600\"},\"lifetime\":{\"type\":\"integer\",\"description\":\"Specifies the absolute lifetime of an Airlock Microgateway session in seconds. After this time a session will be terminated.\",\"default\":\"28800\"},\"redis_hosts\":{\"description\":\"Name of the hosts running the Redis Server.\",\"default\":\"[]\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"default\":\"[]\"}},\"store_mode\":{\"type\":\"string\",\"enum\":[\"server\",\"cluster\",\"disabled\"],\"description\":\"Defines the redis session store connection mode. By default, the Microgateway tries to determine the connection mode depending on the number of redis hosts configured:<br />- server mode if only one host is configured<br />- cluster mode if several hosts are configured<br /><br />Allowed values are: server, cluster and disabled.\"}},\"additionalProperties\":false}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"airlock-microgateway-3.2\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/airlock-microgateway-3.2.json","additionalProperties":false,"definitions":{"DefaultActionDto":{"title":"dto action","type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Enable this default header action"},"name":{"type":["string","null"],"description":"Name of the default header action"}},"additionalProperties":false},"ExpertSettingsDto-nullable":{"type":["object","null"],"properties":{"apache":{"type":["string","null"],"description":"Expert settings for the Apache httpd."},"security_gate":{"type":["string","null"],"description":"Expert settings for the Security Gate."}},"additionalProperties":false},"PatternDto-nullable":{"type":["object","null"],"properties":{"ignore_case":{"type":"boolean","description":"Whether to ignore case.","default":"true"},"inverted":{"type":"boolean","description":"Whether to invert the match.","default":"false"},"pattern":{"type":"string","description":"A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \".*\""}},"required":["pattern"],"additionalProperties":false},"PatternWithRewriteDto-nullable":{"type":["object","null"],"properties":{"regex":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"The regular expression, which matches the parts which should be rewritten."}]},"substitution":{"type":["string","null"],"description":"The rewrite expression."}},"additionalProperties":false},"PatternWithoutInvertDto":{"title":"pattern","type":"object","properties":{"ignore_case":{"type":"boolean","description":"Whether to ignore case.","default":"true"},"pattern":{"type":"string","description":"A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use \".*\""}},"required":["pattern"],"additionalProperties":false},"PatternWithoutInvertDto-nullable":{"anyOf":[{"type":"null"},{"$ref":"#/definitions/PatternWithoutInvertDto"}]},"RemoveHeaderActionDto-nullable":{"type":["object","null"],"properties":{"name":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern for the header name."}]},"value":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern for the header value."}]}},"additionalProperties":false},"RewriteHeaderValueDto-nullable":{"type":["object","null"],"properties":{"name":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern for the header name."}]},"replace":{"type":["string","null"],"description":"A string to rewrite the header value with. Can make back-references to the header value pattern."},"value":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern for the header value."}]}},"additionalProperties":false},"SimpleHeaderActionDto-nullable":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"description":"The name of the header to add."},"value":{"type":["string","null"],"description":"The value of the header to add."}},"additionalProperties":false},"SimplePatternDto-nullable":{"type":["object","null"],"properties":{"pattern":{"type":["string","null"],"description":"The actual pattern."}},"additionalProperties":false}},"properties":{"apps":{"type":"array","items":{"title":"application","type":"object","properties":{"mappings":{"type":"array","items":{"title":"mapping","type":"object","properties":{"access_token":{"type":["object","null"],"properties":{"audittoken":{"type":["boolean","null"],"description":"If the 'sub' claim should be extracted from the JWT and be used as audit token of the current session","default":"false"},"claims":{"description":"All specified claims are checked and must match the claim's value of the decoded token. If a claim is an array, at least one entry must match the specified regex.","type":"array","items":{"title":"claim","type":"object","properties":{"claim":{"type":["string","null"],"description":"The name of the claim you want to restrict."},"regex":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"The regular expression that must match the value of the specified claim name."}]}},"additionalProperties":false}},"expiry_checked":{"type":["boolean","null"],"description":"If the JWT standard claims expiry (exp) and not before (nbf) will be checked and must be valid.","default":"false"},"extraction":{"type":["object","null"],"properties":{"cookie":{"type":["string","null"],"description":"From which cookie the token should be extracted."},"header":{"allOf":[{"$ref":"#/definitions/PatternWithRewriteDto-nullable"},{"description":"How the token should be extracted from the request headers."}]},"mode":{"anyOf":[{"type":"null"},{"type":"string","enum":["header","parameter","cookie"]}],"description":"From which part of the request the token should be extracted. Possible values are 'header', 'parameter', 'cookie'.","default":"header"},"parameter":{"type":["string","null"],"description":"From which query parameter the token should be extracted."}},"additionalProperties":false,"description":"How the token should be extracted."},"jwks_providers":{"description":"List of JWKS service providers referenced by their name. Can be local or remote providers.","type":"array","items":{"type":"string"}},"mandatory":{"type":["boolean","null"],"description":"If disabled, requests without a token are accepted. However, if a token is present,it is extracted and validated and the configured restrictions and role extractions are applied. ","default":"false"},"roles":{"description":"Specifies which roles should be extracted from the claims.","type":"array","items":{"title":"role","type":"object","properties":{"claim":{"type":["string","null"],"description":"Name of the claim you want to extract a role from."},"extraction":{"allOf":[{"$ref":"#/definitions/PatternWithRewriteDto-nullable"},{"description":"The regular expression to match the role extraction and the rewrite expression of the role."}]},"token_lifetime":{"type":["boolean","null"],"description":"If enabled, the expiry claim (exp) of the JWT will be used as the role lifetime.","default":"false"}},"additionalProperties":false}},"signature_mandatory":{"type":["boolean","null"],"description":"Enforce a signed JWT","default":"true"},"skew":{"type":["integer","null"],"description":"The allowed skew when checking expiry / not before in seconds.","default":"10"},"tech_client_id_claim":{"type":["string","null"],"description":"The claim to extract the technical client id from."}},"additionalProperties":false},"allow_rules":{"type":"array","items":{"title":"allowed roles","type":"object","properties":{"content_type":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern to match the content type for this allow rule."}]},"enabled":{"type":"boolean","description":"Enable the allow rule.","default":"true"},"log_only":{"type":"boolean","description":"Whether to log requests not matching this allow rule instead of blocking them.","default":"false"},"method":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern to match the http method for this allow rule."}]},"name":{"type":"string","description":"Unique name for the allow rule. If omitted, a unique name will be generated. To enable/disable the default allow rule or one from a mapping_template_file, use the same name.","default":"Allow all"},"path":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern to match the path."}]}},"additionalProperties":false}},"api_security":{"type":["object","null"],"properties":{"json_content_type":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"JSON objects are parsed only if their content-type matches the specified pattern.","default":"json"}]},"openapi":{"type":["object","null"],"properties":{"log_only":{"type":["boolean","null"],"description":"If enabled, potential attack requests are only logged but not blocked.","default":"false"},"path_matching":{"anyOf":[{"type":"null"},{"type":"string","enum":["client_view","backend_view"]}],"description":"The Microgateway mapping can be configured to rewrite the incoming URL to a different back-end URL (asymmetric mappings). Due to this rewriting, the incoming URL path (client_view) will be different from the back-end URL path (backend_view).","default":"client_view"},"response_validation":{"type":["boolean","null"],"description":"Check responses against API specification.","default":"false"},"spec":{"type":["string","null"],"description":"The OpenAPI specification."},"spec_file":{"type":["string","null"],"description":"The OpenAPI file path.","default":"/config/openapi.json"}},"additionalProperties":false,"description":"The specification to validate against."},"treat_json_objects_as_parameters":{"type":["boolean","null"],"description":"If enabled, Microgateway parses JSON objects in requests and filters JSON attributes with allow rules and deny rules.","default":"true"},"treat_path_segments_as_parameters":{"type":["boolean","null"],"description":"If enabled, each path segment is interpreted as a separate parameter value and the deny rules for parameter values are applied to it.","default":"true"}},"additionalProperties":false},"auth":{"type":["object","null"],"properties":{"access":{"description":"A list of access restrictions can be created. Each request matching the combination of HTTP method and path of a access restriction must have at least one of the specified roles to access the service. All matching restrictions must be satisfied to gain access.","type":"array","items":{"title":"access restriction","type":"object","properties":{"method":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"Can contain regular expressions that are applied when the HTTP method of a request matches one of the expressions. Use an empty pattern if all HTTP methods should match."}]},"path":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"Can contain regular expressions that are applied when the requested path of the query matches the expressions. Use an empty pattern if all paths should match."}]},"roles":{"description":"Can contain a list of roles for this service. Only sessions that have at least one of these roles will be able to access the service.","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"client_certificate":{"type":["object","null"],"properties":{"verification":{"type":"string","enum":["inherit","optional","required"],"description":"The client certificate verification mode to use on this mapping. This can be used to override the setting from the virtual host with a stronger verification level (e.g. off -> optional or optional -> required). Possible values are 'inherit', 'optional' or 'required'.","default":"inherit"}},"additionalProperties":false},"denied_access_url":{"type":["string","null"],"description":"Defines the location of the authentication service. In case the required role for the mapping is missing on the current session, Airlock Gateway will redirect the client to this location. If this value is missing (default), the Global Denied Access URL will be used.","default":"/auth/check-login"},"flow":{"anyOf":[{"type":"null"},{"type":"string","enum":["redirect","deny_access","one_shot","one_shot_with_body","ntlm"]}],"description":"The authentication flow, allowed values are: redirect, deny_access, one_shot, one_shot_with_body, ntlm","default":"redirect"},"logout_propagation_path":{"type":["string","null"],"description":"In order to allow clean session termination on back-end systems when an Airlock Gateway session terminates, the administrator can configure one logout path per mapping."}},"additionalProperties":false},"backend":{"type":["object","null"],"properties":{"expert_settings":{"type":["object","null"],"properties":{"security_gate":{"type":["string","null"],"description":"Expert settings for the Security Gate."}},"additionalProperties":false},"hosts":{"type":"array","items":{"title":"host","type":"object","properties":{"name":{"type":"string","description":"The hostname of the back-end host. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.","default":"backend","pattern":"^[A-Za-z0-9.\\-_:]+$"},"port":{"type":"integer","description":"Configuring a back-end port.","default":"8080","minimum":1,"maximum":65535},"protocol":{"type":"string","enum":["https","http"],"description":"Allowed values are: http, https","default":"http"}},"additionalProperties":false}},"name":{"type":"string","description":"The unique name of the back-end. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed.","default":"backendGroup","pattern":"^[A-Za-z0-9.\\-_:]+$"}},"additionalProperties":false},"backend_path":{"type":["string","null"],"description":"The back-end path specifies the internal back-end path, i.e. the path of the request sent to the application server.","default":"/"},"compress_response_traffic":{"type":["boolean","null"],"description":"Specifies whether Airlock Microgateway should compress the output on-the-fly for the client browser if supported and requested by the browser.","default":"false"},"control_api":{"type":["boolean","null"],"description":"Specifies whether the connected back-end service is allowed to use the Airlock Microgateway Control API via the control cookie mechanism. The Control API is normally used by authentication applications to communicate with the Microgateway.","default":"false"},"cookies":{"type":["object","null"],"properties":{"encrypted":{"allOf":[{"$ref":"#/definitions/SimplePatternDto-nullable"},{"description":"Cookies that should be cryptographically encrypted before being sent to the client."}]},"passthrough":{"allOf":[{"$ref":"#/definitions/SimplePatternDto-nullable"},{"description":"Cookies that should be passed in plain format to the client."}]}},"additionalProperties":false},"csrf_token":{"type":["object","null"],"properties":{"enabled":{"type":["boolean","null"],"description":"Whether to enable automatic CSRF token injection and validation on this mapping.","default":"false"},"exceptions":{"description":"All incoming URLs that match one of these patterns are accepted by Airlock Microgateway without a valid CSRF token.","type":["array","null"],"items":{"title":"exception","type":"object","properties":{"path":{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"}},"additionalProperties":false}},"invalid_token_redirect_location":{"type":["string","null"],"description":"Specifies the location (e.g. /index.html) to which the client is redirected if a missing or invalid CSRF token is detected.","default":"/%ENTRYPATH%"}},"additionalProperties":false},"deny_rule_groups":{"type":"array","items":{"title":"denied rule groups","type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Enable deny rule group","default":"true"},"exceptions":{"type":"array","items":{"title":"exception","type":"object","properties":{"content_type":{"$ref":"#/definitions/PatternDto-nullable"},"header_name":{"$ref":"#/definitions/PatternDto-nullable"},"header_value":{"$ref":"#/definitions/PatternDto-nullable"},"method":{"$ref":"#/definitions/PatternDto-nullable"},"parameter_name":{"$ref":"#/definitions/PatternDto-nullable"},"parameter_value":{"$ref":"#/definitions/PatternDto-nullable"},"path":{"$ref":"#/definitions/PatternDto-nullable"}},"additionalProperties":false}},"level":{"anyOf":[{"type":"null"},{"type":"string","enum":["basic","standard","strict"]}],"description":"Allowed values are: basic, standard, strict.","default":"standard"},"log_only":{"type":["boolean","null"],"description":"If enabled, offending requests are not blocked but only logged","default":"false"},"rule_group_keys":{"description":"If deny rule group key is defined, the settings will only affect the specific deny rule group.","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"entry_path":{"type":["object","null"],"properties":{"enforce_trailing_slashes":{"type":["boolean","null"],"description":"Whether a trailing slash is mandatory at the end of the entry path or not.","default":"false"},"ignore_case":{"type":["boolean","null"],"description":"Whether to ignore case.","default":"false"},"type":{"anyOf":[{"type":"null"},{"type":"string","enum":["directory","regex"]}],"description":"Allowed values are: directory, regex.","default":"directory"},"value":{"type":["string","null"],"description":"This specifies the external URL path.","default":"/"}},"additionalProperties":false,"description":"The entry path specifies the external URL path the mapping should be available under."},"env_cookies":{"type":["boolean","null"],"description":"Specifies whether Airlock environment cookies containing useful request information are sent to the connected back-end.","default":"false"},"expert_settings":{"$ref":"#/definitions/ExpertSettingsDto-nullable"},"limits":{"type":["object","null"],"properties":{"http_limits":{"type":["object","null"],"properties":{"max_parameter_name_length":{"type":["integer","null"],"description":"Defines the maximum length of a parameter name in bytes.","default":"128"},"max_parameter_value_length":{"type":["integer","null"],"description":"Defines the maximum length for a parameter value in bytes.","default":"1024"},"max_parameters":{"type":["integer","null"],"description":"Defines the maximum number of parameters inside the request.","default":"128"},"parameter_length_exception":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A regular expression which specifies any parameters which should not be checked against these length checks."}]}},"additionalProperties":false,"description":"The limits for HTTP parameters."},"json_limits":{"type":["object","null"],"properties":{"max_array_items":{"type":["integer","null"],"description":"Defines the maximum number of items in a single JSON array (non-recursive).","default":"500"},"max_key_length":{"type":["integer","null"],"description":"Defines the maximum length for a JSON key, also known as 'JSON property' or 'JSON object member' in bytes.","default":"256"},"max_keys":{"type":["integer","null"],"description":"Defines the maximum number of keys of a single JSON object (non-recursive).","default":"250"},"max_length_exception":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"Defines a regular expression to exclude JSON keys and the corresponding values from the length checks. The exceptions must be specified in the '#json' format for a JSON key."}]},"max_nesting_depth":{"type":["integer","null"],"description":"Defines the maximum depth of nesting for JSON objects and JSON arrays.","default":"100"},"max_total_entries":{"type":["integer","null"],"description":"Defines the maximum number of keys and array items in the whole JSON document (recursive).","default":"150000"},"max_value_length":{"type":["integer","null"],"description":"Defines the maximum length for a JSON value (string or numbers) in bytes.","default":"8192"}},"additionalProperties":false,"description":"The limits for JSON structures."},"max_path_length":{"type":["integer","null"],"description":"Defines the maximum path length for requests to the current mapping in bytes.","default":"1024"},"max_request_body_size":{"type":["integer","null"],"description":"The maximum allowed total size of the request body in bytes. It specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in the request body. To restrict the size of file uploads, set this limit to the maximum combined size of all files uploaded at once.","default":"104857600"}},"additionalProperties":false},"mapping_template_file":{"type":["string","null"],"description":"The Airlock Gateway mapping template file path.","default":"/config/mapping.xml"},"name":{"type":["string","null"],"description":"The unique name of the mapping.","default":"root"},"operational_mode":{"anyOf":[{"type":"null"},{"type":"string","enum":["production","integration"]}],"description":"Allowed values are: production, integration.","default":"production"},"parameter_pollution":{"type":["object","null"],"properties":{"mixed_type":{"type":["object","null"],"properties":{"block_duplicates":{"type":["boolean","null"],"description":"If enabled, requests are blocked if they contain the same parameter names with different parameter types (e.g. \"id\" is present as a POST parameter and as a query parameter simultaneously).","default":"true"},"log_only":{"type":["boolean","null"],"description":"If enabled, offending requests are not blocked but only logged.","default":"false"},"parameter_name_exception":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"Exception pattern to exclude parameters from the parameter pollution detection."}]}},"additionalProperties":false},"same_type":{"type":["object","null"],"properties":{"join_duplicates":{"type":["boolean","null"],"description":"If enabled, all the different values of a repeated parameter are joined by comma (in order of appearance). The aggregate value is then checked against deny rules (instead of the individual values).","default":"true"}},"additionalProperties":false}},"additionalProperties":false},"priority":{"type":["integer","null"],"description":"Specifies the priority of this mapping (highest: -999, lowest: 999) when a request matches the entry path of multiple mappings.\nAll mappings with entry_path.type regex must have a unique priority.","default":"0","minimum":-999,"maximum":999},"request":{"type":["object","null"],"properties":{"custom_actions":{"description":"A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.","type":["array","null"],"items":{"title":"custom action","type":"object","properties":{"add_header":{"allOf":[{"$ref":"#/definitions/SimpleHeaderActionDto-nullable"},{"description":"An action to add a header to all requests."}]},"add_missing_header":{"allOf":[{"$ref":"#/definitions/SimpleHeaderActionDto-nullable"},{"description":"An action to add a header to all requests if it is not already present."}]},"add_or_replace_header":{"allOf":[{"$ref":"#/definitions/SimpleHeaderActionDto-nullable"},{"description":"An action to add or replace an existing header to all requests."}]},"geolocation_redirect":{"type":["object","null"],"properties":{"continent_codes":{"description":"A list of alpha-2 continent codes to redirect clients from. See here: https://en.wikipedia.org/wiki/List_of_sovereign_states_and_dependent_territories_by_continent_(data_file)","default":"[]","type":["array","null"],"items":{"type":"string","default":"[]"}},"country_codes":{"description":"A list of country codes to redirect clients from. See here for alpha-2 codes to use: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2","default":"[]","type":["array","null"],"items":{"type":"string","default":"[]"}},"status_code":{"type":["integer","null"],"description":"The http status code to use on redirect","default":"303"},"target_url":{"type":["string","null"],"description":"The url to redirect to."}},"additionalProperties":false,"description":"An action to redirect to a URL based on the geographic location of the request source IP."},"header_redirect":{"type":["object","null"],"properties":{"name":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern for the header name."}]},"status_code":{"type":["integer","null"],"description":"The http status code to use on redirect","default":"303"},"target_url":{"type":["string","null"],"description":"The url to redirect to."},"value":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern for the header value."}]}},"additionalProperties":false,"description":"An action to redirect to a URL based on a header name or value either matching the given name or value pattern on requests."},"name":{"type":"string","description":"A unique name for this action; if not specified, a unique name will be generated."},"remove_header":{"allOf":[{"$ref":"#/definitions/RemoveHeaderActionDto-nullable"},{"description":"An action to remove a header either matching given name or value pattern on requests."}]},"rewrite_header_value":{"allOf":[{"$ref":"#/definitions/RewriteHeaderValueDto-nullable"},{"description":"An action to rewrite a header value either matching given name or value pattern on requests."}]}},"additionalProperties":false}},"default_actions":{"type":["array","null"],"items":{"$ref":"#/definitions/DefaultActionDto"}}},"additionalProperties":false},"response":{"type":["object","null"],"properties":{"custom_actions":{"description":"A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.","type":["array","null"],"items":{"title":"custom action","type":"object","properties":{"add_header":{"allOf":[{"$ref":"#/definitions/SimpleHeaderActionDto-nullable"},{"description":"An action to add a header to all responses."}]},"add_missing_header":{"allOf":[{"$ref":"#/definitions/SimpleHeaderActionDto-nullable"},{"description":"An action to add a header to all responses if it is not already present."}]},"add_or_replace_header":{"allOf":[{"$ref":"#/definitions/SimpleHeaderActionDto-nullable"},{"description":"An action to add or replace an existing header on all responses."}]},"name":{"type":"string","description":"A unique name for this action; if not specified, a unique name will be generated."},"remove_header":{"allOf":[{"$ref":"#/definitions/RemoveHeaderActionDto-nullable"},{"description":"An action to remove a header either matching given name or value pattern on responses."}]},"rewrite_cookie":{"type":["object","null"],"properties":{"cookie":{"allOf":[{"$ref":"#/definitions/PatternDto-nullable"},{"description":"A pattern to match the name of the cookie to rewrite. If this is set the name of the cookie must match this pattern for the rewrite to happen."}]},"domain":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"A pattern to match the domain, or part of the domain of a cookie to rewrite it."}]},"domain_replace":{"type":["string","null"],"description":"What to replace the domain with; Can make back references to the pattern used to match."},"http_only_mode":{"type":"string","enum":["auto","keep","remove","add"],"description":"Whether to `add`, `keep` or `remove` the `HttpOnly` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#HttpOnly) flag on cookies. AUTO will set the flag for encrypted cookies and KEEP it for others.","default":"auto"},"path":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"A pattern to match the path of a response to rewrite."}]},"path_replace":{"type":["string","null"],"description":"What to replace the path with; Can make back references to the pattern used to match."},"secure_mode":{"type":"string","enum":["auto","keep","remove","add"],"description":"Whether to `add`, `keep` or `remove` the `Secure` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Secure) flag on cookies. AUTO will set the flag on all connections that use HTTPS and remove it on others.","default":"auto"}},"additionalProperties":false,"description":"An action to rewrite a cookie based on patterns for cookie name, domain etc."},"rewrite_header_value":{"allOf":[{"$ref":"#/definitions/RewriteHeaderValueDto-nullable"},{"description":"An action to rewrite a header value either matching given name or value pattern on responses."}]},"rewrite_raw_cookie":{"type":["object","null"],"properties":{"replace":{"type":["string","null"],"description":"A string to rewrite value pattern matches in the cookie value. Can make back references to the pattern used for matching."},"value":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"A pattern for the cookie value to apply for matching."}]}},"additionalProperties":false,"description":"An action to rewrite the raw value of a cookie matching the given pattern."}},"additionalProperties":false}},"default_actions":{"type":["array","null"],"items":{"$ref":"#/definitions/DefaultActionDto"}},"error_page_replacements":{"description":"Replacement rules for error responses returned by backend systems.","type":["array","null"],"items":{"title":"error page replacement","type":"object","properties":{"page":{"type":["string","null"],"description":"Error page file name that will be delivered to the client. (eg. 400.html)"},"status_code":{"allOf":[{"$ref":"#/definitions/SimplePatternDto-nullable"},{"description":"The http response with the matching status code that should be replaced."}]}},"additionalProperties":false}},"rewrites":{"type":["object","null"],"properties":{"any":{"description":"Rewrite the body of HTTP response.","type":"array","items":{"title":"rewrite","type":"object","properties":{"content":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"This regular expression pattern defines the content to rewrite."}]},"content_type":{"type":"string","description":"A response from the back-end server is rewritten only if the response header \u00abContent-Type\u00bb matches this regular expression.","default":"^(?:text|application)/(?:html|xhtml)"},"to":{"type":["string","null"],"description":"This is the target string which will replace the string matched by Content Pattern"}},"additionalProperties":false}},"html":{"description":"Rewriting HTML content may be necessary to modify URLs in the HTML content if the application creates absolute or incorrect links because it is not reverse proxy compatible","type":"array","items":{"title":"html","type":"object","properties":{"options":{"description":"This list defines the content to rewrite. Possible values are 'url', event', 'embedded'.","default":"[ url ]","type":"array","items":{"type":"string","enum":["url","event","embedded"],"default":"[ url ]"}},"to":{"type":["string","null"],"description":"This is the target string which will replace the string matched by URL Pattern"},"url":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"The URL pattern."}]}},"additionalProperties":false}},"json":{"description":"Rewrite the json body of http responses.","type":"array","items":{"title":"json","type":"object","properties":{"content":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"This regular expression pattern defines the content to rewrite."}]},"path":{"type":"string","description":"The json path of the the property to rewrite."},"replace":{"type":"string","description":"This is the target content to replace the matched part with."}},"additionalProperties":false}},"location_header":{"description":"Rewrite option to modify the HTTP redirect location header sent from the back-end server before it is sent to the client.","type":"array","items":{"title":"location header","type":"object","properties":{"to":{"type":["string","null"],"description":"This is the target string which will replace the string matched by URL Pattern"},"url":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto-nullable"},{"description":"The redirect URL pattern."}]}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false},"session_handling":{"anyOf":[{"type":"null"},{"type":"string","enum":["enforce_session","optional_session","optional_session_no_refresh","ignore_session"]}],"description":"Allowed values are: enforce_session, optional_session, optional_session_no_refresh, ignore_session","default":"ignore_session"},"threat_handling":{"anyOf":[{"type":"null"},{"type":"string","enum":["terminate_session","block","notify"]}],"description":"Allowed values are: block, terminate_session, notify.","default":"block"},"timeouts":{"type":["object","null"],"properties":{"backend_http_response":{"type":["integer","null"],"description":"Defines the time in seconds Airlock Microgateway will wait for the back-end HTTP response. In case the request runs into the timeout, Airlock Microgateway will deliver an error page with the corresponding HTTP 503 status code.","default":"120"},"idle_session":{"type":["integer","null"],"description":"Defines the minimum session idle time in seconds for this mapping. The value will be ignored if minimum session idle timeout is smaller or equal to the global session idle timeout setting.","default":"0"}},"additionalProperties":false}},"additionalProperties":false}},"virtual_host":{"type":["object","null"],"properties":{"aliases":{"description":"Additional hostnames which refer to this virtual host.","type":"array","items":{"type":"string"}},"auth":{"type":["object","null"],"properties":{"client_certificate":{"type":["object","null"],"properties":{"ca_selection":{"type":["string","null"],"description":"The concatenated certificates of the CAs which are sent to the client during the SSL handshake, in PEM format."},"ca_selection_file":{"type":["string","null"],"description":"The file containing the selection CA certificates.","default":"/secret/auth/client_certificate/selection.crt"},"ca_validation":{"type":["string","null"],"description":"The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format."},"ca_validation_file":{"type":["string","null"],"description":"The file containing the validation CA certificates.","default":"/secret/auth/client_certificate/validation.crt"},"crl":{"type":["string","null"],"description":"PEM representation of certificate revocation lists. If a client certificate is on such a list it will not be accepted. Although Airlock provides this functionality, it is recommended to check certificates against CRLs and other types of blacklists within the authentication service and not in Airlock."},"crl_file":{"type":["string","null"],"description":"The file containing the crl.","default":"/secret/auth/client_certificate/client.crl"},"verification":{"type":"string","enum":["off","optional","required"],"description":"Defines the default verification mode for client certificates on this virtual host. Possible values are 'off', 'optional' or 'required'.","default":"off"},"verification_depth":{"type":"integer","description":"Maximum number of intermediate certificate issuers.","default":"1"}},"additionalProperties":false}},"additionalProperties":false},"certificate":{"type":["object","null"],"properties":{"ca_chain":{"type":["string","null"],"description":"List of certificates of the CA chain for the certificate."},"ca_chain_file":{"type":["string","null"],"description":"The CA chain file path.","default":"/secret/tls/frontend-server-ca.crt"},"certificate":{"type":["string","null"],"description":"The certificate in PEM format."},"certificate_file":{"type":["string","null"],"description":"The certificate file path.","default":"/secret/tls/frontend-server.crt"},"privatekey":{"type":["string","null"],"description":"The private key for the certificate in PEM format."},"privatekey_file":{"type":["string","null"],"description":"The private key file path","default":"/secret/tls/frontend-server.key"}},"additionalProperties":false},"encoded_slashes":{"type":"boolean","description":"Specifies whether encoded slashes (%2F) are allowed in URL path. Attention: combinations of client certificates per mapping and enabled encoded slashes in the same virtual host might result in configurations where client certificate evaluation might be evaded.","default":"false"},"expert_settings":{"$ref":"#/definitions/ExpertSettingsDto-nullable"},"hostname":{"type":"string","description":"The hostname of the virtual host.","default":"microgateway"},"http2_enabled":{"type":"boolean","description":"Specifies whether HTTP/2 connections are enabled for this host.","default":"true"},"http_enabled":{"type":"boolean","description":"Specifies whether HTTP connections are enabled for this host.","default":"true"},"http_port":{"type":"integer","description":"Specifies the port on which this host listens for HTTP connections.","default":"8080","minimum":1,"maximum":65535},"https_enabled":{"type":"boolean","description":"Specifies whether HTTPS connections are enabled for this host.","default":"true"},"https_port":{"type":"integer","description":"Specifies the port on which this host listens for HTTPS connections.","default":"8443","minimum":1,"maximum":65535},"name":{"type":"string","description":"The logical name of the virtual host.","default":"microgateway"},"redirects":{"type":["array","null"],"items":{"title":"redirect","type":"object","properties":{"dest":{"type":"string","description":"The destination can be relative to the current virtual host or an absolute URL including protocol and host. Relative redirect paths are extended with the incoming scheme and host header.","minLength":1,"pattern":"^(http://|https://|ftp://|/)\\S*?$"},"path":{"allOf":[{"$ref":"#/definitions/PatternWithoutInvertDto"},{"description":"The absolute path starting with '/' as a regular expression from which to redirect."}]},"status_code":{"type":"integer","description":"The returned status code. Must be one of: [301, 302, 303, 307, 308]","default":"303","minimum":301,"maximum":308}},"required":["dest","path"],"additionalProperties":false}},"session_cookie_domain":{"type":["string","null"],"description":"Specifies the domain for Airlock's session cookie if the cookie is created inside this virtual host."},"session_cookie_path":{"type":"string","description":"Specifies the cookie path for Airlock's session cookie if the cookie is created inside this virtual host.","default":"/"},"strict_fqdn":{"type":"boolean","description":"Specifies whether a virtual host should reply only to requests that match the hostname or any of its server alias names.","default":"false"}},"additionalProperties":false}},"additionalProperties":false}},"deny_rule_groups":{"description":"Custom deny rule groups that can be referenced in mappings on top of the built in Airlock deny rules.","type":"array","items":{"title":"denied rule groups","type":"object","properties":{"deny_rules":{"description":"Filter rule that blocks requests based on the evaluation of different request attributes.","type":"array","items":{"title":"denied rules","type":"object","properties":{"content_type":{"$ref":"#/definitions/PatternDto-nullable"},"header_name":{"$ref":"#/definitions/PatternDto-nullable"},"header_value":{"$ref":"#/definitions/PatternDto-nullable"},"method":{"$ref":"#/definitions/PatternDto-nullable"},"name":{"type":"string","description":"Unique name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.","pattern":"^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"},"parameter_name":{"$ref":"#/definitions/PatternDto-nullable"},"parameter_value":{"$ref":"#/definitions/PatternDto-nullable"},"path":{"$ref":"#/definitions/PatternDto-nullable"},"rule_key":{"type":"string","description":"Unique short name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.","pattern":"^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}},"additionalProperties":false}},"name":{"type":"string","description":"Unique name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.","pattern":"^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"},"rule_group_key":{"type":"string","description":"Unique short name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.","pattern":"^(?![ \\t\\n]*\\(default(.*)\\))[\\s\\S]*"}},"additionalProperties":false}},"expert_settings":{"$ref":"#/definitions/ExpertSettingsDto-nullable"},"jwks_providers":{"type":["object","null"],"properties":{"local":{"description":"JWKS providers that are configured statically.","default":"[]","type":"array","items":{"title":"provider","type":"object","properties":{"issuer":{"type":["string","null"],"description":"Name of JWKS issuer. Corresponds to the 'Issuer' field in JWT."},"jwks":{"type":["string","null"],"description":"JSON Object that represents the set of JWKS."},"jwks_file":{"type":["string","null"],"description":"JSON file with the definitions of JWKS."},"name":{"type":"string","description":"Name by which provider is referenced. Must be unique."}},"required":["name"],"additionalProperties":false,"default":"[]"}},"refresh_interval":{"type":"integer","description":"Refresh interval for fetching from remote JWKS providers in seconds.","default":"86400"},"remote":{"description":"Remote JWKS providers which are fetched according to the jwks_providers.refresh_interval.","default":"[]","type":"array","items":{"title":"provider","type":"object","properties":{"issuer":{"type":["string","null"],"description":"Name of JWKS issuer. This value is used to restrict the usage of the JWKS to JWTs with a matching issuer (claim 'iss')."},"name":{"type":"string","description":"Name by which provider is referenced. Must be unique."},"service_url":{"type":"string","description":"URL of JWKS service provider."},"tls":{"title":"tls","type":"object","properties":{"cipher_suite":{"type":"string","description":"The TLS cipher suite to use. For documentation visit www.openssl.org and search for 'ciphers'.","default":"DEFAULT"},"client":{"type":["object","null"],"properties":{"ca_chain":{"type":["string","null"],"description":"List of certificates of the CA chain for the certificate."},"ca_chain_file":{"type":["string","null"],"description":"The CA chain file path.","default":"/secret/auth/jwks/tls/client/client-ca.crt"},"certificate":{"type":["string","null"],"description":"The certificate in PEM format."},"certificate_file":{"type":["string","null"],"description":"The certificate file path.","default":"/secret/auth/jwks/tls/client/client.crt"},"privatekey":{"type":["string","null"],"description":"The private key for the certificate in PEM format."},"privatekey_file":{"type":["string","null"],"description":"The private key file path","default":"/secret/auth/jwks/tls/client/client.key"}},"additionalProperties":false},"force_new_session":{"type":"boolean","description":"Force new session for each request.","default":"false"},"protocol":{"type":"string","enum":["DEFAULT","TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3"],"description":"The TLS protocol to use. For the description of the default values see the Gateway documentation for 'Supported SSL/TLS versions'.","default":"DEFAULT"},"server":{"type":["object","null"],"properties":{"ca_validation":{"type":["string","null"],"description":"The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format."},"ca_validation_file":{"type":["string","null"],"description":"The file containing the validation CA certificates.","default":"/secret/auth/jwks/tls/server/server-validation.crt"},"host_name_verification":{"type":"boolean","description":"Verification which involves a server identity check to mitigate man in the middle attacks.","default":"false"}},"additionalProperties":false}},"additionalProperties":false}},"required":["name","service_url"],"additionalProperties":false,"default":"[]"}}},"additionalProperties":false,"description":"JWKS Providers which can be referenced in apps[].mappings[].access_token."},"license":{"type":["string","null"],"description":"The encoded license."},"license_file":{"type":["string","null"],"description":"The license file path.","default":"/secret/license"},"log":{"type":["object","null"],"properties":{"level":{"type":"string","enum":["info","trace"],"description":"Allowed values are: info, trace","default":"info"}},"additionalProperties":false},"metrics":{"title":"metrics","type":"object","properties":{"statsd":{"title":"statsd","type":"object","properties":{"enabled":{"type":"boolean","description":"Enable sending of statsd metrics. Default is 'true'","default":"true"}},"additionalProperties":false,"description":"Use this to enable sending metrics using the statsd protocol."}},"additionalProperties":false,"description":"Configuration for metrics sending."},"remote_ip":{"type":["object","null"],"properties":{"header":{"type":"string","description":"If set, Airlock Microgateway will treat the value of this header field as the useragent IP address.<br />Common values are 'X-Forwarded-For' or 'X-Client-IP'.<br /><strong>Warning</strong>: Make sure that internal_proxies is correctly configured for your setup."},"internal_proxies":{"description":"List of hostnames, IP addresses or IP address ranges (e.g. 10.0.0.0/8) to trust as presenting a valid Remote-IP header.","type":"array","items":{"type":"string"}}},"required":["header","internal_proxies"],"additionalProperties":false},"session":{"type":["object","null"],"properties":{"encryption_passphrase":{"type":["string","null"],"description":"Specifies the passphrase for the passphrase based encryption mechanism (PBE)."},"encryption_passphrase_file":{"type":["string","null"],"description":"The path of the passphrase file.","default":"/secret/passphrase"},"idle_timeout":{"type":"integer","description":"Specifies the amount of idle time in seconds, after which an Airlock Microgateway session is terminated. This timeout should be smaller than all other session timeouts of your back-end applications. Even if the timeout can be configured in seconds, per default the resolution of the idle session timeout check is 5 seconds only.","default":"600"},"lifetime":{"type":"integer","description":"Specifies the absolute lifetime of an Airlock Microgateway session in seconds. After this time a session will be terminated.","default":"28800"},"redis_hosts":{"description":"Name of the hosts running the Redis Server.","default":"[]","type":"array","items":{"type":"string","default":"[]"}},"store_mode":{"type":"string","enum":["server","cluster","disabled"],"description":"Defines the redis session store connection mode. By default, the Microgateway tries to determine the connection mode depending on the number of redis hosts configured:<br />- server mode if only one host is configured<br />- cluster mode if several hosts are configured<br /><br />Allowed values are: server, cluster and disabled."}},"additionalProperties":false}},"type":"object"}
|
Provide a JSON object that satisfies the schema "airlock-microgateway-3.2". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
airlock-microgateway-3.2
|
schema-store
|
schema_store_33
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"K9s aliases schema\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"aliases\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"required\":[]}},\"required\":[\"aliases\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"K9s aliases schema\". Here are the required top‑level fields: aliases. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"K9s aliases schema","type":"object","additionalProperties":false,"properties":{"aliases":{"type":"object","additionalProperties":{"type":"string"},"required":[]}},"required":["aliases"]}
|
Provide a JSON object that satisfies the schema "K9s aliases schema". Here are the required top‑level fields: aliases. Return only the valid JSON object.
|
K9s aliases schema
|
schema-store
|
schema_store_34
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{},\"description\":\"The configuration file used by the All Contributors CLI and GitHub bot.\\nhttps://allcontributors.org/docs/en/bot/configuration\",\"id\":\"https://json.schemastore.org/base-04.json\",\"properties\":{\"projectName\":{\"title\":\"Name of the project\",\"type\":\"string\",\"minLength\":0},\"projectOwner\":{\"title\":\"Name of the user the project is hosted by\",\"type\":\"string\",\"minLength\":0},\"repoType\":{\"title\":\"Type of repository\",\"enum\":[\"github\",\"gitlab\"],\"default\":\"github\"},\"repoHost\":{\"title\":\"Points to the repository hostname\",\"description\":\"Change it if you use a self-hosted repository.\\nDefault: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab\",\"type\":\"string\",\"minLength\":0},\"files\":{\"title\":\"Array of files to update\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":0},\"default\":[\"README.md\"]},\"imageSize\":{\"title\":\"Size (in px) of the user's avatar\",\"type\":\"number\",\"minimum\":0,\"default\":100},\"commit\":{\"title\":\"Auto-commit badge when adding contributors\",\"type\":\"boolean\",\"default\":false},\"commitConvention\":{\"title\":\"Commit convention\",\"enum\":[\"angular\",\"atom\",\"ember\",\"eslint\",\"jshint\",\"gitmoji\",\"none\"],\"default\":\"angular\"},\"commitType\":{\"description\":\"UNDOCUMENTED: Sets Conventional Commits commit type to be used by the all contributors bot. See https://www.conventionalcommits.org.\",\"type\":\"string\",\"default\":\"docs\"},\"contributorsPerLine\":{\"title\":\"Maximum number of columns for the contributors table\",\"type\":\"number\",\"minimum\":0,\"default\":7},\"contributorsSortAlphabetically\":{\"title\":\"true: Sort alphabetically. false: Display in order of addition.\",\"type\":\"boolean\",\"default\":false},\"badgeTemplate\":{\"title\":\"Your own lodash template to generate the badge\",\"type\":\"string\",\"minLength\":0},\"contributorTemplate\":{\"title\":\"Your own lodash template to generate the contributor\",\"type\":\"string\",\"minLength\":0},\"types\":{\"title\":\"Custom symbols or link templates for contribution types (can override the documented types)\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"symbol\":{\"title\":\"Symbol to use for the contribution type\",\"type\":\"string\",\"minLength\":0},\"description\":{\"title\":\"Description of the contribution type\",\"type\":\"string\",\"minLength\":0},\"link\":{\"title\":\"Link to use for the contribution type\",\"type\":\"string\",\"minLength\":0}}}},\"linkToUsage\":{\"title\":\"Adds a footer with link to usage\",\"type\":\"boolean\",\"default\":true},\"skipCi\":{\"title\":\"Makes the CI ignore the commit\",\"type\":\"boolean\",\"default\":true},\"contributors\":{\"title\":\"List of contributors for this project\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"login\":{\"title\":\"Github username of the contributor\",\"type\":\"string\",\"minLength\":0},\"name\":{\"title\":\"Name of the contributor\",\"type\":\"string\",\"minLength\":0},\"avatar_url\":{\"title\":\"URL of the contributor's avatar\",\"type\":\"string\",\"format\":\"uri\",\"minLength\":0},\"profile\":{\"title\":\"URL of the contributor's profile page or website\",\"type\":\"string\",\"format\":\"uri\",\"minLength\":0},\"contributions\":{\"title\":\"Array of contributions made by the contributor\",\"type\":\"array\",\"minItems\":1,\"items\":{\"anyOf\":[{\"type\":\"string\",\"enum\":[\"a11y\",\"audio\",\"blog\",\"bug\",\"business\",\"code\",\"content\",\"data\",\"design\",\"doc\",\"eventOrganizing\",\"example\",\"financial\",\"fundingFinding\",\"ideas\",\"infra\",\"maintenance\",\"mentoring\",\"platform\",\"plugin\",\"projectManagement\",\"promotion\",\"question\",\"research\",\"review\",\"security\",\"talk\",\"test\",\"tool\",\"translation\",\"tutorial\",\"userTesting\",\"video\"]},{\"type\":\"string\",\"minLength\":0}]}}},\"required\":[\"login\",\"name\",\"avatar_url\",\"profile\",\"contributions\"]}}},\"required\":[\"projectName\",\"projectOwner\"],\"title\":\"All Contributors configuration file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"All Contributors configuration file\". Here are the required top‑level fields: projectName, projectOwner. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{},"description":"The configuration file used by the All Contributors CLI and GitHub bot.\nhttps://allcontributors.org/docs/en/bot/configuration","id":"https://json.schemastore.org/base-04.json","properties":{"projectName":{"title":"Name of the project","type":"string","minLength":0},"projectOwner":{"title":"Name of the user the project is hosted by","type":"string","minLength":0},"repoType":{"title":"Type of repository","enum":["github","gitlab"],"default":"github"},"repoHost":{"title":"Points to the repository hostname","description":"Change it if you use a self-hosted repository.\nDefault: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab","type":"string","minLength":0},"files":{"title":"Array of files to update","type":"array","items":{"type":"string","minLength":0},"default":["README.md"]},"imageSize":{"title":"Size (in px) of the user's avatar","type":"number","minimum":0,"default":100},"commit":{"title":"Auto-commit badge when adding contributors","type":"boolean","default":false},"commitConvention":{"title":"Commit convention","enum":["angular","atom","ember","eslint","jshint","gitmoji","none"],"default":"angular"},"commitType":{"description":"UNDOCUMENTED: Sets Conventional Commits commit type to be used by the all contributors bot. See https://www.conventionalcommits.org.","type":"string","default":"docs"},"contributorsPerLine":{"title":"Maximum number of columns for the contributors table","type":"number","minimum":0,"default":7},"contributorsSortAlphabetically":{"title":"true: Sort alphabetically. false: Display in order of addition.","type":"boolean","default":false},"badgeTemplate":{"title":"Your own lodash template to generate the badge","type":"string","minLength":0},"contributorTemplate":{"title":"Your own lodash template to generate the contributor","type":"string","minLength":0},"types":{"title":"Custom symbols or link templates for contribution types (can override the documented types)","type":"object","additionalProperties":{"type":"object","properties":{"symbol":{"title":"Symbol to use for the contribution type","type":"string","minLength":0},"description":{"title":"Description of the contribution type","type":"string","minLength":0},"link":{"title":"Link to use for the contribution type","type":"string","minLength":0}}}},"linkToUsage":{"title":"Adds a footer with link to usage","type":"boolean","default":true},"skipCi":{"title":"Makes the CI ignore the commit","type":"boolean","default":true},"contributors":{"title":"List of contributors for this project","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"login":{"title":"Github username of the contributor","type":"string","minLength":0},"name":{"title":"Name of the contributor","type":"string","minLength":0},"avatar_url":{"title":"URL of the contributor's avatar","type":"string","format":"uri","minLength":0},"profile":{"title":"URL of the contributor's profile page or website","type":"string","format":"uri","minLength":0},"contributions":{"title":"Array of contributions made by the contributor","type":"array","minItems":1,"items":{"anyOf":[{"type":"string","enum":["a11y","audio","blog","bug","business","code","content","data","design","doc","eventOrganizing","example","financial","fundingFinding","ideas","infra","maintenance","mentoring","platform","plugin","projectManagement","promotion","question","research","review","security","talk","test","tool","translation","tutorial","userTesting","video"]},{"type":"string","minLength":0}]}}},"required":["login","name","avatar_url","profile","contributions"]}}},"required":["projectName","projectOwner"],"title":"All Contributors configuration file","type":"object"}
|
Provide a JSON object that satisfies the schema "All Contributors configuration file". Here are the required top‑level fields: projectName, projectOwner. Return only the valid JSON object.
|
All Contributors configuration file
|
schema-store
|
schema_store_35
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"http://asyncapi.com/schema-store/all.schema-store.json\",\"$schema\":\"http://json-schema.org/draft-07/schema\",\"title\":\"JSON Schema documents for all AsyncAPI spec versions\",\"description\":\"All AsyncAPI JSON Schema documents listed in one file. Needed for serving all documents through schemastore.org\",\"type\":\"object\",\"oneOf\":[{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"1.0.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/1.0.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"1.1.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/1.1.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"1.2.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/1.2.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.0.0-rc1\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.0.0-rc1-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.0.0-rc2\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.0.0-rc2-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.0.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.0.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.1.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.1.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.2.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.2.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.3.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.3.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.4.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.4.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.5.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.5.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"2.6.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/2.6.0-without-$id.json\"}]},{\"allOf\":[{\"properties\":{\"asyncapi\":{\"const\":\"3.0.0\"}}},{\"$ref\":\"http://asyncapi.com/schema-store/3.0.0-without-$id.json\"}]}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema documents for all AsyncAPI spec versions\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"http://asyncapi.com/schema-store/all.schema-store.json","$schema":"http://json-schema.org/draft-07/schema","title":"JSON Schema documents for all AsyncAPI spec versions","description":"All AsyncAPI JSON Schema documents listed in one file. Needed for serving all documents through schemastore.org","type":"object","oneOf":[{"allOf":[{"properties":{"asyncapi":{"const":"1.0.0"}}},{"$ref":"http://asyncapi.com/schema-store/1.0.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"1.1.0"}}},{"$ref":"http://asyncapi.com/schema-store/1.1.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"1.2.0"}}},{"$ref":"http://asyncapi.com/schema-store/1.2.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.0.0-rc1"}}},{"$ref":"http://asyncapi.com/schema-store/2.0.0-rc1-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.0.0-rc2"}}},{"$ref":"http://asyncapi.com/schema-store/2.0.0-rc2-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.0.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.0.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.1.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.1.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.2.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.2.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.3.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.3.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.4.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.4.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.5.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.5.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"2.6.0"}}},{"$ref":"http://asyncapi.com/schema-store/2.6.0-without-$id.json"}]},{"allOf":[{"properties":{"asyncapi":{"const":"3.0.0"}}},{"$ref":"http://asyncapi.com/schema-store/3.0.0-without-$id.json"}]}]}
|
Provide a JSON object that satisfies the schema "JSON Schema documents for all AsyncAPI spec versions". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema documents for all AsyncAPI spec versions
|
schema-store
|
schema_store_36
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/amx-muse.json\",\"description\":\"A MUSE program descriptor file\",\"additionalProperties\":true,\"type\":\"object\",\"properties\":{\"id\":{\"title\":\"Program ID\",\"description\":\"Globally unique program ID, special characters are not allowed\",\"type\":\"string\",\"pattern\":\"^[a-zA-z0-9_-]+$\"},\"description\":{\"title\":\"Program Description\",\"description\":\"A description of the program that may be used by user interfaces\",\"type\":\"string\"},\"disabled\":{\"title\":\"Auto-start Disabled\",\"description\":\"Disable the auto-start of the script on system boot\",\"type\":\"boolean\",\"default\":false},\"envvars\":{\"title\":\"Environment Variables\",\"description\":\"Name/Value pairs that can be used to set configuration of a program\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"scope\":{\"title\":\"Program Scope\",\"description\":\"The scope (location) to which the script belongs. Leave blank for global scope\",\"type\":\"string\",\"pattern\":\"^[a-zA-z0-9_\\\\.-]*$\"},\"provider\":{\"title\":\"Programming Language\",\"description\":\"The language the program is written in\",\"enum\":[\"groovy\",\"javascript\",\"python\"]},\"script\":{\"title\":\"Program File Name\",\"description\":\"The file name of the main entry point of the program. Defaults to index.<extension>\",\"type\":\"string\",\"default\":\"index.{groovy,js,py}\"}},\"required\":[\"id\",\"provider\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"amx-muse\". Here are the required top‑level fields: id, provider. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/amx-muse.json","description":"A MUSE program descriptor file","additionalProperties":true,"type":"object","properties":{"id":{"title":"Program ID","description":"Globally unique program ID, special characters are not allowed","type":"string","pattern":"^[a-zA-z0-9_-]+$"},"description":{"title":"Program Description","description":"A description of the program that may be used by user interfaces","type":"string"},"disabled":{"title":"Auto-start Disabled","description":"Disable the auto-start of the script on system boot","type":"boolean","default":false},"envvars":{"title":"Environment Variables","description":"Name/Value pairs that can be used to set configuration of a program","type":"object","additionalProperties":{"type":"string"}},"scope":{"title":"Program Scope","description":"The scope (location) to which the script belongs. Leave blank for global scope","type":"string","pattern":"^[a-zA-z0-9_\\.-]*$"},"provider":{"title":"Programming Language","description":"The language the program is written in","enum":["groovy","javascript","python"]},"script":{"title":"Program File Name","description":"The file name of the main entry point of the program. Defaults to index.<extension>","type":"string","default":"index.{groovy,js,py}"}},"required":["id","provider"]}
|
Provide a JSON object that satisfies the schema "amx-muse". Here are the required top‑level fields: id, provider. Return only the valid JSON object.
|
amx-muse
|
schema-store
|
schema_store_37
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$defs\":{\"rule\":{\"additionalProperties\":false,\"properties\":{\"exclude_paths\":{\"items\":{\"type\":\"string\"},\"title\":\"Glob-like paths to be excluded.\",\"type\":\"array\"}},\"type\":\"object\"}},\"$id\":\"https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible-lint-config.json\",\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"description\":\"https://ansible.readthedocs.io/projects/lint/configuring/\",\"examples\":[\".ansible-lint\",\".ansible-lint.yml\",\".ansible-lint.yaml\",\".config/ansible-lint.yml\",\".config/ansible-lint.yaml\"],\"properties\":{\"display_relative_path\":{\"default\":true,\"title\":\"Configure how to display file paths\",\"type\":\"boolean\"},\"enable_list\":{\"items\":{\"type\":\"string\"},\"title\":\"Enable List\",\"type\":\"array\"},\"exclude_paths\":{\"items\":{\"type\":\"string\"},\"title\":\"Exclude Paths\",\"type\":\"array\"},\"extra_vars\":{\"title\":\"Extra Vars\",\"type\":\"object\"},\"kinds\":{\"items\":{\"additionalProperties\":{\"type\":\"string\"},\"type\":\"object\"},\"title\":\"Kinds\",\"type\":\"array\"},\"loop_var_prefix\":{\"title\":\"Loop Var Prefix\",\"type\":\"string\"},\"max_block_depth\":{\"title\":\"Maximum Block Depth\",\"type\":\"integer\",\"default\":20},\"mock_modules\":{\"items\":{\"type\":\"string\"},\"title\":\"Mock Modules\",\"type\":\"array\"},\"mock_roles\":{\"items\":{\"type\":\"string\"},\"title\":\"Mock Roles\",\"type\":\"array\"},\"offline\":{\"default\":false,\"title\":\"Offline\",\"type\":\"boolean\"},\"only_builtins_allow_collections\":{\"items\":{\"type\":\"string\"},\"title\":\"Only Builtins Allow Collections\",\"type\":\"array\"},\"only_builtins_allow_modules\":{\"items\":{\"type\":\"string\"},\"title\":\"Only Builtins Allow Modules\",\"type\":\"array\"},\"parseable\":{\"default\":true,\"title\":\"Parseable\",\"type\":\"boolean\"},\"profile\":{\"enum\":[\"min\",\"basic\",\"moderate\",\"safety\",\"shared\",\"production\",null],\"title\":\"Profile\",\"type\":[\"null\",\"string\"]},\"progressive\":{\"default\":false,\"title\":\"Progressive (removed feature)\",\"type\":\"boolean\"},\"project_dir\":{\"default\":null,\"title\":\"Project Directory\",\"type\":[\"string\",\"null\"]},\"quiet\":{\"default\":true,\"title\":\"Quiet\",\"type\":\"boolean\"},\"rules\":{\"additionalProperties\":{\"$ref\":\"#/$defs/rule\"},\"propertyNames\":{\"oneOf\":[{\"enum\":[\"command-instead-of-module\",\"command-instead-of-shell\",\"deprecated-bare-vars\",\"deprecated-local-action\",\"deprecated-module\",\"empty-string-compare\",\"fqcn\",\"fqcn[action-core]\",\"fqcn[action]\",\"fqcn[canonical]\",\"fqcn[keyword]\",\"galaxy\",\"galaxy[no-changelog]\",\"galaxy[no-runtime]\",\"galaxy[tags]\",\"galaxy[version-incorrect]\",\"galaxy[version-missing]\",\"ignore-errors\",\"inline-env-var\",\"internal-error\",\"jinja\",\"jinja[invalid]\",\"jinja[spacing]\",\"key-order\",\"latest\",\"literal-compare\",\"load-failure\",\"load-failure[not-found]\",\"loop-var-prefix\",\"loop-var-prefix[missing]\",\"loop-var-prefix[wrong]\",\"meta-incorrect\",\"meta-no-tags\",\"meta-runtime\",\"meta-video-links\",\"name\",\"name[casing]\",\"name[play]\",\"name[prefix]\",\"name[template]\",\"no-changed-when\",\"no-handler\",\"no-jinja-when\",\"no-log-password\",\"no-prompting\",\"no-relative-paths\",\"no-same-owner\",\"no-tabs\",\"only-builtins\",\"package-latest\",\"parser-error\",\"partial-become\",\"playbook-extension\",\"risky-file-permissions\",\"risky-octal\",\"risky-shell-pipe\",\"role-name\",\"run-once\",\"run-once[play]\",\"run-once[task]\",\"sanity\",\"sanity[bad-ignore]\",\"sanity[cannot-ignore]\",\"schema\",\"syntax-check\",\"var-naming\",\"yaml\"],\"type\":\"string\"},{\"pattern\":\"^[a-z0-9-\\\\[\\\\]]+$\",\"type\":\"string\"}]},\"title\":\"Rules specific configuration.\",\"type\":\"object\"},\"rulesdir\":{\"items\":{\"type\":\"string\"},\"title\":\"Rulesdir\",\"type\":\"array\"},\"sarif_file\":{\"default\":null,\"title\":\"SARIF Output filename\",\"type\":[\"null\",\"string\"]},\"skip_action_validation\":{\"default\":false,\"title\":\"Skip Action Validation\",\"type\":\"boolean\"},\"skip_list\":{\"items\":{\"type\":\"string\"},\"title\":\"Skip List\",\"type\":\"array\"},\"strict\":{\"default\":false,\"title\":\"Strict\",\"type\":\"boolean\"},\"supported_ansible_also\":{\"items\":{\"type\":\"string\"},\"title\":\"Add supported ansible versions\",\"type\":\"array\"},\"tags\":{\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"task_name_prefix\":{\"default\":\"{stem} | \",\"title\":\"Allow custom prefix for task[prefix]\",\"type\":\"string\"},\"use_default_rules\":{\"default\":true,\"title\":\"Use Default Rules\",\"type\":\"boolean\"},\"var_naming_pattern\":{\"default\":\"^[a-z_][a-z0-9_]*$\",\"title\":\"Regex used to verify variable names\",\"type\":\"string\"},\"verbosity\":{\"default\":0,\"title\":\"Verbosity\",\"type\":\"integer\"},\"warn_list\":{\"items\":{\"type\":\"string\"},\"title\":\"Warn List\",\"type\":\"array\"},\"write_exclude_list\":{\"items\":{\"type\":\"string\"},\"title\":\"Write Exclude List\",\"type\":\"array\"},\"write_list\":{\"items\":{\"type\":\"string\"},\"title\":\"Write List\",\"type\":\"array\"}},\"title\":\"Ansible-lint Configuration Schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Ansible-lint Configuration Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$defs":{"rule":{"additionalProperties":false,"properties":{"exclude_paths":{"items":{"type":"string"},"title":"Glob-like paths to be excluded.","type":"array"}},"type":"object"}},"$id":"https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible-lint-config.json","$schema":"http://json-schema.org/draft-07/schema","additionalProperties":false,"description":"https://ansible.readthedocs.io/projects/lint/configuring/","examples":[".ansible-lint",".ansible-lint.yml",".ansible-lint.yaml",".config/ansible-lint.yml",".config/ansible-lint.yaml"],"properties":{"display_relative_path":{"default":true,"title":"Configure how to display file paths","type":"boolean"},"enable_list":{"items":{"type":"string"},"title":"Enable List","type":"array"},"exclude_paths":{"items":{"type":"string"},"title":"Exclude Paths","type":"array"},"extra_vars":{"title":"Extra Vars","type":"object"},"kinds":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"title":"Kinds","type":"array"},"loop_var_prefix":{"title":"Loop Var Prefix","type":"string"},"max_block_depth":{"title":"Maximum Block Depth","type":"integer","default":20},"mock_modules":{"items":{"type":"string"},"title":"Mock Modules","type":"array"},"mock_roles":{"items":{"type":"string"},"title":"Mock Roles","type":"array"},"offline":{"default":false,"title":"Offline","type":"boolean"},"only_builtins_allow_collections":{"items":{"type":"string"},"title":"Only Builtins Allow Collections","type":"array"},"only_builtins_allow_modules":{"items":{"type":"string"},"title":"Only Builtins Allow Modules","type":"array"},"parseable":{"default":true,"title":"Parseable","type":"boolean"},"profile":{"enum":["min","basic","moderate","safety","shared","production",null],"title":"Profile","type":["null","string"]},"progressive":{"default":false,"title":"Progressive (removed feature)","type":"boolean"},"project_dir":{"default":null,"title":"Project Directory","type":["string","null"]},"quiet":{"default":true,"title":"Quiet","type":"boolean"},"rules":{"additionalProperties":{"$ref":"#/$defs/rule"},"propertyNames":{"oneOf":[{"enum":["command-instead-of-module","command-instead-of-shell","deprecated-bare-vars","deprecated-local-action","deprecated-module","empty-string-compare","fqcn","fqcn[action-core]","fqcn[action]","fqcn[canonical]","fqcn[keyword]","galaxy","galaxy[no-changelog]","galaxy[no-runtime]","galaxy[tags]","galaxy[version-incorrect]","galaxy[version-missing]","ignore-errors","inline-env-var","internal-error","jinja","jinja[invalid]","jinja[spacing]","key-order","latest","literal-compare","load-failure","load-failure[not-found]","loop-var-prefix","loop-var-prefix[missing]","loop-var-prefix[wrong]","meta-incorrect","meta-no-tags","meta-runtime","meta-video-links","name","name[casing]","name[play]","name[prefix]","name[template]","no-changed-when","no-handler","no-jinja-when","no-log-password","no-prompting","no-relative-paths","no-same-owner","no-tabs","only-builtins","package-latest","parser-error","partial-become","playbook-extension","risky-file-permissions","risky-octal","risky-shell-pipe","role-name","run-once","run-once[play]","run-once[task]","sanity","sanity[bad-ignore]","sanity[cannot-ignore]","schema","syntax-check","var-naming","yaml"],"type":"string"},{"pattern":"^[a-z0-9-\\[\\]]+$","type":"string"}]},"title":"Rules specific configuration.","type":"object"},"rulesdir":{"items":{"type":"string"},"title":"Rulesdir","type":"array"},"sarif_file":{"default":null,"title":"SARIF Output filename","type":["null","string"]},"skip_action_validation":{"default":false,"title":"Skip Action Validation","type":"boolean"},"skip_list":{"items":{"type":"string"},"title":"Skip List","type":"array"},"strict":{"default":false,"title":"Strict","type":"boolean"},"supported_ansible_also":{"items":{"type":"string"},"title":"Add supported ansible versions","type":"array"},"tags":{"items":{"type":"string"},"title":"Tags","type":"array"},"task_name_prefix":{"default":"{stem} | ","title":"Allow custom prefix for task[prefix]","type":"string"},"use_default_rules":{"default":true,"title":"Use Default Rules","type":"boolean"},"var_naming_pattern":{"default":"^[a-z_][a-z0-9_]*$","title":"Regex used to verify variable names","type":"string"},"verbosity":{"default":0,"title":"Verbosity","type":"integer"},"warn_list":{"items":{"type":"string"},"title":"Warn List","type":"array"},"write_exclude_list":{"items":{"type":"string"},"title":"Write Exclude List","type":"array"},"write_list":{"items":{"type":"string"},"title":"Write List","type":"array"}},"title":"Ansible-lint Configuration Schema","type":"object"}
|
Provide a JSON object that satisfies the schema "Ansible-lint Configuration Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Ansible-lint Configuration Schema
|
schema-store
|
schema_store_38
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"additionalProperties\":false,\"description\":\"See https://ansible.readthedocs.io/projects/navigator/settings/\",\"properties\":{\"ansible-navigator\":{\"additionalProperties\":false,\"properties\":{\"ansible\":{\"additionalProperties\":false,\"properties\":{\"cmdline\":{\"description\":\"Extra parameters passed to the underlying ansible command (e.g. ansible-playbook, ansible-doc, etc)\",\"type\":\"string\"},\"config\":{\"additionalProperties\":false,\"properties\":{\"help\":{\"default\":false,\"description\":\"Help options for ansible-config command in stdout mode\",\"enum\":[true,false],\"type\":\"boolean\"},\"path\":{\"description\":\"Specify the path to the ansible configuration file\",\"type\":\"string\"}}},\"doc\":{\"additionalProperties\":false,\"properties\":{\"help\":{\"default\":false,\"description\":\"Help options for ansible-doc command in stdout mode\",\"enum\":[true,false],\"type\":\"boolean\"},\"plugin\":{\"additionalProperties\":false,\"properties\":{\"name\":{\"description\":\"Specify the plugin name\",\"type\":\"string\"},\"type\":{\"default\":\"module\",\"description\":\"Specify the plugin type, 'become', 'cache', 'callback', 'cliconf', 'connection', 'filter', 'httpapi', 'inventory', 'keyword', 'lookup', 'module', 'netconf', 'role', 'shell', 'strategy', 'test' or 'vars'\",\"enum\":[\"become\",\"cache\",\"callback\",\"cliconf\",\"connection\",\"filter\",\"httpapi\",\"inventory\",\"keyword\",\"lookup\",\"module\",\"netconf\",\"role\",\"shell\",\"strategy\",\"test\",\"vars\"],\"type\":\"string\"}},\"type\":\"object\"}},\"type\":\"object\"},\"inventory\":{\"additionalProperties\":false,\"properties\":{\"entries\":{\"description\":\"Specify an inventory file path or comma separated host list\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"help\":{\"default\":false,\"description\":\"Help options for ansible-inventory command in stdout mode\",\"enum\":[true,false],\"type\":\"boolean\"}}},\"playbook\":{\"additionalProperties\":false,\"properties\":{\"help\":{\"default\":false,\"description\":\"Help options for ansible-playbook command in stdout mode\",\"enum\":[true,false],\"type\":\"boolean\"},\"path\":{\"description\":\"Specify the playbook name\",\"type\":\"string\"}}}},\"type\":\"object\"},\"ansible-builder\":{\"additionalProperties\":false,\"properties\":{\"help\":{\"default\":false,\"description\":\"Help options for ansible-builder command in stdout mode\",\"enum\":[true,false],\"type\":\"boolean\"},\"workdir\":{\"default\":\".\",\"description\":\"Specify the path that contains ansible-builder manifest files\",\"type\":\"string\"}},\"type\":\"object\"},\"ansible-lint\":{\"additionalProperties\":false,\"properties\":{\"config\":{\"description\":\"Specify the path to the ansible-lint configuration file\",\"type\":\"string\"},\"lintables\":{\"description\":\"Path to files on which to run ansible-lint\",\"type\":\"string\"}},\"type\":\"object\"},\"ansible-runner\":{\"additionalProperties\":false,\"properties\":{\"artifact-dir\":{\"description\":\"The directory path to store artifacts generated by ansible-runner\",\"type\":\"string\"},\"job-events\":{\"default\":false,\"description\":\"Write ansible-runner job_events in the artifact directory\",\"enum\":[true,false],\"type\":\"boolean\"},\"rotate-artifacts-count\":{\"description\":\"Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted\",\"type\":\"integer\"},\"timeout\":{\"description\":\"The timeout value after which ansible-runner will forcefully stop the execution\",\"type\":\"integer\"}},\"type\":\"object\"},\"app\":{\"default\":\"welcome\",\"description\":\"Subcommands\",\"enum\":[\"builder\",\"collections\",\"config\",\"doc\",\"exec\",\"images\",\"inventory\",\"lint\",\"replay\",\"run\",\"settings\",\"welcome\"],\"type\":\"string\"},\"collection-doc-cache-path\":{\"default\":\"~/.cache/ansible-navigator/collection_doc_cache.db\",\"description\":\"The path to collection doc cache\",\"type\":\"string\"},\"color\":{\"additionalProperties\":false,\"properties\":{\"enable\":{\"default\":true,\"description\":\"Enable the use of color for mode interactive and stdout\",\"enum\":[true,false],\"type\":\"boolean\"},\"osc4\":{\"default\":true,\"description\":\"Enable or disable terminal color changing support with OSC 4\",\"enum\":[true,false],\"type\":\"boolean\"}},\"type\":\"object\"},\"editor\":{\"additionalProperties\":false,\"properties\":{\"command\":{\"default\":\"vi +{line_number} {filename}\",\"description\":\"Specify the editor command\",\"type\":\"string\"},\"console\":{\"default\":true,\"description\":\"Specify if the editor is console based\",\"enum\":[true,false],\"type\":\"boolean\"}},\"type\":\"object\"},\"enable-prompts\":{\"default\":false,\"description\":\"Enable prompts for password and in playbooks. This will set mode to stdout and disable playbook artifact creation\",\"enum\":[true,false],\"type\":\"boolean\"},\"exec\":{\"additionalProperties\":false,\"properties\":{\"command\":{\"default\":\"/bin/bash\",\"description\":\"Specify the command to run within the execution environment\",\"type\":\"string\"},\"shell\":{\"default\":true,\"description\":\"Specify the exec command should be run in a shell\",\"enum\":[true,false],\"type\":\"boolean\"}},\"type\":\"object\"},\"execution-environment\":{\"additionalProperties\":false,\"properties\":{\"container-engine\":{\"default\":\"auto\",\"description\":\"Specify the container engine (auto=podman then docker)\",\"enum\":[\"auto\",\"podman\",\"docker\"],\"type\":\"string\"},\"container-options\":{\"description\":\"Extra parameters passed to the container engine command\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"enabled\":{\"default\":true,\"description\":\"Enable or disable the use of an execution environment\",\"enum\":[true,false],\"type\":\"boolean\"},\"environment-variables\":{\"additionalProperties\":false,\"properties\":{\"pass\":{\"description\":\"Specify an existing environment variable to be passed through to and set within the execution environment (--penv MY_VAR)\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"set\":{\"description\":\"Specify an environment variable and a value to be set within the execution environment (--senv MY_VAR=42)\",\"type\":\"object\"}},\"type\":\"object\"},\"image\":{\"description\":\"Specify the name of the execution environment image\",\"type\":\"string\"},\"pull\":{\"additionalProperties\":false,\"properties\":{\"arguments\":{\"description\":\"Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. --pa='--tls-verify=false'\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"policy\":{\"default\":\"tag\",\"description\":\"Specify the image pull policy always:Always pull the image, missing:Pull if not locally available, never:Never pull the image, tag:if the image tag is 'latest', always pull the image, otherwise pull if not locally available\",\"enum\":[\"always\",\"missing\",\"never\",\"tag\"],\"type\":\"string\"}}},\"volume-mounts\":{\"additionalProperties\":false,\"description\":\"Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)\",\"items\":{\"additionalProperties\":false,\"properties\":{\"dest\":{\"type\":\"string\"},\"options\":{\"type\":\"string\"},\"src\":{\"type\":\"string\"}},\"required\":[\"src\",\"dest\"],\"type\":\"object\"},\"type\":\"array\"}},\"type\":\"object\"},\"format\":{\"default\":\"yaml\",\"description\":\"Specify the format for stdout output.\",\"enum\":[\"json\",\"yaml\"],\"type\":\"string\"},\"images\":{\"additionalProperties\":false,\"properties\":{\"details\":{\"default\":[\"everything\"],\"description\":\"Provide detailed information about the selected execution environment image\",\"items\":{\"enum\":[\"ansible_collections\",\"ansible_version\",\"everything\",\"os_release\",\"python_packages\",\"python_version\",\"redhat_release\",\"system_packages\"],\"type\":\"string\"},\"type\":\"array\"}}},\"inventory-columns\":{\"description\":\"Specify a host attribute to show in the inventory view\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"logging\":{\"additionalProperties\":false,\"properties\":{\"append\":{\"default\":true,\"description\":\"Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session\",\"enum\":[true,false],\"type\":\"boolean\"},\"file\":{\"default\":\"./ansible-navigator.log\",\"description\":\"Specify the full path for the ansible-navigator log file\",\"type\":\"string\"},\"level\":{\"default\":\"warning\",\"description\":\"Specify the ansible-navigator log level\",\"enum\":[\"debug\",\"info\",\"warning\",\"error\",\"critical\"],\"type\":\"string\"}},\"type\":\"object\"},\"mode\":{\"default\":\"interactive\",\"description\":\"Specify the user-interface mode\",\"enum\":[\"stdout\",\"interactive\"],\"type\":\"string\"},\"playbook-artifact\":{\"additionalProperties\":false,\"properties\":{\"enable\":{\"default\":true,\"description\":\"Enable or disable the creation of artifacts for completed playbooks. Note: not compatible with '--mode stdout' when playbooks require user input\",\"enum\":[true,false],\"type\":\"boolean\"},\"replay\":{\"description\":\"Specify the path for the playbook artifact to replay\",\"type\":\"string\"},\"save-as\":{\"default\":\"{playbook_dir}/{playbook_name}-artifact-{time_stamp}.json\",\"description\":\"Specify the name for artifacts created from completed playbooks. The following placeholders are available: {playbook_dir}, {playbook_name}, {playbook_status}, and {time_stamp}\",\"type\":\"string\"}},\"type\":\"object\"},\"settings\":{\"additionalProperties\":false,\"properties\":{\"effective\":{\"default\":false,\"description\":\"Show the effective settings. Defaults, CLI parameters, environment variables, and the settings file will be combined\",\"type\":\"boolean\"},\"sample\":{\"default\":false,\"description\":\"Generate a sample settings file\",\"type\":\"boolean\"},\"schema\":{\"default\":\"json\",\"description\":\"Generate a schema for the settings file ('json'= draft-07 JSON Schema)\",\"enum\":[\"json\"],\"type\":\"string\"},\"sources\":{\"default\":false,\"description\":\"Show the source of each current settings entry\",\"type\":\"boolean\"}}},\"time-zone\":{\"default\":\"UTC\",\"description\":\"Specify the IANA time zone to use or 'local' to use the system time zone\",\"type\":\"string\"}}}},\"required\":[\"ansible-navigator\"],\"title\":\"ansible-navigator settings v25\",\"type\":\"object\",\"version\":\"25\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ansible-navigator settings v25\". Here are the required top‑level fields: ansible-navigator. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema","additionalProperties":false,"description":"See https://ansible.readthedocs.io/projects/navigator/settings/","properties":{"ansible-navigator":{"additionalProperties":false,"properties":{"ansible":{"additionalProperties":false,"properties":{"cmdline":{"description":"Extra parameters passed to the underlying ansible command (e.g. ansible-playbook, ansible-doc, etc)","type":"string"},"config":{"additionalProperties":false,"properties":{"help":{"default":false,"description":"Help options for ansible-config command in stdout mode","enum":[true,false],"type":"boolean"},"path":{"description":"Specify the path to the ansible configuration file","type":"string"}}},"doc":{"additionalProperties":false,"properties":{"help":{"default":false,"description":"Help options for ansible-doc command in stdout mode","enum":[true,false],"type":"boolean"},"plugin":{"additionalProperties":false,"properties":{"name":{"description":"Specify the plugin name","type":"string"},"type":{"default":"module","description":"Specify the plugin type, 'become', 'cache', 'callback', 'cliconf', 'connection', 'filter', 'httpapi', 'inventory', 'keyword', 'lookup', 'module', 'netconf', 'role', 'shell', 'strategy', 'test' or 'vars'","enum":["become","cache","callback","cliconf","connection","filter","httpapi","inventory","keyword","lookup","module","netconf","role","shell","strategy","test","vars"],"type":"string"}},"type":"object"}},"type":"object"},"inventory":{"additionalProperties":false,"properties":{"entries":{"description":"Specify an inventory file path or comma separated host list","items":{"type":"string"},"type":"array"},"help":{"default":false,"description":"Help options for ansible-inventory command in stdout mode","enum":[true,false],"type":"boolean"}}},"playbook":{"additionalProperties":false,"properties":{"help":{"default":false,"description":"Help options for ansible-playbook command in stdout mode","enum":[true,false],"type":"boolean"},"path":{"description":"Specify the playbook name","type":"string"}}}},"type":"object"},"ansible-builder":{"additionalProperties":false,"properties":{"help":{"default":false,"description":"Help options for ansible-builder command in stdout mode","enum":[true,false],"type":"boolean"},"workdir":{"default":".","description":"Specify the path that contains ansible-builder manifest files","type":"string"}},"type":"object"},"ansible-lint":{"additionalProperties":false,"properties":{"config":{"description":"Specify the path to the ansible-lint configuration file","type":"string"},"lintables":{"description":"Path to files on which to run ansible-lint","type":"string"}},"type":"object"},"ansible-runner":{"additionalProperties":false,"properties":{"artifact-dir":{"description":"The directory path to store artifacts generated by ansible-runner","type":"string"},"job-events":{"default":false,"description":"Write ansible-runner job_events in the artifact directory","enum":[true,false],"type":"boolean"},"rotate-artifacts-count":{"description":"Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted","type":"integer"},"timeout":{"description":"The timeout value after which ansible-runner will forcefully stop the execution","type":"integer"}},"type":"object"},"app":{"default":"welcome","description":"Subcommands","enum":["builder","collections","config","doc","exec","images","inventory","lint","replay","run","settings","welcome"],"type":"string"},"collection-doc-cache-path":{"default":"~/.cache/ansible-navigator/collection_doc_cache.db","description":"The path to collection doc cache","type":"string"},"color":{"additionalProperties":false,"properties":{"enable":{"default":true,"description":"Enable the use of color for mode interactive and stdout","enum":[true,false],"type":"boolean"},"osc4":{"default":true,"description":"Enable or disable terminal color changing support with OSC 4","enum":[true,false],"type":"boolean"}},"type":"object"},"editor":{"additionalProperties":false,"properties":{"command":{"default":"vi +{line_number} {filename}","description":"Specify the editor command","type":"string"},"console":{"default":true,"description":"Specify if the editor is console based","enum":[true,false],"type":"boolean"}},"type":"object"},"enable-prompts":{"default":false,"description":"Enable prompts for password and in playbooks. This will set mode to stdout and disable playbook artifact creation","enum":[true,false],"type":"boolean"},"exec":{"additionalProperties":false,"properties":{"command":{"default":"/bin/bash","description":"Specify the command to run within the execution environment","type":"string"},"shell":{"default":true,"description":"Specify the exec command should be run in a shell","enum":[true,false],"type":"boolean"}},"type":"object"},"execution-environment":{"additionalProperties":false,"properties":{"container-engine":{"default":"auto","description":"Specify the container engine (auto=podman then docker)","enum":["auto","podman","docker"],"type":"string"},"container-options":{"description":"Extra parameters passed to the container engine command","items":{"type":"string"},"type":"array"},"enabled":{"default":true,"description":"Enable or disable the use of an execution environment","enum":[true,false],"type":"boolean"},"environment-variables":{"additionalProperties":false,"properties":{"pass":{"description":"Specify an existing environment variable to be passed through to and set within the execution environment (--penv MY_VAR)","items":{"type":"string"},"type":"array"},"set":{"description":"Specify an environment variable and a value to be set within the execution environment (--senv MY_VAR=42)","type":"object"}},"type":"object"},"image":{"description":"Specify the name of the execution environment image","type":"string"},"pull":{"additionalProperties":false,"properties":{"arguments":{"description":"Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. --pa='--tls-verify=false'","items":{"type":"string"},"type":"array"},"policy":{"default":"tag","description":"Specify the image pull policy always:Always pull the image, missing:Pull if not locally available, never:Never pull the image, tag:if the image tag is 'latest', always pull the image, otherwise pull if not locally available","enum":["always","missing","never","tag"],"type":"string"}}},"volume-mounts":{"additionalProperties":false,"description":"Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)","items":{"additionalProperties":false,"properties":{"dest":{"type":"string"},"options":{"type":"string"},"src":{"type":"string"}},"required":["src","dest"],"type":"object"},"type":"array"}},"type":"object"},"format":{"default":"yaml","description":"Specify the format for stdout output.","enum":["json","yaml"],"type":"string"},"images":{"additionalProperties":false,"properties":{"details":{"default":["everything"],"description":"Provide detailed information about the selected execution environment image","items":{"enum":["ansible_collections","ansible_version","everything","os_release","python_packages","python_version","redhat_release","system_packages"],"type":"string"},"type":"array"}}},"inventory-columns":{"description":"Specify a host attribute to show in the inventory view","items":{"type":"string"},"type":"array"},"logging":{"additionalProperties":false,"properties":{"append":{"default":true,"description":"Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session","enum":[true,false],"type":"boolean"},"file":{"default":"./ansible-navigator.log","description":"Specify the full path for the ansible-navigator log file","type":"string"},"level":{"default":"warning","description":"Specify the ansible-navigator log level","enum":["debug","info","warning","error","critical"],"type":"string"}},"type":"object"},"mode":{"default":"interactive","description":"Specify the user-interface mode","enum":["stdout","interactive"],"type":"string"},"playbook-artifact":{"additionalProperties":false,"properties":{"enable":{"default":true,"description":"Enable or disable the creation of artifacts for completed playbooks. Note: not compatible with '--mode stdout' when playbooks require user input","enum":[true,false],"type":"boolean"},"replay":{"description":"Specify the path for the playbook artifact to replay","type":"string"},"save-as":{"default":"{playbook_dir}/{playbook_name}-artifact-{time_stamp}.json","description":"Specify the name for artifacts created from completed playbooks. The following placeholders are available: {playbook_dir}, {playbook_name}, {playbook_status}, and {time_stamp}","type":"string"}},"type":"object"},"settings":{"additionalProperties":false,"properties":{"effective":{"default":false,"description":"Show the effective settings. Defaults, CLI parameters, environment variables, and the settings file will be combined","type":"boolean"},"sample":{"default":false,"description":"Generate a sample settings file","type":"boolean"},"schema":{"default":"json","description":"Generate a schema for the settings file ('json'= draft-07 JSON Schema)","enum":["json"],"type":"string"},"sources":{"default":false,"description":"Show the source of each current settings entry","type":"boolean"}}},"time-zone":{"default":"UTC","description":"Specify the IANA time zone to use or 'local' to use the system time zone","type":"string"}}}},"required":["ansible-navigator"],"title":"ansible-navigator settings v25","type":"object","version":"25"}
|
Provide a JSON object that satisfies the schema "ansible-navigator settings v25". Here are the required top‑level fields: ansible-navigator. Return only the valid JSON object.
|
ansible-navigator settings v25
|
schema-store
|
schema_store_39
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/any.json\",\"anyOf\":[{\"type\":\"object\"},{\"type\":\"array\"},{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"type\":\"null\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"any\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/any.json","anyOf":[{"type":"object"},{"type":"array"},{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}
|
Provide a JSON object that satisfies the schema "any". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
any
|
schema-store
|
schema_store_40
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/anywork-ac-1.0.json\",\"additionalProperties\":true,\"allOf\":[{\"if\":{\"properties\":{\"ctype\":{\"const\":\"swagger-codegen\"}}},\"then\":{\"required\":[\"swagger-codegen\"],\"properties\":{\"swagger-codegen\":{\"title\":\"swagger codegen\",\"type\":\"object\",\"description\":\"swagger-codegen Configuration\",\"additionalProperties\":false,\"required\":[\"schemas\"],\"properties\":{\"schemas\":{\"type\":\"array\",\"description\":\"List of schemas (microservices) to generate it's libraries.\",\"items\":{\"title\":\"schema\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"name\",\"actions\"],\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"[a-zA-Z]+\",\"description\":\"Name of schema. This will be used to generate codes, only `[a-zA-Z]+` is accepted.\",\"examples\":[\"authorization\"]},\"disable\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Disables all actions over this schema.\"},\"actions\":{\"type\":\"array\",\"description\":\"Determines the actions should be applied over this schema.\",\"uniqueItems\":true,\"items\":{\"anyOf\":[{\"title\":\"action\",\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines a download schema task.\",\"required\":[\"type\",\"sourceUrl\",\"id\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"download\",\"description\":\"Type of action to apply.\"},\"sourceUrl\":{\"type\":\"string\",\"examples\":[\"http://somewhere/path/to/swagger.json\"],\"pattern\":\"http[s]?:\\\\/\\\\/.*\\\\/swagger\\\\.json\",\"description\":\"Source of `swagger.json` schema to download\"},\"id\":{\"type\":\"number\",\"description\":\"A unique specific ID of this download to be referenced (`DOWNLOAD_ID`).\",\"default\":0},\"disable\":{\"$ref\":\"#/definitions/disable\"}}},{\"title\":\"action\",\"type\":\"object\",\"additionalProperties\":true,\"description\":\"Defines a TS code generator task.\",\"required\":[\"type\",\"ngVersion\",\"id\",\"downloadId\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"generate\",\"description\":\"Type of action to apply.\"},\"ngVersion\":{\"$ref\":\"#/definitions/version\",\"description\":\"Specifies Angular version which codes will be generated for.\",\"default\":\"12.2.14\"},\"id\":{\"type\":\"number\",\"description\":\"A unique specific ID of this generation to be referenced (`GENERATE_ID`).\",\"default\":0},\"downloadId\":{\"type\":\"number\",\"description\":\"The `DOWNLOAD_ID` of downloaded schema to generate codes based on.\",\"default\":0},\"disable\":{\"$ref\":\"#/definitions/disable\"}}},{\"title\":\"action\",\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines a code correction task.\",\"required\":[\"type\",\"generateId\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"correction\",\"description\":\"Type of action to apply.\"},\"generateId\":{\"$ref\":\"#/definitions/generateId\"},\"disable\":{\"$ref\":\"#/definitions/disable\"}}},{\"title\":\"action\",\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines a TS code builder task.\",\"required\":[\"type\",\"typescriptVersion\",\"id\",\"generateId\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"build\",\"description\":\"Type of action to apply.\"},\"typescriptVersion\":{\"$ref\":\"#/definitions/version\",\"description\":\"Specifies TypeScript version to install before build.\",\"default\":\"4.3.5\"},\"id\":{\"type\":\"number\",\"description\":\"A unique specific ID of this build to be referenced (`BUILD_ID`).\"},\"generateId\":{\"$ref\":\"#/definitions/generateId\"},\"disable\":{\"$ref\":\"#/definitions/disable\"}}},{\"title\":\"action\",\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines a `npm publish` task.\",\"required\":[\"type\",\"registryUrl\",\"token\",\"id\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"publish\",\"description\":\"Type of action to apply.\"},\"registryUrl\":{\"type\":\"string\",\"description\":\"The Url of registry accepting this repository.\",\"pattern\":\"http[s]?://.*\",\"default\":\"http://verdaccio.anywork.local:4873\"},\"token\":{\"type\":\"string\",\"description\":\"Token to use access registry.\",\"default\":\"bzKaK7hK2OAoCK9d72S0UevXGZEjj8rZpv8AFoaZ+/w=\",\"examples\":[\"bzKaK7hK2OAoCK9d72S0UevXGZEjj8rZpv8AFoaZ+/w=\"]},\"buildId\":{\"$ref\":\"#/definitions/buildId\"},\"id\":{\"type\":\"number\",\"description\":\"A unique specific ID of this publish to be referenced (`PUBLISH_ID`).\",\"default\":0},\"disable\":{\"$ref\":\"#/definitions/disable\"}}},{\"title\":\"action\",\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Defines a Api install task.\",\"required\":[\"type\",\"targetPath\",\"publishId\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"install\",\"description\":\"Type of action to apply.\"},\"publishId\":{\"type\":\"number\",\"description\":\"The `PUBLISH_ID` to use for this task.\",\"default\":0},\"targetPath\":{\"type\":\"string\",\"description\":\"The relative or absolute physical path of directory containing `packages.json` to install specified\"},\"disable\":{\"$ref\":\"#/definitions/disable\"}}}]}}}}}}}}}}],\"definitions\":{\"version\":{\"pattern\":\"^[\\\\^~]?(0|[1-9]\\\\d*)\\\\.(0|[1-9]\\\\d*)\\\\.(0|[1-9]\\\\d*)(?:-((?:0|[1-9]\\\\d*|\\\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\\\.(?:0|[1-9]\\\\d*|\\\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\\\+([0-9a-zA-Z-]+(?:\\\\.[0-9a-zA-Z-]+)*))?$\"},\"buildId\":{\"type\":\"number\",\"description\":\"The `BUILD_ID` to use for this task.\",\"default\":0},\"generateId\":{\"type\":\"number\",\"description\":\"The `GENERATE_ID` to use for this task.\",\"default\":0},\"disable\":{\"type\":\"boolean\",\"description\":\"Determines if this task is disabled.\",\"default\":true}},\"description\":\"Used to configure any part of AnyWork automation.\",\"properties\":{\"ctype\":{\"type\":\"string\",\"description\":\"type of configuration, means who will use this configuration.\"},\"cversion\":{\"type\":\"integer\",\"default\":1,\"description\":\"Version of configuration. The reader will parse configuration based on this.\"}},\"required\":[\"ctype\",\"cversion\"],\"title\":\"AnyWork Automation Configuration schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"AnyWork Automation Configuration schema\". Here are the required top‑level fields: ctype, cversion. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/anywork-ac-1.0.json","additionalProperties":true,"allOf":[{"if":{"properties":{"ctype":{"const":"swagger-codegen"}}},"then":{"required":["swagger-codegen"],"properties":{"swagger-codegen":{"title":"swagger codegen","type":"object","description":"swagger-codegen Configuration","additionalProperties":false,"required":["schemas"],"properties":{"schemas":{"type":"array","description":"List of schemas (microservices) to generate it's libraries.","items":{"title":"schema","type":"object","additionalProperties":false,"required":["name","actions"],"properties":{"name":{"type":"string","pattern":"[a-zA-Z]+","description":"Name of schema. This will be used to generate codes, only `[a-zA-Z]+` is accepted.","examples":["authorization"]},"disable":{"type":"boolean","default":true,"description":"Disables all actions over this schema."},"actions":{"type":"array","description":"Determines the actions should be applied over this schema.","uniqueItems":true,"items":{"anyOf":[{"title":"action","type":"object","additionalProperties":false,"description":"Defines a download schema task.","required":["type","sourceUrl","id"],"properties":{"type":{"type":"string","const":"download","description":"Type of action to apply."},"sourceUrl":{"type":"string","examples":["http://somewhere/path/to/swagger.json"],"pattern":"http[s]?:\\/\\/.*\\/swagger\\.json","description":"Source of `swagger.json` schema to download"},"id":{"type":"number","description":"A unique specific ID of this download to be referenced (`DOWNLOAD_ID`).","default":0},"disable":{"$ref":"#/definitions/disable"}}},{"title":"action","type":"object","additionalProperties":true,"description":"Defines a TS code generator task.","required":["type","ngVersion","id","downloadId"],"properties":{"type":{"type":"string","const":"generate","description":"Type of action to apply."},"ngVersion":{"$ref":"#/definitions/version","description":"Specifies Angular version which codes will be generated for.","default":"12.2.14"},"id":{"type":"number","description":"A unique specific ID of this generation to be referenced (`GENERATE_ID`).","default":0},"downloadId":{"type":"number","description":"The `DOWNLOAD_ID` of downloaded schema to generate codes based on.","default":0},"disable":{"$ref":"#/definitions/disable"}}},{"title":"action","type":"object","additionalProperties":false,"description":"Defines a code correction task.","required":["type","generateId"],"properties":{"type":{"type":"string","const":"correction","description":"Type of action to apply."},"generateId":{"$ref":"#/definitions/generateId"},"disable":{"$ref":"#/definitions/disable"}}},{"title":"action","type":"object","additionalProperties":false,"description":"Defines a TS code builder task.","required":["type","typescriptVersion","id","generateId"],"properties":{"type":{"type":"string","const":"build","description":"Type of action to apply."},"typescriptVersion":{"$ref":"#/definitions/version","description":"Specifies TypeScript version to install before build.","default":"4.3.5"},"id":{"type":"number","description":"A unique specific ID of this build to be referenced (`BUILD_ID`)."},"generateId":{"$ref":"#/definitions/generateId"},"disable":{"$ref":"#/definitions/disable"}}},{"title":"action","type":"object","additionalProperties":false,"description":"Defines a `npm publish` task.","required":["type","registryUrl","token","id"],"properties":{"type":{"type":"string","const":"publish","description":"Type of action to apply."},"registryUrl":{"type":"string","description":"The Url of registry accepting this repository.","pattern":"http[s]?://.*","default":"http://verdaccio.anywork.local:4873"},"token":{"type":"string","description":"Token to use access registry.","default":"bzKaK7hK2OAoCK9d72S0UevXGZEjj8rZpv8AFoaZ+/w=","examples":["bzKaK7hK2OAoCK9d72S0UevXGZEjj8rZpv8AFoaZ+/w="]},"buildId":{"$ref":"#/definitions/buildId"},"id":{"type":"number","description":"A unique specific ID of this publish to be referenced (`PUBLISH_ID`).","default":0},"disable":{"$ref":"#/definitions/disable"}}},{"title":"action","type":"object","additionalProperties":false,"description":"Defines a Api install task.","required":["type","targetPath","publishId"],"properties":{"type":{"type":"string","const":"install","description":"Type of action to apply."},"publishId":{"type":"number","description":"The `PUBLISH_ID` to use for this task.","default":0},"targetPath":{"type":"string","description":"The relative or absolute physical path of directory containing `packages.json` to install specified"},"disable":{"$ref":"#/definitions/disable"}}}]}}}}}}}}}}],"definitions":{"version":{"pattern":"^[\\^~]?(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"},"buildId":{"type":"number","description":"The `BUILD_ID` to use for this task.","default":0},"generateId":{"type":"number","description":"The `GENERATE_ID` to use for this task.","default":0},"disable":{"type":"boolean","description":"Determines if this task is disabled.","default":true}},"description":"Used to configure any part of AnyWork automation.","properties":{"ctype":{"type":"string","description":"type of configuration, means who will use this configuration."},"cversion":{"type":"integer","default":1,"description":"Version of configuration. The reader will parse configuration based on this."}},"required":["ctype","cversion"],"title":"AnyWork Automation Configuration schema","type":"object"}
|
Provide a JSON object that satisfies the schema "AnyWork Automation Configuration schema". Here are the required top‑level fields: ctype, cversion. Return only the valid JSON object.
|
AnyWork Automation Configuration schema
|
schema-store
|
schema_store_41
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{\"apidoc\":{\"title\":\"API documentation\",\"type\":\"object\",\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec.\"}},\"required\":[\"version\"],\"additionalProperties\":false},\"info\":{\"title\":\"contact information\",\"type\":\"object\",\"properties\":{\"contact\":{\"$ref\":\"#/definitions/contact\",\"description\":\"Specifies contact information for this service.\"},\"license\":{\"$ref\":\"#/definitions/license\",\"description\":\"Specifies the license under which this service is released.\"}},\"additionalProperties\":false},\"contact\":{\"title\":\"contact information\",\"type\":\"object\",\"description\":\"Specifies contact information for this service\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Identifying name of the contact person/organization\"},\"url\":{\"type\":\"string\",\"description\":\"URL pointing to the contact information\"},\"email\":{\"type\":\"string\",\"description\":\"Email address of the contact person/organization\"}},\"additionalProperties\":false},\"license\":{\"title\":\"license\",\"type\":\"object\",\"description\":\"specifies the license under which this service is released\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the license - e.g. MIT\"},\"url\":{\"type\":\"string\",\"description\":\"URL of the license itself\"}},\"required\":[\"name\"],\"additionalProperties\":false},\"import\":{\"title\":\"import\",\"type\":\"object\",\"properties\":{\"uri\":{\"type\":\"string\",\"description\":\"The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the \\\"service.json\\\" link for a service.\"}},\"required\":[\"uri\"],\"additionalProperties\":false},\"header\":{\"title\":\"header\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the header.\"},\"type\":{\"type\":\"string\",\"description\":\"The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with \\\"[]\\\". For example, to specify that the type is a collection of strings, use \\\"[string]\\\".\"},\"required\":{\"type\":\"boolean\",\"default\":true,\"description\":\"boolean: true|false. By default, all headers are considered required. To make a parameter optional, set \\\"required\\\" to false.\"},\"default\":{\"description\":\"The default value for this header. If specified, generated clients will automatically include this header in all requests. Default values must be specified as strings.\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this header provides. Supports GFM.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this header for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"name\",\"type\"],\"additionalProperties\":false},\"annotation\":{\"title\":\"annotation\",\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]*$\":{\"title\":\"annotation\",\"type\":\"object\",\"description\":\"An annotation is just a short key that can be used to tag any field in any model of this API.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Describes what the annotation is used for.\"},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"additionalProperties\":false}}},\"attribute\":{\"title\":\"attribute\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"the name and identifier of the attribute.\"},\"value\":{\"title\":\"json object\",\"type\":\"object\",\"description\":\"a JSON object that is usually utilized by a downstream Generator.\"},\"description\":{\"type\":\"string\"}},\"required\":[\"name\",\"value\"],\"additionalProperties\":false},\"deprecation\":{\"title\":\"json object\",\"type\":\"object\",\"description\":\"JSON Object that indicates that this object is deprecated.\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM.\"}},\"additionalProperties\":false},\"enum\":{\"title\":\"enumeration\",\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]*$\":{\"title\":\"name\",\"type\":\"object\",\"description\":\"The name of the enum. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.\",\"properties\":{\"plural\":{\"type\":\"string\",\"description\":\"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.\"},\"description\":{\"type\":\"string\",\"description\":\"Optional longer description for this enum.\"},\"values\":{\"type\":\"array\",\"description\":\"JSON Array of EnumValue objects. Each element defines a valid value and an optional description.\",\"items\":{\"$ref\":\"#/definitions/enumvalues\"}},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this enum for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"values\"],\"additionalProperties\":false}}},\"enumvalues\":{\"title\":\"evaluates\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the value. Names must start with a letter.\"},\"value\":{\"type\":\"string\",\"description\":\"The actual string representation of this value when serializing. If not specified, defaults to 'name'.\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this enum value provides. Supports GFM.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this enum value for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"name\"],\"additionalProperties\":false},\"interface\":{\"title\":\"interface\",\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]*$\":{\"title\":\"name\",\"type\":\"object\",\"description\":\"Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, or models. Note you may define an interface and a union of the same name.\",\"properties\":{\"plural\":{\"type\":\"string\",\"description\":\"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this model provides. Supports GFM.\"},\"fields\":{\"type\":\"array\",\"description\":\"JSON Array of 0 or more Fields.\",\"items\":{\"$ref\":\"#/definitions/field\"}},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this model for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"additionalProperties\":false}}},\"field\":{\"title\":\"field\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Specifies the name of the field. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.\",\"pattern\":\"^[a-zA-Z0-9_]*$\"},\"type\":{\"type\":\"string\",\"description\":\"Specifies the type of this field. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \\\"[]\\\". For example, to specify that the type is a collection of strings, use \\\"[string]\\\". To specify a Map, the type name can be prefixed with \\\"map[type]\\\". For example, to specify that the type is a Map of string to long, use \\\"map[long]\\\". Note that for map, the keys must be strings (per the JSON specification).\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this field provides. Supports GFM.\"},\"required\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default, all fields are considered required. To make a field optional, set \\\"required\\\" to false. When a field is marked as required, it must be present in any form of a model for that form to be valid. In client-server scenario, this means that any defaults that are present in the model must be applied by the client. If you want a default to be applied by the receiver, you should mark the field as \\\"required\\\": false\"},\"default\":{\"description\":\"Optional default value. The value must be valid for the type specified for this field. For example, if you specify a field named 'limit' with type 'integer', an acceptable default would be 10.\"},\"example\":{\"type\":\"string\",\"description\":\"Optional - an example value for this field used only in the produced documentation\"},\"minimum\":{\"type\":\"integer\",\"description\":\"Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element.\"},\"maximum\":{\"type\":\"integer\",\"description\":\"Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this field for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"},\"annotations\":{\"type\":\"array\",\"description\":\"JSON Array of type string where each value indicates the name of a declared annotation (optional),\",\"items\":{\"type\":\"string\"}}},\"required\":[\"name\",\"type\"],\"additionalProperties\":false},\"model\":{\"title\":\"model\",\"type\":\"object\",\"description\":\"specifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.\",\"patternProperties\":{\"^[a-zA-Z0-9_]*$\":{\"title\":\"model\",\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Description for what this model provides.\"},\"plural\":{\"type\":\"string\",\"description\":\"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.\"},\"interfaces\":{\"type\":\"array\",\"description\":\"JSON Array of type string where each value indicates the name of a declared interface\",\"items\":{\"type\":\"string\"}},\"fields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/field\"}},\"attributes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}}}},\"additionalProperties\":false},\"union\":{\"title\":\"union\",\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]*$\":{\"type\":\"object\",\"description\":\"Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, unions, or models. Note you may define an interface and a union of the same name, but in this case it is required to list that interface in the interfaces field.\",\"properties\":{\"plural\":{\"type\":\"string\",\"description\":\"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.\"},\"discriminator\":{\"type\":\"string\",\"description\":\"Specifies an optional, but recommended, name for a type discriminator field which can then be used in serialization / deserialization to identify the type of object. For example, if not specified, a code generator may serialize the union type into a JSON structure of { \\\"type\\\" => object }. If a discriminator is provided, the same code generator can flatten the JSON representation to, for example: { \\\"discriminator\\\" => \\\"xxx\\\", \\\"field1\\\" => \\\"yyy\\\" }. If provided, the name of the discriminator field must be unique across all of the fields across all of the types of this union.\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this union provides. Supports GFM.\"},\"interfaces\":{\"type\":\"array\",\"description\":\"JSON Array of type string where each value indicates the name of a declared interface\",\"items\":{\"type\":\"string\"}},\"types\":{\"type\":\"array\",\"description\":\"Specifies the individual types that are part of this union type.\",\"items\":{\"$ref\":\"#/definitions/uniontype\"}},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this union for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"types\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"uniontype\":{\"title\":\"union type\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Specifies the type to include in this union type. Acceptable values include the name of either an enum, a model, or a (primitive type).\\ndescription optional description for what this type provides. Supports GFM.\"},\"description\":{\"type\":\"string\"},\"default\":{\"type\":\"boolean\",\"description\":\"If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization.\"},\"discriminator_value\":{\"type\":\"string\",\"description\":\"The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this union type for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"type\"],\"additionalProperties\":false},\"resource\":{\"title\":\"resource\",\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_.]*$\":{\"title\":\"name\",\"type\":\"object\",\"description\":\"The name of the model or enum that this resource represents\",\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Optional path where this resource is located. If not provided, defaults to the plural of the typeName, with some assumptions of formatting for web (e.g. lower case, dash separated). Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that all operations for this path will require a parameter named 'guid' of type 'string'\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this resource provides. Supports GFM.\"},\"operations\":{\"type\":\"array\",\"description\":\"One or more operations is required.\",\"items\":{\"$ref\":\"#/definitions/operation\"}},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this resource for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"operations\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"operation\":{\"title\":\"operation\",\"type\":\"object\",\"description\":\"\",\"properties\":{\"method\":{\"type\":\"string\",\"description\":\"The HTTP method for this operation\"},\"path\":{\"type\":\"string\",\"description\":\"Optional path for this particular operation. If not provided, defaults to no additional path. Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that this operation is available at /resource_path/:guid. Path parameter types are inferred by looking for a field with that name on the model associated with this resource. If not found, the datatype of any path parameter will be string.\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this operation provides. Supports GFM.\"},\"body\":{\"$ref\":\"#/definitions/body\",\"description\":\"Optional specification for the type of the body of this request. For all operations that support bodies (e.g. POST, PUT, PATCH), allows you to specify the type of the body.\"},\"parameters\":{\"type\":\"array\",\"description\":\"Optional JSON Array of the parameters to this method. By default, for GET methods, parameters are assumed to be in the path or in the query. For other methods, parameters are assumed to be in the path or form body, unless you have explicitly specified a body in which case parameters can be provided in the path or the query.\",\"items\":{\"$ref\":\"#/definitions/parameter\"}},\"responses\":{\"$ref\":\"#/definitions/response\",\"description\":\"Optional JSON Object of HTTP Response Code to Response. If not provided, an HTTP NoContent response is assumed. Only responses for HTTP status codes that are interesting should be documented.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON array defining additional meta data about this operation for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"method\"],\"additionalProperties\":false},\"parameter\":{\"title\":\"parameter\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the parameter. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.\",\"pattern\":\"^[a-zA-Z0-9_]*$\"},\"type\":{\"type\":\"string\",\"description\":\"Specifies the type of this parameter. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \\\"[]\\\". For example, to specify that the type is a collection of strings, use \\\"[string]\\\". To specify a Map, the type name can be prefixed with \\\"map[type]\\\". For example, to specify that the type is a Map of string to long, use \\\"map[long]\\\". Note that for map, the keys must be strings (per the JSON specification).\"},\"location\":{\"type\":\"string\",\"description\":\"One of: path, query, form, header. Defines the location of this parameter. Default location varies based on the context of the parameter (e.g. if the operation method is a POST, the default will be Form; if a GET, the default will be Query)\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this parameter provides. Supports GFM.\"},\"required\":{\"type\":\"boolean\",\"default\":true,\"description\":\"By default all parameters are considered required. To make a parameter optional, set \\\"required\\\" to false.\"},\"default\":{\"description\":\"Optional default value. The value must be valid for the type specified for this parameter. For example, if you specify a parameter named 'limit' with type 'integer', an acceptable default would be 10\"},\"example\":{\"type\":\"string\",\"description\":\"Optional - an example value for this parameter used only in the produced documentation\"},\"minimum\":{\"type\":\"integer\",\"description\":\"Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element.\"},\"maximum\":{\"type\":\"integer\",\"description\":\"Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON array defining additional meta data about this parameter for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"name\",\"type\"],\"additionalProperties\":false},\"response\":{\"title\":\"response\",\"type\":\"object\",\"patternProperties\":{\"^[0-9]*$\":{\"title\":\"HTTP status\",\"type\":\"object\",\"description\":\"A valid HTTP status code for this response (e.g. 200). Only status codes that have interesting return types should be documented. You can also specify an HTTP status code of 'default' to map to all other non documented types. This is useful to capture a generic error type that would be returned for non documented response codes.\\n\\nThere are a few conventions enforced:\\n- HTTP Response codes of 5xx cannot be explicitly specified and are handled automatically to ensure consistent behavior in generated client libraries.\\n- HTTP Response codes of 204 and 304 indicate that no content is returned, so they must use a type of unit.\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Specifies the type of this response. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \\\"[]\\\". For example, to specify that the type is a collection of strings, use \\\"[string]\\\". To specify a Map, the type name can be prefixed with \\\"map[type]\\\". For example, to specify that the type is a Map of string to long, use \\\"map[long]\\\". Note that for map, the keys must be strings (per the JSON specification).\"},\"headers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/header\"}},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this response provides. Supports GFM.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"type\"],\"additionalProperties\":false}},\"additionalProperties\":false},\"body\":{\"title\":\"body\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"Specifies the type of this body. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \\\"[]\\\". For example, to specify that the type is a collection of strings, use \\\"[string]\\\". To specify a Map, the type name can be prefixed with \\\"map[type]\\\". For example, to specify that the type is a Map of string to long, use \\\"map[long]\\\". Note that for map, the keys must be strings (per the JSON specification).\"},\"description\":{\"type\":\"string\",\"description\":\"Optional description for what this body provides. Supports GFM.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this body for use by generators.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"deprecation\":{\"$ref\":\"#/definitions/deprecation\"}},\"required\":[\"type\"],\"additionalProperties\":false}},\"description\":\"JSON Schema for API Builder's api.json format from https://app.apibuilder.io/doc/apiJson\",\"id\":\"https://json.schemastore.org/apibuilder.json\",\"properties\":{\"$schema\":{\"type\":\"string\",\"description\":\"A JSON schema URL\"},\"name\":{\"type\":\"string\",\"description\":\"The human readable name of this service. Used for display, and as the basis for generating a unique key for URL.\"},\"apidoc\":{\"$ref\":\"#/definitions/apidoc\",\"description\":\"Optionally specify the specific version of API Builder for which your service is written. If not provided, we automatically default to the current production version.\"},\"info\":{\"$ref\":\"#/definitions/info\",\"description\":\"Optionally specify additional metadata about this service (e.g. contact info, license).\"},\"namespace\":{\"type\":\"string\",\"description\":\"Specifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically generate a namespace based on [organization namespace].[formatted service name].[major version number]. Note that by default API Builder includes the major version number in the package name which allows service authors and clients to interact with multiple versions of the service where changes have been made in a non backwards compatible way.\"},\"base_url\":{\"type\":\"string\",\"description\":\"The base URL where this service is hosted. Must start with http.\"},\"description\":{\"type\":\"string\",\"description\":\"optional description for what this service provides. Supports GFM.\"},\"imports\":{\"type\":\"array\",\"description\":\"JSON Array defining any other services whose schema definitions we would like to import into our service.\",\"items\":{\"$ref\":\"#/definitions/import\"}},\"headers\":{\"type\":\"array\",\"description\":\"JSON Array defining any HTTP Headers that the service understands or expects.\",\"items\":{\"$ref\":\"#/definitions/header\"}},\"enums\":{\"$ref\":\"#/definitions/enum\",\"description\":\"JSON object defining all of the enums in this API. The key of each object is the enum name.\"},\"interfaces\":{\"$ref\":\"#/definitions/interface\"},\"models\":{\"$ref\":\"#/definitions/model\",\"description\":\"JSON object defining all of the models in this API. The key of each object is the model name.\"},\"unions\":{\"$ref\":\"#/definitions/union\"},\"resources\":{\"$ref\":\"#/definitions/resource\",\"description\":\"JSON object defining all of the resources in this API. The key of each object is the name of a type that this resource represents. The type must be the name of a model or an enum.\"},\"attributes\":{\"type\":\"array\",\"description\":\"JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.\",\"items\":{\"$ref\":\"#/definitions/attribute\"}},\"annotations\":{\"$ref\":\"#/definitions/annotation\",\"description\":\"JSON object defining all of the annotations in this API. The key of each object is the annotation name.\"}},\"required\":[\"name\"],\"title\":\"API Builder Schema\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"API Builder Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"apidoc":{"title":"API documentation","type":"object","properties":{"version":{"type":"string","description":"Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec."}},"required":["version"],"additionalProperties":false},"info":{"title":"contact information","type":"object","properties":{"contact":{"$ref":"#/definitions/contact","description":"Specifies contact information for this service."},"license":{"$ref":"#/definitions/license","description":"Specifies the license under which this service is released."}},"additionalProperties":false},"contact":{"title":"contact information","type":"object","description":"Specifies contact information for this service","properties":{"name":{"type":"string","description":"Identifying name of the contact person/organization"},"url":{"type":"string","description":"URL pointing to the contact information"},"email":{"type":"string","description":"Email address of the contact person/organization"}},"additionalProperties":false},"license":{"title":"license","type":"object","description":"specifies the license under which this service is released","properties":{"name":{"type":"string","description":"Name of the license - e.g. MIT"},"url":{"type":"string","description":"URL of the license itself"}},"required":["name"],"additionalProperties":false},"import":{"title":"import","type":"object","properties":{"uri":{"type":"string","description":"The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the \"service.json\" link for a service."}},"required":["uri"],"additionalProperties":false},"header":{"title":"header","type":"object","properties":{"name":{"type":"string","description":"The name of the header."},"type":{"type":"string","description":"The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\"."},"required":{"type":"boolean","default":true,"description":"boolean: true|false. By default, all headers are considered required. To make a parameter optional, set \"required\" to false."},"default":{"description":"The default value for this header. If specified, generated clients will automatically include this header in all requests. Default values must be specified as strings."},"description":{"type":"string","description":"Optional description for what this header provides. Supports GFM."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this header for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["name","type"],"additionalProperties":false},"annotation":{"title":"annotation","type":"object","patternProperties":{"^[a-zA-Z0-9_]*$":{"title":"annotation","type":"object","description":"An annotation is just a short key that can be used to tag any field in any model of this API.","properties":{"description":{"type":"string","description":"Describes what the annotation is used for."},"deprecation":{"$ref":"#/definitions/deprecation"}},"additionalProperties":false}}},"attribute":{"title":"attribute","type":"object","properties":{"name":{"type":"string","description":"the name and identifier of the attribute."},"value":{"title":"json object","type":"object","description":"a JSON object that is usually utilized by a downstream Generator."},"description":{"type":"string"}},"required":["name","value"],"additionalProperties":false},"deprecation":{"title":"json object","type":"object","description":"JSON Object that indicates that this object is deprecated.","properties":{"description":{"type":"string","description":"Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM."}},"additionalProperties":false},"enum":{"title":"enumeration","type":"object","patternProperties":{"^[a-zA-Z0-9_]*$":{"title":"name","type":"object","description":"The name of the enum. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.","properties":{"plural":{"type":"string","description":"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural."},"description":{"type":"string","description":"Optional longer description for this enum."},"values":{"type":"array","description":"JSON Array of EnumValue objects. Each element defines a valid value and an optional description.","items":{"$ref":"#/definitions/enumvalues"}},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this enum for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["values"],"additionalProperties":false}}},"enumvalues":{"title":"evaluates","type":"object","properties":{"name":{"type":"string","description":"The name of the value. Names must start with a letter."},"value":{"type":"string","description":"The actual string representation of this value when serializing. If not specified, defaults to 'name'."},"description":{"type":"string","description":"Optional description for what this enum value provides. Supports GFM."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this enum value for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["name"],"additionalProperties":false},"interface":{"title":"interface","type":"object","patternProperties":{"^[a-zA-Z0-9_]*$":{"title":"name","type":"object","description":"Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, or models. Note you may define an interface and a union of the same name.","properties":{"plural":{"type":"string","description":"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural."},"description":{"type":"string","description":"Optional description for what this model provides. Supports GFM."},"fields":{"type":"array","description":"JSON Array of 0 or more Fields.","items":{"$ref":"#/definitions/field"}},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this model for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"additionalProperties":false}}},"field":{"title":"field","type":"object","properties":{"name":{"type":"string","description":"Specifies the name of the field. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.","pattern":"^[a-zA-Z0-9_]*$"},"type":{"type":"string","description":"Specifies the type of this field. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)."},"description":{"type":"string","description":"Optional description for what this field provides. Supports GFM."},"required":{"type":"boolean","default":true,"description":"By default, all fields are considered required. To make a field optional, set \"required\" to false. When a field is marked as required, it must be present in any form of a model for that form to be valid. In client-server scenario, this means that any defaults that are present in the model must be applied by the client. If you want a default to be applied by the receiver, you should mark the field as \"required\": false"},"default":{"description":"Optional default value. The value must be valid for the type specified for this field. For example, if you specify a field named 'limit' with type 'integer', an acceptable default would be 10."},"example":{"type":"string","description":"Optional - an example value for this field used only in the produced documentation"},"minimum":{"type":"integer","description":"Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element."},"maximum":{"type":"integer","description":"Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this field for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"},"annotations":{"type":"array","description":"JSON Array of type string where each value indicates the name of a declared annotation (optional),","items":{"type":"string"}}},"required":["name","type"],"additionalProperties":false},"model":{"title":"model","type":"object","description":"specifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.","patternProperties":{"^[a-zA-Z0-9_]*$":{"title":"model","type":"object","properties":{"description":{"type":"string","description":"Description for what this model provides."},"plural":{"type":"string","description":"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural."},"interfaces":{"type":"array","description":"JSON Array of type string where each value indicates the name of a declared interface","items":{"type":"string"}},"fields":{"type":"array","items":{"$ref":"#/definitions/field"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}}}},"additionalProperties":false},"union":{"title":"union","type":"object","patternProperties":{"^[a-zA-Z0-9_]*$":{"type":"object","description":"Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, unions, or models. Note you may define an interface and a union of the same name, but in this case it is required to list that interface in the interfaces field.","properties":{"plural":{"type":"string","description":"Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural."},"discriminator":{"type":"string","description":"Specifies an optional, but recommended, name for a type discriminator field which can then be used in serialization / deserialization to identify the type of object. For example, if not specified, a code generator may serialize the union type into a JSON structure of { \"type\" => object }. If a discriminator is provided, the same code generator can flatten the JSON representation to, for example: { \"discriminator\" => \"xxx\", \"field1\" => \"yyy\" }. If provided, the name of the discriminator field must be unique across all of the fields across all of the types of this union."},"description":{"type":"string","description":"Optional description for what this union provides. Supports GFM."},"interfaces":{"type":"array","description":"JSON Array of type string where each value indicates the name of a declared interface","items":{"type":"string"}},"types":{"type":"array","description":"Specifies the individual types that are part of this union type.","items":{"$ref":"#/definitions/uniontype"}},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this union for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["types"],"additionalProperties":false}},"additionalProperties":false},"uniontype":{"title":"union type","type":"object","properties":{"type":{"type":"string","description":"Specifies the type to include in this union type. Acceptable values include the name of either an enum, a model, or a (primitive type).\ndescription optional description for what this type provides. Supports GFM."},"description":{"type":"string"},"default":{"type":"boolean","description":"If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization."},"discriminator_value":{"type":"string","description":"The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this union type for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["type"],"additionalProperties":false},"resource":{"title":"resource","type":"object","patternProperties":{"^[a-zA-Z0-9_.]*$":{"title":"name","type":"object","description":"The name of the model or enum that this resource represents","properties":{"path":{"type":"string","description":"Optional path where this resource is located. If not provided, defaults to the plural of the typeName, with some assumptions of formatting for web (e.g. lower case, dash separated). Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that all operations for this path will require a parameter named 'guid' of type 'string'"},"description":{"type":"string","description":"Optional description for what this resource provides. Supports GFM."},"operations":{"type":"array","description":"One or more operations is required.","items":{"$ref":"#/definitions/operation"}},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this resource for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["operations"],"additionalProperties":false}},"additionalProperties":false},"operation":{"title":"operation","type":"object","description":"","properties":{"method":{"type":"string","description":"The HTTP method for this operation"},"path":{"type":"string","description":"Optional path for this particular operation. If not provided, defaults to no additional path. Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that this operation is available at /resource_path/:guid. Path parameter types are inferred by looking for a field with that name on the model associated with this resource. If not found, the datatype of any path parameter will be string."},"description":{"type":"string","description":"Optional description for what this operation provides. Supports GFM."},"body":{"$ref":"#/definitions/body","description":"Optional specification for the type of the body of this request. For all operations that support bodies (e.g. POST, PUT, PATCH), allows you to specify the type of the body."},"parameters":{"type":"array","description":"Optional JSON Array of the parameters to this method. By default, for GET methods, parameters are assumed to be in the path or in the query. For other methods, parameters are assumed to be in the path or form body, unless you have explicitly specified a body in which case parameters can be provided in the path or the query.","items":{"$ref":"#/definitions/parameter"}},"responses":{"$ref":"#/definitions/response","description":"Optional JSON Object of HTTP Response Code to Response. If not provided, an HTTP NoContent response is assumed. Only responses for HTTP status codes that are interesting should be documented."},"attributes":{"type":"array","description":"JSON array defining additional meta data about this operation for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["method"],"additionalProperties":false},"parameter":{"title":"parameter","type":"object","properties":{"name":{"type":"string","description":"The name of the parameter. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.","pattern":"^[a-zA-Z0-9_]*$"},"type":{"type":"string","description":"Specifies the type of this parameter. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)."},"location":{"type":"string","description":"One of: path, query, form, header. Defines the location of this parameter. Default location varies based on the context of the parameter (e.g. if the operation method is a POST, the default will be Form; if a GET, the default will be Query)"},"description":{"type":"string","description":"Optional description for what this parameter provides. Supports GFM."},"required":{"type":"boolean","default":true,"description":"By default all parameters are considered required. To make a parameter optional, set \"required\" to false."},"default":{"description":"Optional default value. The value must be valid for the type specified for this parameter. For example, if you specify a parameter named 'limit' with type 'integer', an acceptable default would be 10"},"example":{"type":"string","description":"Optional - an example value for this parameter used only in the produced documentation"},"minimum":{"type":"integer","description":"Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element."},"maximum":{"type":"integer","description":"Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element."},"attributes":{"type":"array","description":"JSON array defining additional meta data about this parameter for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["name","type"],"additionalProperties":false},"response":{"title":"response","type":"object","patternProperties":{"^[0-9]*$":{"title":"HTTP status","type":"object","description":"A valid HTTP status code for this response (e.g. 200). Only status codes that have interesting return types should be documented. You can also specify an HTTP status code of 'default' to map to all other non documented types. This is useful to capture a generic error type that would be returned for non documented response codes.\n\nThere are a few conventions enforced:\n- HTTP Response codes of 5xx cannot be explicitly specified and are handled automatically to ensure consistent behavior in generated client libraries.\n- HTTP Response codes of 204 and 304 indicate that no content is returned, so they must use a type of unit.","properties":{"type":{"type":"string","description":"Specifies the type of this response. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)."},"headers":{"type":"array","items":{"$ref":"#/definitions/header"}},"description":{"type":"string","description":"Optional description for what this response provides. Supports GFM."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["type"],"additionalProperties":false}},"additionalProperties":false},"body":{"title":"body","type":"object","properties":{"type":{"type":"string","description":"Specifies the type of this body. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with \"[]\". For example, to specify that the type is a collection of strings, use \"[string]\". To specify a Map, the type name can be prefixed with \"map[type]\". For example, to specify that the type is a Map of string to long, use \"map[long]\". Note that for map, the keys must be strings (per the JSON specification)."},"description":{"type":"string","description":"Optional description for what this body provides. Supports GFM."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this body for use by generators.","items":{"$ref":"#/definitions/attribute"}},"deprecation":{"$ref":"#/definitions/deprecation"}},"required":["type"],"additionalProperties":false}},"description":"JSON Schema for API Builder's api.json format from https://app.apibuilder.io/doc/apiJson","id":"https://json.schemastore.org/apibuilder.json","properties":{"$schema":{"type":"string","description":"A JSON schema URL"},"name":{"type":"string","description":"The human readable name of this service. Used for display, and as the basis for generating a unique key for URL."},"apidoc":{"$ref":"#/definitions/apidoc","description":"Optionally specify the specific version of API Builder for which your service is written. If not provided, we automatically default to the current production version."},"info":{"$ref":"#/definitions/info","description":"Optionally specify additional metadata about this service (e.g. contact info, license)."},"namespace":{"type":"string","description":"Specifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically generate a namespace based on [organization namespace].[formatted service name].[major version number]. Note that by default API Builder includes the major version number in the package name which allows service authors and clients to interact with multiple versions of the service where changes have been made in a non backwards compatible way."},"base_url":{"type":"string","description":"The base URL where this service is hosted. Must start with http."},"description":{"type":"string","description":"optional description for what this service provides. Supports GFM."},"imports":{"type":"array","description":"JSON Array defining any other services whose schema definitions we would like to import into our service.","items":{"$ref":"#/definitions/import"}},"headers":{"type":"array","description":"JSON Array defining any HTTP Headers that the service understands or expects.","items":{"$ref":"#/definitions/header"}},"enums":{"$ref":"#/definitions/enum","description":"JSON object defining all of the enums in this API. The key of each object is the enum name."},"interfaces":{"$ref":"#/definitions/interface"},"models":{"$ref":"#/definitions/model","description":"JSON object defining all of the models in this API. The key of each object is the model name."},"unions":{"$ref":"#/definitions/union"},"resources":{"$ref":"#/definitions/resource","description":"JSON object defining all of the resources in this API. The key of each object is the name of a type that this resource represents. The type must be the name of a model or an enum."},"attributes":{"type":"array","description":"JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.","items":{"$ref":"#/definitions/attribute"}},"annotations":{"$ref":"#/definitions/annotation","description":"JSON object defining all of the annotations in this API. The key of each object is the annotation name."}},"required":["name"],"title":"API Builder Schema"}
|
Provide a JSON object that satisfies the schema "API Builder Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
API Builder Schema
|
schema-store
|
schema_store_42
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/app-config.json\",\"title\":\"Application Configuration Schema\",\"type\":\"object\",\"description\":\"This is the schema describing the structure of the app-config.yaml configuration file.\",\"properties\":{\"app\":{\"type\":\"object\",\"description\":\"Generic frontend configuration.\",\"properties\":{\"baseUrl\":{\"type\":\"string\",\"description\":\"The public absolute root URL that the frontend.\"},\"title\":{\"type\":\"string\",\"description\":\"The title of the app, as shown in the Backstage web interface.\"},\"datadogRum\":{\"type\":\"object\",\"description\":\"Datadog RUM events configuration\",\"properties\":{\"env\":{\"type\":\"string\",\"description\":\"Environment for Datadog RUM events\"},\"clientToken\":{\"type\":\"string\",\"description\":\"clientToken for Datadog RUM events\"},\"applicationId\":{\"type\":\"string\",\"description\":\"applicationId for Datadog RUM events\"},\"site\":{\"type\":\"string\",\"description\":\"site for Datadog RUM events\"}}},\"listen\":{\"type\":\"object\",\"description\":\"Listening configuration for local development\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"The host that the frontend should be bound to. Only used for local development.\"},\"port\":{\"type\":\"number\",\"description\":\"The port that the frontend should be bound to. Only used for local development.\"}}},\"https\":{\"type\":\"object\",\"description\":\"Only used for local development. The https object is passed to webpack in order to enable using https on localhost.\",\"properties\":{\"certificate\":{\"type\":\"object\",\"description\":\"Parent object containing certificate and the private key\",\"properties\":{\"key\":{\"type\":\"string\",\"description\":\"Https Certificate private key. Use $file to load in a file\"},\"cert\":{\"type\":\"string\",\"description\":\"Https Certificate. Use $file to load in a file\"}}}}},\"support\":{\"description\":\"Information about support of this Backstage instance and how to contact the integrator team.\",\"type\":\"object\",\"properties\":{\"url\":{\"description\":\"The primary support url.\",\"type\":\"string\"},\"items\":{\"description\":\"A list of categorized support item groupings.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"title\":{\"description\":\"The title of the support item grouping.\",\"type\":\"string\"},\"icon\":{\"description\":\"An optional icon for the support item grouping.\",\"type\":\"string\"},\"links\":{\"description\":\"A list of support links for the Backstage instance inside this grouping.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"},\"title\":{\"type\":\"string\"}}}}}}}}},\"extensions\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"attachTo\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"input\":{\"type\":\"string\"}}},\"disabled\":{\"type\":\"boolean\"},\"config\":{}}},{\"type\":\"boolean\"}]}},{\"type\":\"string\"}]}},\"analytics\":{\"type\":\"object\",\"properties\":{\"ga\":{\"type\":\"object\",\"properties\":{\"trackingId\":{\"description\":\"Google Analytics tracking ID, e.g. UA-000000-0\",\"type\":\"string\"},\"scriptSrc\":{\"description\":\"URL to Google Analytics analytics.js script\\nDefaults to fetching from GA source (eg. https://www.google-analytics.com/analytics.js)\",\"type\":\"string\"},\"identity\":{\"description\":\"Controls how the identityApi is used when sending data to GA:\\n\\n- `disabled`: (Default) Explicitly prevents a user's identity from\\n being used when capturing events in GA.\\n- `optional`: Pageviews and hits are forwarded to GA as they happen\\n and only include user identity metadata once known. Guarantees\\n that hits are captured for all sessions, even if no sign in\\n occurs, but may result in dropped hits in User ID views.\\n- `required`: All pageviews and hits are deferred until an identity\\n is known. Guarantees that all data sent to GA correlates to a user\\n identity, but prevents GA from receiving events for sessions in\\n which a user does not sign in. An `identityApi` instance must be\\n passed during instantiation when set to this value.\",\"enum\":[\"disabled\",\"optional\",\"required\"],\"type\":\"string\"},\"virtualSearchPageView\":{\"description\":\"Controls whether to send virtual pageviews on `search` events.\\nCan be used to enable Site Search in GA.\",\"type\":\"object\",\"properties\":{\"mode\":{\"description\":\"- `disabled`: (Default) no virtual pageviews are sent\\n- `only`: Sends virtual pageview _instead_ of the `search` event\\n- `both`: Sends both the `search` event _and_ the virtual pageview\",\"enum\":[\"both\",\"disabled\",\"only\"],\"type\":\"string\"},\"mountPath\":{\"description\":\"Specifies on which path the main Search page is mounted.\\nDefaults to `/search`.\",\"type\":\"string\"},\"searchQuery\":{\"description\":\"Specifies which query param is used for the term query in the virtual pageview URL.\\nDefaults to `query`.\",\"type\":\"string\"},\"categoryQuery\":{\"description\":\"Specifies which query param is used for the category query in the virtual pageview URL.\\nSkipped by default.\",\"type\":\"string\"}}},\"debug\":{\"description\":\"Whether or not to log analytics debug statements to the console.\\nDefaults to false.\",\"type\":\"boolean\"},\"testMode\":{\"description\":\"Prevents events from actually being sent when set to true. Defaults\\nto false.\",\"type\":\"boolean\"},\"customDimensionsMetrics\":{\"description\":\"Configuration informing how Analytics Context and Event Attributes\\nmetadata will be captured in Google Analytics.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Specifies whether the corresponding metadata should be collected\\nas a Google Analytics custom dimension or custom metric.\",\"enum\":[\"dimension\",\"metric\"],\"type\":\"string\"},\"index\":{\"description\":\"The index of the Google Analytics custom dimension or metric that\\nthe metadata should be written to.\",\"type\":\"number\"},\"source\":{\"description\":\"Specifies whether the desired value lives as an attribute on the\\nAnalytics Context or the Event's Attributes.\",\"enum\":[\"attributes\",\"context\"],\"type\":\"string\"},\"key\":{\"description\":\"The property of the context or attributes that should be captured.\\ne.g. to capture the Plugin ID associated with an event, the source\\nshould be set to \\\"context\\\" and the key should be set to pluginId.\",\"type\":\"string\"}}}}}},\"ga4\":{\"type\":\"object\",\"properties\":{\"measurementId\":{\"description\":\"Google Analytics measurement ID, e.g. G-000000-0\",\"type\":\"string\"},\"identity\":{\"description\":\"Controls how the identityApi is used when sending data to GA:\\n\\n- `disabled`: (Default) Explicitly prevents a user's identity from\\n being used when capturing events in GA.\\n- `optional`: Pageviews and hits are forwarded to GA as they happen\\n and only include user identity metadata once known. Guarantees\\n that hits are captured for all sessions, even if no sign in\\n occurs, but may result in dropped hits in User ID views.\\n- `required`: All pageviews and hits are deferred until an identity\\n is known. Guarantees that all data sent to GA correlates to a user\\n identity, but prevents GA from receiving events for sessions in\\n which a user does not sign in. An `identityApi` instance must be\\n passed during instantiation when set to this value.\",\"enum\":[\"disabled\",\"optional\",\"required\"],\"type\":\"string\"},\"debug\":{\"description\":\"Whether to log analytics debug statements to the console.\\nDefaults to false.\",\"type\":\"boolean\"},\"testMode\":{\"description\":\"Prevents events from actually being sent when set to true. Defaults\\nto false.\",\"type\":\"boolean\"},\"contentGrouping\":{\"description\":\"Content grouping definition\\nFeature available in Google Analytics 4\\nMore information https://support.google.com/analytics/answer/11523339?hl=en\\nData can be grouped by pluginId, routeRef\\nTakes 24 hours before metrics shows up in GA dashboard\\nSpecifies the dimension to be used for content grouping\\nCan be one of pluginId, extension or routeRef\",\"enum\":[\"extension\",\"pluginId\",\"routeRef\"],\"type\":\"string\"},\"allowedContexts\":{\"description\":\"Configuration informing how Analytics Context and Event Attributes\\nmetadata will be captured in Google Analytics.\\nContexts that will be sent as parameters in the event.\\ncontext-name will be prefixed by c_, for example, pluginId will be c_pluginId in the event.\",\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":[{\"type\":\"string\",\"enum\":[\"*\"]}],\"minItems\":1,\"maxItems\":1}]},\"allowedAttributes\":{\"description\":\"Attributes that will be sent as parameters in the event\\nattribute-name will be prefixed by a_, for example , testAttribute will be c_testAttribute in the event.\",\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"array\",\"items\":[{\"type\":\"string\",\"enum\":[\"*\"]}],\"minItems\":1,\"maxItems\":1}]}}},\"newRelic\":{\"type\":\"object\",\"properties\":{\"endpoint\":{\"description\":\"Data ingestion endpoint to use, either bam.eu01.nr-data.net (EU) or bam.nr-data.net (US)\",\"enum\":[\"bam.eu01.nr-data.net\",\"bam.nr-data.net\"],\"type\":\"string\"},\"accountId\":{\"description\":\"New Relic Account ID, e.g. 1234567\",\"type\":\"string\"},\"applicationId\":{\"description\":\"New Relic Application ID, e.g. 987654321\",\"type\":\"string\"},\"licenseKey\":{\"description\":\"New Relic License Key, e.g. NRJS-12a3456bc78de9123f4\",\"type\":\"string\"},\"distributedTracingEnabled\":{\"description\":\"Whether to enabled distributed tracing, defaults to false\",\"type\":\"boolean\"},\"cookiesEnabled\":{\"description\":\"Whether to enabled tracing of cookies, defaults to false\",\"type\":\"boolean\"}}}}},\"packageName\":{\"description\":\"The name of the app package (in most Backstage repositories, this is the\\n\\\"name\\\" field in `packages/app/package.json`) that content should be served\\nfrom. The same app package should be added as a dependency to the backend\\npackage in order for it to be accessible at runtime.\\n\\nIn a typical setup with a single app package, this will default to 'app'.\",\"type\":\"string\"},\"disableConfigInjection\":{\"description\":\"Disables the configuration injection. This can be useful if you're running in an environment\\nwith a read-only filesystem, or for some other reason don't want configuration to be injected.\\n\\nNote that this will cause the configuration used when building the app bundle to be used, unless\\na separate configuration loading strategy is set up.\\n\\nThis also disables configuration injection though `APP_CONFIG_` environment variables.\",\"type\":\"boolean\"},\"disableStaticFallbackCache\":{\"description\":\"By default the app backend plugin will cache previously deployed static assets in the database.\\nIf you disable this, it is recommended to set a `staticFallbackHandler` instead.\",\"type\":\"boolean\"}}},\"allure\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"type\":\"string\"}}},\"firehydrant\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"type\":\"string\"}}},\"lighthouse\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"type\":\"string\"}}},\"nomad\":{\"type\":\"object\",\"properties\":{\"addr\":{\"type\":\"string\",\"description\":\"The address of the Nomad API. See: https://developer.hashicorp.com/nomad/api-docs#addressing-and-ports\"},\"token\":{\"type\":\"string\",\"description\":\"The token to call the Nomad API with. See: https://developer.hashicorp.com/nomad/api-docs#authentication\"}}},\"auth\":{\"type\":\"object\",\"description\":\"Configuration that provides information on available configured authentication providers.\",\"properties\":{\"providers\":{\"type\":\"object\",\"description\":\"The available auth-provider options and attributes\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":true},\"properties\":{\"google\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"}}}},\"github\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"},\"enterpriseInstanceUrl\":{\"type\":\"string\"}}}},\"saml\":{\"type\":\"object\",\"properties\":{\"entryPoint\":{\"type\":\"string\"},\"logoutUrl\":{\"type\":\"string\"},\"issuer\":{\"type\":\"string\"},\"cert\":{\"type\":\"string\"},\"audience\":{\"type\":\"string\"},\"privateKey\":{\"type\":\"string\"},\"authnContext\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"identifierFormat\":{\"type\":\"string\"},\"decryptionPvk\":{\"type\":\"string\"},\"signatureAlgorithm\":{\"enum\":[\"sha256\",\"sha512\"],\"type\":\"string\"},\"digestAlgorithm\":{\"type\":\"string\"},\"acceptedClockSkewMs\":{\"type\":\"number\"}}},\"okta\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"audience\":{\"type\":\"string\"},\"authServerId\":{\"type\":\"string\"},\"idp\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"}}}},\"oauth2\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"authorizationUrl\":{\"type\":\"string\"},\"tokenUrl\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\"},\"disableRefresh\":{\"type\":\"boolean\"},\"includeBasicAuth\":{\"type\":\"boolean\"}}}},\"oidc\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"},\"metadataUrl\":{\"type\":\"string\"},\"tokenEndpointAuthMethod\":{\"type\":\"string\"},\"tokenSignedResponseAlg\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\"},\"prompt\":{\"type\":\"string\"}}}},\"auth0\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"domain\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"},\"audience\":{\"type\":\"string\"},\"connection\":{\"type\":\"string\"},\"connectionScope\":{\"type\":\"string\"}}}},\"microsoft\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"tenantId\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"}}}},\"onelogin\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"issuer\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"}}}},\"awsalb\":{\"type\":\"object\",\"properties\":{\"iss\":{\"type\":\"string\"},\"region\":{\"type\":\"string\"}}},\"cfaccess\":{\"type\":\"object\",\"properties\":{\"teamName\":{\"type\":\"string\"}}},\"gcpIap\":{\"description\":\"Configuration for the Google Cloud Platform Identity-Aware Proxy (IAP) auth provider.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"audience\":{\"description\":\"The audience to use when validating incoming JWT tokens.\\nSee https://backstage.io/docs/auth/google/gcp-iap-auth\",\"type\":\"string\"},\"jwtHeader\":{\"description\":\"The name of the header to read the JWT token from, defaults to `'x-goog-iap-jwt-assertion'`.\",\"type\":\"string\"}}}},\"gitlab\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"audience\":{\"type\":\"string\"},\"callbackUrl\":{\"type\":\"string\"}}}}}},\"environment\":{\"description\":\"The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.\\ndefault value: 'development'\\noptional values: 'development' | 'production'\",\"type\":\"string\"},\"session\":{\"type\":\"object\",\"properties\":{\"secret\":{\"description\":\"The secret attribute of session object.\",\"type\":\"string\"}}},\"identityTokenAlgorithm\":{\"description\":\"JWS \\\"alg\\\" (Algorithm) Header Parameter value. Defaults to ES256.\\nMust match one of the algorithms defined for IdentityClient.\\nWhen setting a different algorithm, check if the `key` field\\nof the `signing_keys` table can fit the length of the generated keys.\\nIf not, add a knex migration file in the migrations folder.\\nMore info on supported algorithms: https://github.com/panva/jose\",\"type\":\"string\"},\"keyStore\":{\"description\":\"To control how to store JWK data in auth-backend\",\"type\":\"object\",\"properties\":{\"provider\":{\"enum\":[\"database\",\"firestore\",\"memory\"],\"type\":\"string\"},\"firestore\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The host to connect to\",\"type\":\"string\"},\"port\":{\"description\":\"The port to connect to\",\"type\":\"number\"},\"ssl\":{\"description\":\"Whether to use SSL when connecting.\",\"type\":\"boolean\"},\"projectId\":{\"description\":\"The Google Cloud Project ID\",\"type\":\"string\"},\"keyFilename\":{\"description\":\"Local file containing the Service Account credentials.\\nYou can omit this value to automatically read from\\nGOOGLE_APPLICATION_CREDENTIALS env which is useful for local\\ndevelopment.\",\"type\":\"string\"},\"path\":{\"description\":\"The path to use for the collection. Defaults to 'sessions'\",\"type\":\"string\"},\"timeout\":{\"description\":\"Timeout used for database operations. Defaults to 10000ms\",\"type\":\"number\"}}}}}}},\"backend\":{\"type\":\"object\",\"description\":\"Generic backend configuration.\",\"properties\":{\"auth\":{\"description\":\"Backend configuration for when request authentication is enabled\",\"type\":\"object\",\"properties\":{\"keys\":{\"description\":\"Keys shared by all backends for signing and validating backend tokens.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"secret\":{\"description\":\"Secret for generating tokens. Should be a base64 string, recommended\\nlength is 24 bytes.\",\"type\":\"string\"}}}}}},\"baseUrl\":{\"type\":\"string\",\"description\":\"The public absolute root URL that the backend is reachable at, from the browser's perspective.\"},\"listen\":{\"description\":\"Address that the backend should listen to.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"Address of the interface that the backend should bind to.\",\"type\":\"string\"},\"port\":{\"description\":\"Port that the backend should listen to.\",\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\"}]}}},{\"type\":\"string\"}]},\"https\":{\"description\":\"HTTPS configuration for the backend. If omitted the backend will serve HTTP.\\n\\nSetting this to `true` will cause self-signed certificates to be generated, which\\ncan be useful for local development or other non-production scenarios.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"certificate\":{\"description\":\"Certificate configuration\",\"type\":\"object\",\"properties\":{\"cert\":{\"description\":\"PEM encoded certificate. Use $file to load in a file\",\"type\":\"string\"},\"key\":{\"description\":\"PEM encoded certificate key. Use $file to load in a file.\",\"type\":\"string\"}}}}},{\"enum\":[true],\"type\":\"boolean\"}]},\"database\":{\"description\":\"Database connection configuration, select base database type using the `client` field\",\"type\":\"object\",\"properties\":{\"client\":{\"description\":\"Default database client to use\",\"enum\":[\"better-sqlite3\",\"pg\",\"sqlite3\"],\"type\":\"string\"},\"connection\":{\"description\":\"Base database connection string, or object with individual connection properties\",\"anyOf\":[{\"type\":\"object\",\"additionalProperties\":{},\"properties\":{\"password\":{\"description\":\"Password that belongs to the client User\",\"type\":\"string\"}}},{\"type\":\"string\"}]},\"prefix\":{\"description\":\"Database name prefix override\",\"type\":\"string\"},\"ensureExists\":{\"description\":\"Whether to ensure the given database exists by creating it if it does not.\\nDefaults to true if unspecified.\",\"type\":\"boolean\"},\"pluginDivisionMode\":{\"description\":\"How plugins databases are managed/divided in the provided database instance.\\n\\n`database` -> Plugins are each given their own database to manage their schemas/tables.\\n\\n`schema` -> Plugins will be given their own schema (in the specified/default database)\\n to manage their tables.\\n\\nNOTE: Currently only supported by the `pg` client.\",\"default\":\"database\",\"enum\":[\"database\",\"schema\"],\"type\":\"string\"},\"role\":{\"description\":\"Configures the ownership of newly created schemas in pg databases.\",\"type\":\"string\"},\"knexConfig\":{\"description\":\"Arbitrary config object to pass to knex when initializing\\n(https://knexjs.org/#Installation-client). Most notable is the debug\\nand asyncStackTraces booleans\",\"type\":\"object\",\"additionalProperties\":true},\"plugin\":{\"description\":\"Plugin specific database configuration and client override\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"client\":{\"description\":\"Database client override\",\"enum\":[\"better-sqlite3\",\"pg\",\"sqlite3\"],\"type\":\"string\"},\"connection\":{\"description\":\"Database connection string or Knex object override\",\"anyOf\":[{\"type\":\"object\",\"properties\":{},\"additionalProperties\":true},{\"type\":\"string\"}]},\"ensureExists\":{\"description\":\"Whether to ensure the given database exists by creating it if it does not.\\nDefaults to base config if unspecified.\",\"type\":\"boolean\"},\"knexConfig\":{\"description\":\"Arbitrary config object to pass to knex when initializing\\n(https://knexjs.org/#Installation-client). Most notable is the\\ndebug and asyncStackTraces booleans.\\n\\nThis is merged recursively into the base knexConfig\",\"type\":\"object\",\"additionalProperties\":true},\"role\":{\"description\":\"Configures the ownership of newly created schemas in pg databases.\",\"type\":\"string\"}}}}}},\"cache\":{\"description\":\"Cache connection configuration, select cache type using the `store` field\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"store\":{\"type\":\"string\",\"enum\":[\"memory\"]}}},{\"type\":\"object\",\"properties\":{\"store\":{\"type\":\"string\",\"enum\":[\"redis\"]},\"connection\":{\"description\":\"A redis connection string in the form `redis://user:pass@host:port`.\",\"type\":\"string\"}}},{\"type\":\"object\",\"properties\":{\"store\":{\"type\":\"string\",\"enum\":[\"memcache\"]},\"connection\":{\"description\":\"A memcache connection string in the form `user:pass@host:port`.\",\"type\":\"string\"}}}]},\"cors\":{\"type\":\"object\",\"properties\":{\"origin\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"methods\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"allowedHeaders\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"exposedHeaders\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"credentials\":{\"type\":\"boolean\"},\"maxAge\":{\"type\":\"number\"},\"preflightContinue\":{\"type\":\"boolean\"},\"optionsSuccessStatus\":{\"type\":\"number\"}}},\"reading\":{\"description\":\"Configuration related to URL reading, used for example for reading catalog info\\nfiles, scaffolder templates, and techdocs content.\",\"type\":\"object\",\"properties\":{\"allow\":{\"description\":\"A list of targets to allow outgoing requests to. Users will be able to make\\nrequests on behalf of the backend to the targets that are allowed by this list.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"A host to allow outgoing requests to, being either a full host or\\na subdomain wildcard pattern with a leading `*`. For example `example.com`\\nand `*.example.com` are valid values, `prod.*.example.com` is not.\\nThe host may also contain a port, for example `example.com:8080`.\",\"type\":\"string\"},\"paths\":{\"description\":\"An optional list of paths. In case they are present only targets matching\\nany of them will are allowed. You can use trailing slashes to make sure only\\nsubdirectories are allowed, for example `/mydir/` will allow targets with\\npaths like `/mydir/a` but will block paths like `/mydir2`.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}},\"csp\":{\"description\":\"Content Security Policy options.\\n\\nThe keys are the plain policy ID, e.g. \\\"upgrade-insecure-requests\\\". The\\nvalues are on the format that the helmet library expects them, as an\\narray of strings. There is also the special value false, which means to\\nremove the default value that Backstage puts in place for that policy.\",\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"enum\":[false],\"type\":\"boolean\"}]}}}},\"discovery\":{\"description\":\"Discovery options.\",\"type\":\"object\",\"properties\":{\"endpoints\":{\"description\":\"Endpoints\\n\\nA list of target baseUrls and the associated plugins.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"The target baseUrl to use for the plugin\\n\\nCan be either a string or an object with internal and external keys.\\nTargets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"external\":{\"type\":\"string\"},\"internal\":{\"type\":\"string\"}}},{\"type\":\"string\"}]},\"plugins\":{\"description\":\"Array of plugins which use the target baseUrl.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}},\"organization\":{\"description\":\"Configuration that provides information about the organization that the app is for.\",\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The name of the organization that the app belongs to.\",\"type\":\"string\"}}},\"homepage\":{\"description\":\"This config was used by the HomepageTimer but has been replaced by the HeaderWorldClock in the home plugin\",\"deprecated\":\"in favor of the HeaderWorldClock which is found in the home plugin\",\"type\":\"object\",\"properties\":{\"clocks\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"timezone\":{\"type\":\"string\"}}}}}},\"enableExperimentalRedirectFlow\":{\"description\":\"Enable redirect authentication flow type, instead of a popup for authentication.\",\"type\":\"boolean\"},\"integrations\":{\"description\":\"Configuration for integrations towards various external repository provider systems\",\"type\":\"object\",\"properties\":{\"azure\":{\"description\":\"Integration configuration for Azure\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given Azure instance\",\"type\":\"string\"},\"token\":{\"description\":\"Token used to authenticate requests.\",\"deprecated\":\"Use `credentials` instead.\",\"type\":\"string\"},\"credential\":{\"description\":\"The credential to use for requests.\\n\\nIf no credential is specified anonymous access is used.\",\"deprecated\":\"Use `credentials` instead.\",\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"tenantId\":{\"type\":\"string\"},\"personalAccessToken\":{\"type\":\"string\"}}},\"credentials\":{\"description\":\"The credentials to use for requests. If multiple credentials are specified the first one that matches the organization is used.\\nIf not organization matches the first credential without an organization is used.\\n\\nIf no credentials are specified at all, either a default credential (for Azure DevOps) or anonymous access (for Azure DevOps Server) is used.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"clientId\":{\"type\":\"string\"},\"clientSecret\":{\"type\":\"string\"},\"tenantId\":{\"type\":\"string\"},\"personalAccessToken\":{\"type\":\"string\"}}}}}}},\"bitbucket\":{\"description\":\"Integration configuration for Bitbucket\",\"deprecated\":\"replaced by bitbucketCloud and bitbucketServer\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given Bitbucket instance\",\"type\":\"string\"},\"token\":{\"description\":\"Token used to authenticate requests.\",\"type\":\"string\"},\"apiBaseUrl\":{\"description\":\"The base url for the Bitbucket API, for example https://api.bitbucket.org/2.0\",\"type\":\"string\"},\"username\":{\"description\":\"The username to use for authenticated requests.\",\"type\":\"string\"},\"appPassword\":{\"description\":\"Bitbucket app password used to authenticate requests.\",\"type\":\"string\"}}}},\"bitbucketCloud\":{\"description\":\"Integration configuration for Bitbucket Cloud\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"username\":{\"description\":\"The username to use for authenticated requests.\",\"type\":\"string\"},\"appPassword\":{\"description\":\"Bitbucket Cloud app password used to authenticate requests.\",\"type\":\"string\"}}}},\"bitbucketServer\":{\"description\":\"Integration configuration for Bitbucket Server\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given Bitbucket Server instance\",\"type\":\"string\"},\"token\":{\"description\":\"Token used to authenticate requests.\",\"type\":\"string\"},\"username\":{\"description\":\"Username used to authenticate requests with Basic Auth.\",\"type\":\"string\"},\"password\":{\"description\":\"Password (or token as password) used to authenticate requests with Basic Auth.\",\"type\":\"string\"},\"apiBaseUrl\":{\"description\":\"The base url for the Bitbucket Server API, for example https://<host>/rest/api/1.0\",\"type\":\"string\"}}}},\"gerrit\":{\"description\":\"Integration configuration for Gerrit\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given Gerrit instance\",\"type\":\"string\"},\"baseUrl\":{\"description\":\"The base url for the Gerrit instance.\",\"type\":\"string\"},\"cloneUrl\":{\"description\":\"The base url for cloning repos.\",\"type\":\"string\"},\"username\":{\"description\":\"The username to use for authenticated requests.\",\"type\":\"string\"},\"password\":{\"description\":\"Gerrit password used to authenticate requests. This can be either a password\\nor a generated access token.\",\"type\":\"string\"}}}},\"github\":{\"description\":\"Integration configuration for GitHub\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given GitHub instance\",\"type\":\"string\"},\"token\":{\"description\":\"Token used to authenticate requests.\",\"type\":\"string\"},\"apiBaseUrl\":{\"description\":\"The base url for the GitHub API, for example https://api.github.com\",\"type\":\"string\"},\"rawBaseUrl\":{\"description\":\"The base url for GitHub raw resources, for example https://raw.githubusercontent.com\",\"type\":\"string\"},\"apps\":{\"description\":\"GitHub Apps configuration\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"appId\":{\"description\":\"The numeric GitHub App ID, string for environment variables\",\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\"}]},\"privateKey\":{\"description\":\"The private key to use for auth against the app\",\"type\":\"string\"},\"webhookSecret\":{\"description\":\"The secret used for webhooks\",\"type\":\"string\"},\"clientId\":{\"description\":\"The client ID to use\",\"type\":\"string\"},\"clientSecret\":{\"description\":\"The client secret to use\",\"type\":\"string\"},\"allowedInstallationOwners\":{\"description\":\"List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations.\\nHowever you can list the installations with the GitHub API. You can find the list of installations here:\\nhttps://api.github.com/app/installations\\nThe relevant documentation for this is here.\\nhttps://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}},\"gitlab\":{\"description\":\"Integration configuration for GitLab\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The host of the target that this matches on, e.g. \\\"gitlab.com\\\".\",\"type\":\"string\"},\"apiBaseUrl\":{\"description\":\"The base URL of the API of this provider, e.g.\\n\\\"https://gitlab.com/api/v4\\\", with no trailing slash.\\n\\nMay be omitted specifically for public GitLab; then it will be deduced.\",\"type\":\"string\"},\"token\":{\"description\":\"The authorization token to use for requests to this provider.\\n\\nIf no token is specified, anonymous access is used.\",\"type\":\"string\"},\"baseUrl\":{\"description\":\"The baseUrl of this provider, e.g. \\\"https://gitlab.com\\\", which is\\npassed into the GitLab client.\\n\\nIf no baseUrl is provided, it will default to https://${host}.\",\"type\":\"string\"}}}},\"googleGcs\":{\"description\":\"Integration configuration for Google Cloud Storage\",\"type\":\"object\",\"properties\":{\"clientEmail\":{\"description\":\"Service account email used to authenticate requests.\",\"type\":\"string\"},\"privateKey\":{\"description\":\"Service account private key used to authenticate requests.\",\"type\":\"string\"}}},\"awsS3\":{\"description\":\"Integration configuration for AWS S3 Service\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"endpoint\":{\"description\":\"AWS Endpoint.\\nThe endpoint URI to send requests to. The default endpoint is built from the configured region.\",\"type\":\"string\"},\"s3ForcePathStyle\":{\"description\":\"Whether to use path style URLs when communicating with S3.\\nDefaults to false.\\nThis allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.\",\"type\":\"boolean\"},\"accessKeyId\":{\"description\":\"Account access key used to authenticate requests.\",\"type\":\"string\"},\"secretAccessKey\":{\"description\":\"Account secret key used to authenticate requests.\",\"type\":\"string\"},\"roleArn\":{\"description\":\"ARN of the role to be assumed\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID to use when assuming role\",\"type\":\"string\"}}}},\"gitea\":{\"description\":\"Integration configuration for Gitea\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given Gitea instance\",\"type\":\"string\"},\"baseUrl\":{\"description\":\"The base url for the Gitea instance.\",\"type\":\"string\"},\"username\":{\"description\":\"The username to use for authenticated requests.\",\"type\":\"string\"},\"password\":{\"description\":\"Gitea password used to authenticate requests. This can be either a password\\nor a generated access token.\",\"type\":\"string\"}}}}}},\"aws\":{\"description\":\"Configuration for access to AWS accounts\",\"type\":\"object\",\"properties\":{\"accountDefaults\":{\"description\":\"Defaults for retrieving AWS account credentials\",\"type\":\"object\",\"properties\":{\"roleName\":{\"description\":\"The IAM role to assume to retrieve temporary AWS credentials\",\"type\":\"string\"},\"partition\":{\"description\":\"The AWS partition of the IAM role, e.g. \\\"aws\\\", \\\"aws-cn\\\"\",\"type\":\"string\"},\"region\":{\"description\":\"The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \\\"ap-northeast-1\\\"\",\"type\":\"string\"},\"externalId\":{\"description\":\"The unique identifier needed to assume the role to retrieve temporary AWS credentials\",\"type\":\"string\"}}},\"mainAccount\":{\"description\":\"Main account to use for retrieving AWS account credentials\",\"type\":\"object\",\"properties\":{\"accessKeyId\":{\"description\":\"The access key ID for a set of static AWS credentials\",\"type\":\"string\"},\"secretAccessKey\":{\"description\":\"The secret access key for a set of static AWS credentials\",\"type\":\"string\"},\"profile\":{\"description\":\"The configuration profile from a credentials file at ~/.aws/credentials and\\na configuration file at ~/.aws/config.\",\"type\":\"string\"},\"region\":{\"description\":\"The STS regional endpoint to use for the main account, e.g. \\\"ap-northeast-1\\\"\",\"type\":\"string\"}}},\"accounts\":{\"description\":\"Configuration for retrieving AWS accounts credentials\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"accountId\":{\"description\":\"The account ID of the target account that this matches on, e.g. \\\"123456789012\\\"\",\"type\":\"string\"},\"accessKeyId\":{\"description\":\"The access key ID for a set of static AWS credentials\",\"type\":\"string\"},\"secretAccessKey\":{\"description\":\"The secret access key for a set of static AWS credentials\",\"type\":\"string\"},\"profile\":{\"description\":\"The configuration profile from a credentials file at ~/.aws/credentials and\\na configuration file at ~/.aws/config.\",\"type\":\"string\"},\"roleName\":{\"description\":\"The IAM role to assume to retrieve temporary AWS credentials\",\"type\":\"string\"},\"partition\":{\"description\":\"The AWS partition of the IAM role, e.g. \\\"aws\\\", \\\"aws-cn\\\"\",\"type\":\"string\"},\"region\":{\"description\":\"The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \\\"ap-northeast-1\\\"\",\"type\":\"string\"},\"externalId\":{\"description\":\"The unique identifier needed to assume the role to retrieve temporary AWS credentials\",\"type\":\"string\"}}}}}},\"airbrake\":{\"description\":\"Configuration options for the Airbrake plugin\",\"type\":\"object\",\"properties\":{\"apiKey\":{\"description\":\"The API Key to authenticate requests. More details on how to get this\\nhere: https://airbrake.io/docs/api/#authentication\",\"type\":\"string\"}}},\"apacheAirflow\":{\"description\":\"Configurations for the Apache Airflow plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base url of the Apache Airflow installation.\",\"type\":\"string\"}}},\"azureDevOps\":{\"description\":\"Configuration options for the azure-devops-backend plugin\",\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"The hostname of the given Azure instance\",\"type\":\"string\"},\"token\":{\"description\":\"Token used to authenticate requests.\",\"type\":\"string\"},\"organization\":{\"description\":\"The organization of the given Azure instance\",\"type\":\"string\"}}},\"catalog\":{\"description\":\"Configuration options for the catalog plugin.\",\"type\":\"object\",\"properties\":{\"rules\":{\"description\":\"Rules to apply to all catalog entities, from any location.\\n\\nAn undefined list of matchers means match all, an empty list of\\nmatchers means match none.\\n\\nThis is commonly used to put in what amounts to an allowlist of kinds\\nthat regular users of Backstage are permitted to register locations\\nfor. This can be used to stop them from registering yaml files\\ndescribing for example a Group entity called \\\"admin\\\" that they make\\nthemselves members of, or similar.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"allow\":{\"description\":\"Allow entities of these particular kinds.\\n\\nE.g. [\\\"Component\\\", \\\"API\\\", \\\"Template\\\", \\\"Location\\\"]\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"locations\":{\"description\":\"Limit this rule to a specific location\\n\\nExample with a fixed location\\n { \\\"type\\\": \\\"url\\\", \\\"exact\\\": \\\"https://github.com/a/b/blob/file.yaml\\\"}\\n\\nExample using a Regex\\n { \\\"type\\\": \\\"url\\\", \\\"pattern\\\": \\\"https://github.com/org/*\\\\/blob/master/*.yaml\\\"}\\n\\nUsing both exact and pattern will result in an error starting the application\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"The type of location, e.g. \\\"url\\\".\",\"type\":\"string\"},\"exact\":{\"description\":\"The exact location, e.g.\\n\\\"https://github.com/org/repo/blob/master/users.yaml\\\".\\n\\nThe exact location can also be used to match on locations\\nthat contain glob characters themselves, e.g.\\n\\\"https://github.com/org/*\\\\/blob/master/*.yaml\\\".\",\"type\":\"string\"},\"pattern\":{\"description\":\"The pattern allowed for the location, e.g.\\n\\\"https://github.com/org/*\\\\/blob/master/*.yaml\\\".\",\"type\":\"string\"}}}}}}},\"readonly\":{\"description\":\"Readonly defines whether the catalog allows writes after startup.\\n\\nSetting 'readonly=false' allows users to register their own components.\\nThis is the default value.\\n\\nSetting 'readonly=true' configures catalog to only allow reads. This can\\nbe used in combination with static locations to only serve operator\\nprovided locations. Effectively this removes the ability to register new\\ncomponents to a running backstage instance.\",\"type\":\"boolean\"},\"locations\":{\"description\":\"A set of static locations that the catalog shall always keep itself\\nup-to-date with. This is commonly used for large, permanent integrations\\nthat are defined by the Backstage operators at an organization, rather\\nthan individual things that users register dynamically.\\n\\nThese have (optional) rules of their own. These override what the global\\nrules above specify. This way, you can prevent everybody from register\\ne.g. User and Group entities, except for one or a few static locations\\nthat have those two kinds explicitly allowed.\\n\\nFor example:\\n\\n```yaml\\nrules:\\n - allow: [Component, API, Template, Location]\\nlocations:\\n - type: url\\n target: https://github.com/org/repo/blob/master/users.yaml\\n rules:\\n - allow: [User, Group]\\n - type: url\\n target: https://github.com/org/repo/blob/master/systems.yaml\\n rules:\\n - allow: [System]\\n```\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"The type of location, e.g. \\\"url\\\".\",\"type\":\"string\"},\"target\":{\"description\":\"The target URL of the location, e.g.\\n\\\"https://github.com/org/repo/blob/master/users.yaml\\\".\",\"type\":\"string\"},\"rules\":{\"description\":\"Optional extra rules that apply to this particular location.\\n\\nThese override the global rules above.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"allow\":{\"description\":\"Allow entities of these particular kinds.\\n\\nE.g. [\\\"Group\\\", \\\"User\\\"]\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}},\"orphanStrategy\":{\"description\":\"The strategy to use for entities that are orphaned, i.e. no longer have\\nany other entities or providers referencing them. The default value is\\n\\\"keep\\\".\",\"enum\":[\"delete\",\"keep\"],\"type\":\"string\"},\"processingInterval\":{\"description\":\"The interval at which the catalog should process its entities.\"},\"processors\":{\"type\":\"object\",\"description\":\"List of processor-specific options and attributes\",\"properties\":{\"awsOrganization\":{\"description\":\"AwsOrganizationCloudAccountProcessor configuration\",\"type\":\"object\",\"properties\":{\"provider\":{\"type\":\"object\",\"properties\":{\"roleArn\":{\"description\":\"The role to be assumed by this processor\",\"type\":\"string\"}}}}},\"githubMultiOrg\":{\"description\":\"GithubMultiOrgReaderProcessor configuration\",\"type\":\"object\",\"properties\":{\"orgs\":{\"description\":\"The configuration parameters for each GitHub org to process.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The name of the GitHub org to process.\",\"type\":\"string\"},\"groupNamespace\":{\"description\":\"The namespace of the group created for this org.\\n\\nDefaults to org name if omitted.\",\"type\":\"string\"},\"userNamespace\":{\"description\":\"The namespace of the users created from this org.\\n\\nDefaults to empty string if omitted.\",\"type\":\"string\"}}}}}},\"ldapOrg\":{\"description\":\"LdapOrgReaderProcessor configuration\",\"type\":\"object\",\"properties\":{\"providers\":{\"description\":\"The configuration parameters for each single LDAP provider.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"The prefix of the target that this matches on, e.g.\\n\\\"ldaps://ds.example.net\\\", with no trailing slash.\",\"type\":\"string\"},\"bind\":{\"description\":\"The settings to use for the bind command. If none are specified,\\nthe bind command is not issued.\",\"type\":\"object\",\"properties\":{\"dn\":{\"description\":\"The DN of the user to auth as.\\n\\nE.g. \\\"uid=ldap-robot,ou=robots,ou=example,dc=example,dc=net\\\"\",\"type\":\"string\"},\"secret\":{\"description\":\"The secret of the user to auth as (its password).\",\"type\":\"string\"}}},\"tls\":{\"description\":\"TLS settings\",\"type\":\"object\",\"properties\":{\"rejectUnauthorized\":{\"type\":\"boolean\"}}},\"users\":{\"description\":\"The settings that govern the reading and interpretation of users.\",\"type\":\"object\",\"properties\":{\"dn\":{\"description\":\"The DN under which users are stored.\\n\\nE.g. \\\"ou=people,ou=example,dc=example,dc=net\\\"\",\"type\":\"string\"},\"options\":{\"description\":\"The search options to use. The default is scope \\\"one\\\" and\\nattributes \\\"*\\\" and \\\"+\\\".\\n\\nIt is common to want to specify a filter, to narrow down the set\\nof matching items.\",\"type\":\"object\",\"properties\":{\"scope\":{\"enum\":[\"base\",\"one\",\"sub\"],\"type\":\"string\"},\"filter\":{\"type\":\"string\"},\"attributes\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"sizeLimit\":{\"type\":\"number\"},\"timeLimit\":{\"type\":\"number\"},\"derefAliases\":{\"type\":\"number\"},\"typesOnly\":{\"type\":\"boolean\"},\"paged\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"pageSize\":{\"type\":\"number\"},\"pagePause\":{\"type\":\"boolean\"}}},{\"type\":\"boolean\"}]}}},\"set\":{\"description\":\"JSON paths (on a.b.c form) and hard coded values to set on those\\npaths.\\n\\nThis can be useful for example if you want to hard code a\\nnamespace or similar on the generated entities.\",\"type\":\"object\"},\"map\":{\"description\":\"Mappings from well known entity fields, to LDAP attribute names\",\"type\":\"object\",\"properties\":{\"rdn\":{\"description\":\"The name of the attribute that holds the relative\\ndistinguished name of each entry. Defaults to \\\"uid\\\".\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.name field of the entity. Defaults to \\\"uid\\\".\",\"type\":\"string\"},\"description\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.description field of the entity.\",\"type\":\"string\"},\"displayName\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.displayName field of the entity. Defaults to\\n\\\"cn\\\".\",\"type\":\"string\"},\"email\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.email field of the entity. Defaults to\\n\\\"mail\\\".\",\"type\":\"string\"},\"picture\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.picture field of the entity.\",\"type\":\"string\"},\"memberOf\":{\"description\":\"The name of the attribute that shall be used for the values of\\nthe spec.memberOf field of the entity. Defaults to \\\"memberOf\\\".\",\"type\":\"string\"}}}}},\"groups\":{\"description\":\"The settings that govern the reading and interpretation of groups.\",\"type\":\"object\",\"properties\":{\"dn\":{\"description\":\"The DN under which groups are stored.\\n\\nE.g. \\\"ou=people,ou=example,dc=example,dc=net\\\"\",\"type\":\"string\"},\"options\":{\"description\":\"The search options to use. The default is scope \\\"one\\\" and\\nattributes \\\"*\\\" and \\\"+\\\".\\n\\nIt is common to want to specify a filter, to narrow down the set\\nof matching items.\",\"type\":\"object\",\"properties\":{\"scope\":{\"enum\":[\"base\",\"one\",\"sub\"],\"type\":\"string\"},\"filter\":{\"type\":\"string\"},\"attributes\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"sizeLimit\":{\"type\":\"number\"},\"timeLimit\":{\"type\":\"number\"},\"derefAliases\":{\"type\":\"number\"},\"typesOnly\":{\"type\":\"boolean\"},\"paged\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"pageSize\":{\"type\":\"number\"},\"pagePause\":{\"type\":\"boolean\"}}},{\"type\":\"boolean\"}]}}},\"set\":{\"description\":\"JSON paths (on a.b.c form) and hard coded values to set on those\\npaths.\\n\\nThis can be useful for example if you want to hard code a\\nnamespace or similar on the generated entities.\",\"type\":\"object\"},\"map\":{\"description\":\"Mappings from well known entity fields, to LDAP attribute names\",\"type\":\"object\",\"properties\":{\"rdn\":{\"description\":\"The name of the attribute that holds the relative\\ndistinguished name of each entry. Defaults to \\\"cn\\\".\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.name field of the entity. Defaults to \\\"cn\\\".\",\"type\":\"string\"},\"description\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.description field of the entity. Defaults to\\n\\\"description\\\".\",\"type\":\"string\"},\"type\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.type field of the entity. Defaults to \\\"groupType\\\".\",\"type\":\"string\"},\"displayName\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.displayName field of the entity. Defaults to\\n\\\"cn\\\".\",\"type\":\"string\"},\"email\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.email field of the entity.\",\"type\":\"string\"},\"picture\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.picture field of the entity.\",\"type\":\"string\"},\"memberOf\":{\"description\":\"The name of the attribute that shall be used for the values of\\nthe spec.parent field of the entity. Defaults to \\\"memberOf\\\".\",\"type\":\"string\"},\"members\":{\"description\":\"The name of the attribute that shall be used for the values of\\nthe spec.children field of the entity. Defaults to \\\"member\\\".\",\"type\":\"string\"}}}}}}}}}},\"microsoftGraphOrg\":{\"description\":\"MicrosoftGraphOrgReaderProcessor configuration\",\"deprecated\":\"Use `catalog.providers.microsoftGraphOrg` instead.\",\"type\":\"object\",\"properties\":{\"providers\":{\"description\":\"The configuration parameters for each single Microsoft Graph provider.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"The prefix of the target that this matches on, e.g.\\n\\\"https://graph.microsoft.com/v1.0\\\", with no trailing slash.\",\"type\":\"string\"},\"authority\":{\"description\":\"The auth authority used.\\n\\nDefault value \\\"https://login.microsoftonline.com\\\"\",\"type\":\"string\"},\"tenantId\":{\"description\":\"The tenant whose org data we are interested in.\",\"type\":\"string\"},\"clientId\":{\"description\":\"The OAuth client ID to use for authenticating requests.\",\"type\":\"string\"},\"clientSecret\":{\"description\":\"The OAuth client secret to use for authenticating requests.\",\"type\":\"string\"},\"userFilter\":{\"description\":\"The filter to apply to extract users.\\n\\nE.g. \\\"accountEnabled eq true and userType eq 'member'\\\"\",\"type\":\"string\"},\"groupFilter\":{\"description\":\"The filter to apply to extract groups.\\n\\nE.g. \\\"securityEnabled eq false and mailEnabled eq true\\\"\",\"type\":\"string\"},\"userSelect\":{\"description\":\"The fields to be fetched on query.\\n\\nE.g. [\\\"id\\\", \\\"displayName\\\", \\\"description\\\"]\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"groupSearch\":{\"description\":\"The search criteria to apply to extract users by groups memberships.\\n\\nE.g. \\\"\\\\\\\"displayName:-team\\\\\\\"\\\" would only match groups which contain '-team'\",\"type\":\"string\"},\"groupSelect\":{\"description\":\"The fields to be fetched on query.\\n\\nE.g. [\\\"id\\\", \\\"displayName\\\", \\\"description\\\"]\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"userGroupMemberFilter\":{\"description\":\"The filter to apply to extract users by groups memberships.\\n\\nE.g. \\\"displayName eq 'Backstage Users'\\\"\",\"type\":\"string\"},\"userGroupMemberSearch\":{\"description\":\"The search criteria to apply to extract groups.\\n\\nE.g. \\\"\\\\\\\"displayName:-team\\\\\\\"\\\" would only match groups which contain '-team'\",\"type\":\"string\"}}}}}}}},\"providers\":{\"type\":\"object\",\"description\":\"List of provider-specific options and attributes\",\"properties\":{\"awsS3\":{\"description\":\"AwsS3EntityProvider configuration\\n\\nUses \\\"default\\\" as default id for the single config variant.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"bucketName\":{\"description\":\"(Required) AWS S3 Bucket Name\",\"type\":\"string\"},\"prefix\":{\"description\":\"(Optional) AWS S3 Object key prefix\\nIf not set, all keys will be accepted, no filtering will be applied.\",\"type\":\"string\"},\"region\":{\"description\":\"(Optional) AWS Region.\\nIf not set, AWS_REGION environment variable or aws config file will be used.\",\"type\":\"string\"},\"accountId\":{\"description\":\"(Optional) AWS Account id.\\nIf not set, main account is used.\",\"type\":\"string\"},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}},{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"bucketName\":{\"description\":\"(Required) AWS S3 Bucket Name\",\"type\":\"string\"},\"prefix\":{\"description\":\"(Optional) AWS S3 Object key prefix\\nIf not set, all keys will be accepted, no filtering will be applied.\",\"type\":\"string\"},\"region\":{\"description\":\"(Optional) AWS Region.\\nIf not set, AWS_REGION environment variable or aws config file will be used.\",\"type\":\"string\"},\"accountId\":{\"description\":\"(Optional) AWS Account id.\\nIf not set, main account is used.\",\"type\":\"string\"},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}}}]},\"azureDevOps\":{\"description\":\"AzureDevopsEntityProvider configuration\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"(Optional) The DevOps host; leave empty for `dev.azure.com`, otherwise set to your self-hosted instance host.\",\"type\":\"string\"},\"organization\":{\"description\":\"(Required) Your organization slug.\",\"type\":\"string\"},\"project\":{\"description\":\"(Required) Your project slug.\",\"type\":\"string\"},\"repository\":{\"description\":\"(Optional) The repository name. Wildcards are supported as show on the examples above.\\nIf not set, all repositories will be searched.\",\"type\":\"string\"},\"path\":{\"description\":\"(Optional) Where to find catalog-info.yaml files. Wildcards are supported.\\nIf not set, defaults to /catalog-info.yaml.\",\"type\":\"string\"},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}}},\"bitbucketCloud\":{\"description\":\"BitbucketCloudEntityProvider configuration\\n\\nUses \\\"default\\\" as default id for the single config variant.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"catalogPath\":{\"description\":\"(Optional) Path to the catalog file. Default to \\\"/catalog-info.yaml\\\".\",\"type\":\"string\"},\"workspace\":{\"description\":\"(Required) Your workspace.\",\"type\":\"string\"},\"filters\":{\"description\":\"(Optional) Filters applied to discovered catalog files in repositories.\",\"type\":\"object\",\"properties\":{\"repoSlug\":{\"description\":\"(Optional) Regular expression filter for the repository slug.\",\"type\":\"string\"},\"projectKey\":{\"description\":\"(Optional) Regular expression filter for the project key.\",\"type\":\"string\"}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the discovery.\"}}},{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"catalogPath\":{\"description\":\"(Optional) Path to the catalog file. Default to \\\"/catalog-info.yaml\\\".\",\"type\":\"string\"},\"workspace\":{\"description\":\"(Required) Your workspace.\",\"type\":\"string\"},\"filters\":{\"description\":\"(Optional) Filters applied to discovered catalog files in repositories.\",\"type\":\"object\",\"properties\":{\"repoSlug\":{\"description\":\"(Optional) Regular expression filter for the repository slug.\",\"type\":\"string\"},\"projectKey\":{\"description\":\"(Optional) Regular expression filter for the project key.\",\"type\":\"string\"}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the discovery.\"}}}}]},\"bitbucketServer\":{\"description\":\"BitbucketServerEntityProvider configuration\\n\\nUses \\\"default\\\" as default id for the single config variant.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"catalogPath\":{\"description\":\"(Optional) Path to the catalog file. Default to \\\"/catalog-info.yaml\\\".\",\"type\":\"string\"},\"filters\":{\"description\":\"(Optional) Filters applied to discovered catalog files in repositories.\",\"type\":\"object\",\"properties\":{\"repoSlug\":{\"description\":\"(Optional) Regular expression filter for the repository slug.\",\"type\":\"string\"},\"projectKey\":{\"description\":\"(Optional) Regular expression filter for the project key.\",\"type\":\"string\"}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}},{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"catalogPath\":{\"description\":\"(Optional) Path to the catalog file. Default to \\\"/catalog-info.yaml\\\".\",\"type\":\"string\"},\"filters\":{\"description\":\"(Optional) Filters applied to discovered catalog files in repositories.\",\"type\":\"object\",\"properties\":{\"repoSlug\":{\"description\":\"(Optional) Regular expression filter for the repository slug.\",\"type\":\"string\"},\"projectKey\":{\"description\":\"(Optional) Regular expression filter for the project key.\",\"type\":\"string\"}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}}}]},\"gcp\":{\"description\":\"GCPCatalogModuleConfig configuration\",\"type\":\"object\",\"properties\":{\"gke\":{\"description\":\"Config for GKE clusters\",\"type\":\"object\",\"properties\":{\"parents\":{\"description\":\"Locations to list clusters from\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}}}},\"gerrit\":{\"description\":\"GerritEntityProvider configuration\\n\\nMaps provider id with configuration.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"(Required) The host of the Gerrit integration to use.\",\"type\":\"string\"},\"query\":{\"description\":\"(Required) The query to use for the \\\"List Projects\\\" API call. Used to limit the\\nscope of the projects that the provider tries to ingest.\",\"type\":\"string\"},\"branch\":{\"description\":\"(Optional) Branch.\\nThe branch where the provider will try to find entities. Defaults to \\\"master\\\".\",\"type\":\"string\"}}}},\"github\":{\"description\":\"GithubEntityProvider configuration\\n\\nUses \\\"default\\\" as default id for the single config variant.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"(Optional) The hostname of your GitHub Enterprise instance.\\nDefault: `github.com`.\",\"type\":\"string\"},\"organization\":{\"description\":\"(Required) Name of your organization account/workspace.\",\"type\":\"string\"},\"catalogPath\":{\"description\":\"(Optional) Path where to look for `catalog-info.yaml` files.\\nYou can use wildcards - `*` or `**` - to search the path and/or the filename\\nDefault: `/catalog-info.yaml`.\",\"type\":\"string\"},\"filters\":{\"description\":\"(Optional) Filter configuration.\",\"type\":\"object\",\"properties\":{\"branch\":{\"description\":\"(Optional) String used to filter results based on the branch name.\",\"type\":\"string\"},\"repository\":{\"description\":\"(Optional) Regular expression used to filter results based on the repository name.\",\"type\":\"string\"},\"allowForks\":{\"description\":\"(Optional) Allow Forks to be evaluated.\",\"type\":\"boolean\"},\"topic\":{\"description\":\"(Optional) GitHub topic-based filters.\",\"type\":\"object\",\"properties\":{\"include\":{\"description\":\"(Optional) An array of strings used to filter in results based on their associated GitHub topics.\\nIf configured, only repositories with one (or more) topic(s) present in the inclusion\\nfilter will be ingested.\\n\\nIf `include` and `exclude` are used, `exclude` has higher priority.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"description\":\"(Optional) An array of strings used to filter out results based on their associated GitHub topics.\\nIf configured, all repositories _except_ those with one (or more) topics(s) present in\\nthe exclusion filter will be ingested.\\n\\nIf `include` and `exclude` are used, `exclude` has higher priority.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}},{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"(Optional) The hostname of your GitHub Enterprise instance.\\nDefault: `github.com`.\",\"type\":\"string\"},\"organization\":{\"description\":\"(Required) Name of your organization account/workspace.\",\"type\":\"string\"},\"catalogPath\":{\"description\":\"(Optional) Path where to look for `catalog-info.yaml` files.\\nYou can use wildcards - `*` or `**` - to search the path and/or the filename\\nDefault: `/catalog-info.yaml`.\",\"type\":\"string\"},\"filters\":{\"description\":\"(Optional) Filter configuration.\",\"type\":\"object\",\"properties\":{\"branch\":{\"description\":\"(Optional) String used to filter results based on the branch name.\",\"type\":\"string\"},\"repository\":{\"description\":\"(Optional) Regular expression used to filter results based on the repository name.\",\"type\":\"string\"},\"allowForks\":{\"description\":\"(Optional) GitHub topic-based filters.\",\"type\":\"boolean\"},\"topic\":{\"description\":\"(Optional) Allow Forks to be evaluated.\",\"type\":\"object\",\"properties\":{\"include\":{\"description\":\"(Optional) An array of strings used to filter in results based on their associated GitHub topics.\\nIf configured, only repositories with one (or more) topic(s) present in the inclusion\\nfilter will be ingested.\\n\\nIf `include` and `exclude` are used, `exclude` has higher priority.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"exclude\":{\"description\":\"(Optional) An array of strings used to filter out results based on their associated GitHub topics.\\nIf configured, all repositories _except_ those with one (or more) topics(s) present in\\nthe exclusion filter will be ingested.\\n\\nIf `include` and `exclude` are used, `exclude` has higher priority.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}}}]},\"githubOrg\":{\"description\":\"Configuration for catalogModuleGithubOrgEntityProvider\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"A stable id for this provider. Entities from this provider will\\nbe associated with this ID, so you should take care not to change\\nit over time since that may lead to orphaned entities and/or\\nconflicts.\",\"type\":\"string\"},\"githubUrl\":{\"description\":\"The target that this provider should consume.\",\"type\":\"string\"},\"orgs\":{\"description\":\"The list of the GitHub orgs to consume. By default will consume all accessible\\norgs on the given GitHub instance (support for GitHub App integration only).\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"schedule\":{\"description\":\"The refresh schedule to use.\"}}},{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"A stable id for this provider. Entities from this provider will\\nbe associated with this ID, so you should take care not to change\\nit over time since that may lead to orphaned entities and/or\\nconflicts.\",\"type\":\"string\"},\"githubUrl\":{\"description\":\"The target that this provider should consume.\",\"type\":\"string\"},\"orgs\":{\"description\":\"The list of the GitHub orgs to consume. By default will consume all accessible\\norgs on the given GitHub instance (support for GitHub App integration only).\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"schedule\":{\"description\":\"The refresh schedule to use.\"}}}}]},\"gitlab\":{\"description\":\"GitlabDiscoveryEntityProvider configuration\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"host\":{\"description\":\"(Required) Gitlab's host name.\",\"type\":\"string\"},\"group\":{\"description\":\"(Optional) Gitlab's group[/subgroup] where the discovery is done.\\nIf not defined the whole instance will be scanned.\",\"type\":\"string\"},\"branch\":{\"description\":\"(Optional) Default branch to read the catalog-info.yaml file.\\nIf not set, 'master' will be used.\",\"type\":\"string\"},\"entityFilename\":{\"description\":\"(Optional) The name used for the catalog file.\\nIf not set, 'catalog-info.yaml' will be used.\",\"type\":\"string\"},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"},\"projectPattern\":{\"description\":\"(Optional) RegExp for the Project Name Pattern\",\"type\":\"string\"},\"userPattern\":{\"description\":\"(Optional) RegExp for the User Name Pattern\",\"type\":\"string\"},\"groupPattern\":{\"description\":\"(Optional) RegExp for the Group Name Pattern\",\"type\":\"string\"},\"skipForkedRepos\":{\"description\":\"(Optional) Skip forked repository\",\"type\":\"boolean\"}}}},\"microsoftGraphOrg\":{\"description\":\"MicrosoftGraphOrgEntityProvider configuration.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"The prefix of the target that this matches on, e.g.\\n\\\"https://graph.microsoft.com/v1.0\\\", with no trailing slash.\",\"type\":\"string\"},\"authority\":{\"description\":\"The auth authority used.\\n\\nDefault value \\\"https://login.microsoftonline.com\\\"\",\"type\":\"string\"},\"tenantId\":{\"description\":\"The tenant whose org data we are interested in.\",\"type\":\"string\"},\"clientId\":{\"description\":\"The OAuth client ID to use for authenticating requests.\",\"type\":\"string\"},\"clientSecret\":{\"description\":\"The OAuth client secret to use for authenticating requests.\",\"type\":\"string\"},\"queryMode\":{\"description\":\"By default, the Microsoft Graph API only provides the basic feature set\\nfor querying. Certain features are limited to advanced query capabilities\\n(see https://docs.microsoft.com/en-us/graph/aad-advanced-queries)\\nand need to be enabled.\\n\\nSome features like `$expand` are not available for advanced queries, though.\",\"type\":\"string\"},\"user\":{\"type\":\"object\",\"properties\":{\"expand\":{\"description\":\"The \\\"expand\\\" argument to apply to users.\\n\\nE.g. \\\"manager\\\".\",\"type\":\"string\"},\"filter\":{\"description\":\"The filter to apply to extract users.\\n\\nE.g. \\\"accountEnabled eq true and userType eq 'member'\\\"\",\"type\":\"string\"}}},\"group\":{\"type\":\"object\",\"properties\":{\"expand\":{\"description\":\"The \\\"expand\\\" argument to apply to groups.\\n\\nE.g. \\\"member\\\".\",\"type\":\"string\"},\"filter\":{\"description\":\"The filter to apply to extract groups.\\n\\nE.g. \\\"securityEnabled eq false and mailEnabled eq true\\\"\",\"type\":\"string\"},\"search\":{\"description\":\"The search criteria to apply to extract users by groups memberships.\\n\\nE.g. \\\"\\\\\\\"displayName:-team\\\\\\\"\\\" would only match groups which contain '-team'\",\"type\":\"string\"},\"select\":{\"description\":\"The fields to be fetched on query.\\n\\nE.g. [\\\"id\\\", \\\"displayName\\\", \\\"description\\\"]\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"userGroupMember\":{\"type\":\"object\",\"properties\":{\"filter\":{\"description\":\"The filter to apply to extract users by groups memberships.\\n\\nE.g. \\\"displayName eq 'Backstage Users'\\\"\",\"type\":\"string\"},\"search\":{\"description\":\"The search criteria to apply to extract groups.\\n\\nE.g. \\\"\\\\\\\"displayName:-team\\\\\\\"\\\" would only match groups which contain '-team'\",\"type\":\"string\"}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}},{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"The prefix of the target that this matches on, e.g.\\n\\\"https://graph.microsoft.com/v1.0\\\", with no trailing slash.\",\"type\":\"string\"},\"authority\":{\"description\":\"The auth authority used.\\n\\nDefault value \\\"https://login.microsoftonline.com\\\"\",\"type\":\"string\"},\"tenantId\":{\"description\":\"The tenant whose org data we are interested in.\",\"type\":\"string\"},\"clientId\":{\"description\":\"The OAuth client ID to use for authenticating requests.\",\"type\":\"string\"},\"clientSecret\":{\"description\":\"The OAuth client secret to use for authenticating requests.\",\"type\":\"string\"},\"queryMode\":{\"description\":\"By default, the Microsoft Graph API only provides the basic feature set\\nfor querying. Certain features are limited to advanced query capabilities\\n(see https://docs.microsoft.com/en-us/graph/aad-advanced-queries)\\nand need to be enabled.\\n\\nSome features like `$expand` are not available for advanced queries, though.\",\"type\":\"string\"},\"user\":{\"type\":\"object\",\"properties\":{\"filter\":{\"description\":\"The filter to apply to extract users.\\n\\nE.g. \\\"accountEnabled eq true and userType eq 'member'\\\"\",\"type\":\"string\"}}},\"group\":{\"type\":\"object\",\"properties\":{\"filter\":{\"description\":\"The filter to apply to extract groups.\\n\\nE.g. \\\"securityEnabled eq false and mailEnabled eq true\\\"\",\"type\":\"string\"},\"search\":{\"description\":\"The search criteria to apply to extract users by groups memberships.\\n\\nE.g. \\\"\\\\\\\"displayName:-team\\\\\\\"\\\" would only match groups which contain '-team'\",\"type\":\"string\"},\"select\":{\"description\":\"The fields to be fetched on query.\\n\\nE.g. [\\\"id\\\", \\\"displayName\\\", \\\"description\\\"]\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"userGroupMember\":{\"type\":\"object\",\"properties\":{\"filter\":{\"description\":\"The filter to apply to extract users by groups memberships.\\n\\nE.g. \\\"displayName eq 'Backstage Users'\\\"\",\"type\":\"string\"},\"search\":{\"description\":\"The search criteria to apply to extract groups.\\n\\nE.g. \\\"\\\\\\\"displayName:-team\\\\\\\"\\\" would only match groups which contain '-team'\",\"type\":\"string\"}}},\"schedule\":{\"description\":\"(Optional) TaskScheduleDefinition for the refresh.\"}}}}]},\"puppetdb\":{\"description\":\"PuppetDB Entity Provider configuration. Uses \\\"default\\\" as default ID for the single config variant.\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"(Required) The base URL of PuppetDB API instance.\",\"type\":\"string\"},\"query\":{\"description\":\"(Optional) PQL query to filter PuppetDB nodes.\",\"type\":\"string\"},\"schedule\":{\"description\":\"(Optional) Task schedule definition for the refresh.\"}}},{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"(Required) The base URL of PuppetDB API instance.\",\"type\":\"string\"},\"query\":{\"description\":\"(Optional) PQL query to filter PuppetDB nodes.\",\"type\":\"string\"},\"schedule\":{\"description\":\"(Optional) Task schedule definition for the refresh.\"}}}}]}}},\"import\":{\"description\":\"List of import flow specific options and attributes\",\"type\":\"object\",\"properties\":{\"entityFilename\":{\"description\":\"Catalog entity descriptor filename, defaults to \\\"catalog-info.yaml\\\"\",\"type\":\"string\"},\"pullRequestBranchName\":{\"description\":\"A branch name used in pull request when registering existing component via UI\\nValid git refname required, see: https://git-scm.com/docs/git-check-ref-format\\nDefaults to \\\"backstage-integration\\\"\",\"type\":\"string\"}}}}},\"ldap\":{\"description\":\"LdapOrgEntityProvider / LdapOrgReaderProcessor configuration\",\"type\":\"object\",\"properties\":{\"providers\":{\"description\":\"The configuration parameters for each single LDAP provider.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"The prefix of the target that this matches on, e.g.\\n\\\"ldaps://ds.example.net\\\", with no trailing slash.\",\"type\":\"string\"},\"bind\":{\"description\":\"The settings to use for the bind command. If none are specified,\\nthe bind command is not issued.\",\"type\":\"object\",\"properties\":{\"dn\":{\"description\":\"The DN of the user to auth as.\\n\\nE.g. \\\"uid=ldap-robot,ou=robots,ou=example,dc=example,dc=net\\\"\",\"type\":\"string\"},\"secret\":{\"description\":\"The secret of the user to auth as (its password).\",\"type\":\"string\"}}},\"tls\":{\"description\":\"TLS settings\",\"type\":\"object\",\"properties\":{\"rejectUnauthorized\":{\"type\":\"boolean\"}}},\"users\":{\"description\":\"The settings that govern the reading and interpretation of users.\",\"type\":\"object\",\"properties\":{\"dn\":{\"description\":\"The DN under which users are stored.\\n\\nE.g. \\\"ou=people,ou=example,dc=example,dc=net\\\"\",\"type\":\"string\"},\"options\":{\"description\":\"The search options to use. The default is scope \\\"one\\\" and\\nattributes \\\"*\\\" and \\\"+\\\".\\n\\nIt is common to want to specify a filter, to narrow down the set\\nof matching items.\",\"type\":\"object\",\"properties\":{\"scope\":{\"enum\":[\"base\",\"one\",\"sub\"],\"type\":\"string\"},\"filter\":{\"type\":\"string\"},\"attributes\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"sizeLimit\":{\"type\":\"number\"},\"timeLimit\":{\"type\":\"number\"},\"derefAliases\":{\"type\":\"number\"},\"typesOnly\":{\"type\":\"boolean\"},\"paged\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"pageSize\":{\"type\":\"number\"},\"pagePause\":{\"type\":\"boolean\"}}},{\"type\":\"boolean\"}]}}},\"set\":{\"description\":\"JSON paths (on a.b.c form) and hard coded values to set on those\\npaths.\\n\\nThis can be useful for example if you want to hard code a\\nnamespace or similar on the generated entities.\",\"type\":\"object\"},\"map\":{\"description\":\"Mappings from well known entity fields, to LDAP attribute names\",\"type\":\"object\",\"properties\":{\"rdn\":{\"description\":\"The name of the attribute that holds the relative\\ndistinguished name of each entry. Defaults to \\\"uid\\\".\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.name field of the entity. Defaults to \\\"uid\\\".\",\"type\":\"string\"},\"description\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.description field of the entity.\",\"type\":\"string\"},\"displayName\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.displayName field of the entity. Defaults to\\n\\\"cn\\\".\",\"type\":\"string\"},\"email\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.email field of the entity. Defaults to\\n\\\"mail\\\".\",\"type\":\"string\"},\"picture\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.picture field of the entity.\",\"type\":\"string\"},\"memberOf\":{\"description\":\"The name of the attribute that shall be used for the values of\\nthe spec.memberOf field of the entity. Defaults to \\\"memberOf\\\".\",\"type\":\"string\"}}}}},\"groups\":{\"description\":\"The settings that govern the reading and interpretation of groups.\",\"type\":\"object\",\"properties\":{\"dn\":{\"description\":\"The DN under which groups are stored.\\n\\nE.g. \\\"ou=people,ou=example,dc=example,dc=net\\\"\",\"type\":\"string\"},\"options\":{\"description\":\"The search options to use. The default is scope \\\"one\\\" and\\nattributes \\\"*\\\" and \\\"+\\\".\\n\\nIt is common to want to specify a filter, to narrow down the set\\nof matching items.\",\"type\":\"object\",\"properties\":{\"scope\":{\"enum\":[\"base\",\"one\",\"sub\"],\"type\":\"string\"},\"filter\":{\"type\":\"string\"},\"attributes\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"sizeLimit\":{\"type\":\"number\"},\"timeLimit\":{\"type\":\"number\"},\"derefAliases\":{\"type\":\"number\"},\"typesOnly\":{\"type\":\"boolean\"},\"paged\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"pageSize\":{\"type\":\"number\"},\"pagePause\":{\"type\":\"boolean\"}}},{\"type\":\"boolean\"}]}}},\"set\":{\"description\":\"JSON paths (on a.b.c form) and hard coded values to set on those\\npaths.\\n\\nThis can be useful for example if you want to hard code a\\nnamespace or similar on the generated entities.\",\"type\":\"object\"},\"map\":{\"description\":\"Mappings from well known entity fields, to LDAP attribute names\",\"type\":\"object\",\"properties\":{\"rdn\":{\"description\":\"The name of the attribute that holds the relative\\ndistinguished name of each entry. Defaults to \\\"cn\\\".\",\"type\":\"string\"},\"name\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.name field of the entity. Defaults to \\\"cn\\\".\",\"type\":\"string\"},\"description\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe metadata.description field of the entity. Defaults to\\n\\\"description\\\".\",\"type\":\"string\"},\"type\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.type field of the entity. Defaults to \\\"groupType\\\".\",\"type\":\"string\"},\"displayName\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.displayName field of the entity. Defaults to\\n\\\"cn\\\".\",\"type\":\"string\"},\"email\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.email field of the entity.\",\"type\":\"string\"},\"picture\":{\"description\":\"The name of the attribute that shall be used for the value of\\nthe spec.profile.picture field of the entity.\",\"type\":\"string\"},\"memberOf\":{\"description\":\"The name of the attribute that shall be used for the values of\\nthe spec.parent field of the entity. Defaults to \\\"memberOf\\\".\",\"type\":\"string\"},\"members\":{\"description\":\"The name of the attribute that shall be used for the values of\\nthe spec.children field of the entity. Defaults to \\\"member\\\".\",\"type\":\"string\"}}}}}}}}}},\"codescene\":{\"description\":\"Configuration options for the CodeScene plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base url of the CodeScene installation.\",\"type\":\"string\"}}},\"costInsights\":{\"type\":\"object\",\"properties\":{\"engineerCost\":{\"type\":\"number\"},\"engineerThreshold\":{\"type\":\"number\"},\"baseCurrency\":{\"type\":\"object\",\"properties\":{\"locale\":{\"type\":\"string\"},\"options\":{\"type\":\"object\",\"properties\":{\"localeMatcher\":{\"type\":\"string\"},\"style\":{\"type\":\"string\"},\"currency\":{\"type\":\"string\"},\"currencySign\":{\"type\":\"string\"},\"useGrouping\":{\"type\":\"boolean\"},\"minimumIntegerDigits\":{\"type\":\"number\"},\"minimumFractionDigits\":{\"type\":\"number\"},\"maximumFractionDigits\":{\"type\":\"number\"},\"minimumSignificantDigits\":{\"type\":\"number\"},\"maximumSignificantDigits\":{\"type\":\"number\"}}}}},\"products\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"icon\":{\"enum\":[\"compute\",\"data\",\"database\",\"ml\",\"search\",\"storage\"],\"type\":\"string\"}}}},\"metrics\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"default\":{\"type\":\"boolean\"}}}},\"currencies\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"label\":{\"type\":\"string\"},\"unit\":{\"type\":\"string\"},\"kind\":{\"type\":\"string\"},\"prefix\":{\"type\":\"string\"},\"rate\":{\"type\":\"number\"},\"default\":{\"type\":\"boolean\"}}}}}},\"devTools\":{\"description\":\"DevTools configuration.\",\"type\":\"object\",\"properties\":{\"externalDependencies\":{\"description\":\"External dependency configuration.\",\"type\":\"object\",\"properties\":{\"endpoints\":{\"description\":\"The list of endpoints to check.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The name of the endpoint.\",\"type\":\"string\"},\"type\":{\"description\":\"Type of check to perform; currently fetch or ping\",\"type\":\"string\"},\"target\":{\"description\":\"The target of the endpoint; currently either a URL for fetch or server name for ping.\",\"type\":\"string\"}}}}}},\"info\":{\"description\":\"Info configuration\",\"type\":\"object\",\"properties\":{\"packagePrefixes\":{\"description\":\"A list of package prefixes that DevTools will use for filtering all available dependencies\\n(default is [\\\"@backstage\\\"])\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"dynatrace\":{\"description\":\"dynatrace config\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"base url for links\",\"type\":\"string\"}}},\"events\":{\"type\":\"object\",\"properties\":{\"http\":{\"type\":\"object\",\"properties\":{\"topics\":{\"description\":\"Topics for which a route has to be registered\\nat which we can receive events via HTTP POST requests\\n(i.e. received from webhooks).\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"modules\":{\"type\":\"object\",\"properties\":{\"awsSqs\":{\"description\":\"events-backend-module-aws-sqs plugin configuration.\",\"type\":\"object\",\"properties\":{\"awsSqsConsumingEventPublisher\":{\"description\":\"Configuration for AwsSqsConsumingEventPublisher.\",\"type\":\"object\",\"properties\":{\"topics\":{\"description\":\"Contains a record per topic for which an AWS SQS queue\\nshould be used as source of events.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"queue\":{\"description\":\"(Required) Queue-related configuration.\",\"type\":\"object\",\"properties\":{\"region\":{\"description\":\"(Required) The region of the AWS SQS queue.\",\"type\":\"string\"},\"url\":{\"description\":\"(Required) The absolute URL for the AWS SQS queue to be used.\",\"type\":\"string\"},\"visibilityTimeout\":{\"description\":\"(Optional) Visibility timeout for messages in flight.\"},\"waitTime\":{\"description\":\"(Optional) Wait time when polling for available messages.\\nDefault: 20 seconds.\"}}},\"timeout\":{\"description\":\"(Optional) Timeout for the task execution which includes polling for messages\\nand publishing the events to the event broker\\nand the wait time after empty receives.\\n\\nMust be greater than `queue.waitTime` + `waitTimeAfterEmptyReceive`.\"},\"waitTimeAfterEmptyReceive\":{\"description\":\"(Optional) Wait time before polling again if no message was received.\\nDefault: 1 minute.\"}}}}}}}},\"github\":{\"description\":\"events-backend-module-github plugin configuration.\",\"type\":\"object\",\"properties\":{\"webhookSecret\":{\"description\":\"Secret token for webhook requests used to verify signatures.\\n\\nSee https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\\nfor more details.\",\"type\":\"string\"}}},\"gitlab\":{\"description\":\"events-backend-module-gitlab plugin configuration.\",\"type\":\"object\",\"properties\":{\"webhookSecret\":{\"description\":\"Secret token for webhook requests used to verify tokens.\\n\\nSee https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#validate-payloads-by-using-a-secret-token\\nfor more details.\",\"type\":\"string\"}}}}}}},\"explore\":{\"type\":\"object\",\"properties\":{\"tools\":{\"description\":\"Tools to be used for the explore tool provider.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"image\":{\"type\":\"string\"},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"lifecycle\":{\"type\":\"string\"}}}}}},\"fossa\":{\"type\":\"object\",\"properties\":{\"organizationId\":{\"description\":\"The organization id in fossa.\",\"type\":\"string\"},\"externalLinkBaseUrl\":{\"description\":\"The base url to use for external links (from Backstage to Fossa).\",\"type\":\"string\"}}},\"gocd\":{\"description\":\"Configurations for the GoCD plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base url of the GoCD installation.\",\"type\":\"string\"}}},\"ilert\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"Domain used by users to access iLert web UI.\\nExample: https://my-app.ilert.com/\",\"type\":\"string\"},\"proxyPath\":{\"description\":\"Path to use for requests via the proxy, defaults to /ilert/api\",\"type\":\"string\"}}},\"jenkins\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"Default instance baseUrl, can be specified on a named instance called \\\"default\\\"\",\"type\":\"string\"},\"username\":{\"description\":\"Default instance username, can be specified on a named instance called \\\"default\\\"\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Default Instance apiKey, can be specified on a named instance called \\\"default\\\"\",\"type\":\"string\"},\"instances\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"Name of the instance, this will be used in an annotation on catalog entities to refer to jobs on this instance.\\n\\nUse a name of \\\"default\\\" to specify the jenkins instance details if the annotation doesn't explicitly name an\\ninstance.\",\"type\":\"string\"},\"baseUrl\":{\"type\":\"string\"},\"username\":{\"type\":\"string\"},\"apiKey\":{\"type\":\"string\"},\"extraRequestHeaders\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"properties\":{\"Authorization\":{\"type\":\"string\"},\"authorization\":{\"type\":\"string\"}}}}}}}},\"kafka\":{\"type\":\"object\",\"properties\":{\"clusters\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"Cluster name\",\"type\":\"string\"},\"dashboardUrl\":{\"description\":\"Cluster dashboard url\",\"type\":\"string\"},\"brokers\":{\"description\":\"List of brokers in the Kafka cluster to connect to.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ssl\":{\"description\":\"Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect.\\nSee https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"ca\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"key\":{\"type\":\"string\"},\"cert\":{\"type\":\"string\"},\"rejectUnauthorized\":{\"type\":\"boolean\"}}},{\"type\":\"boolean\"}]},\"sasl\":{\"description\":\"Optional SASL connection parameters.\",\"type\":\"object\",\"properties\":{\"mechanism\":{\"enum\":[\"plain\",\"scram-sha-256\",\"scram-sha-512\"],\"type\":\"string\"},\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"}}}}}},\"clientId\":{\"description\":\"Client ID used to Backstage uses to identify when connecting to the Kafka cluster.\",\"type\":\"string\"}}},\"kubernetes\":{\"type\":\"object\",\"properties\":{\"objectTypes\":{\"type\":\"array\",\"items\":{\"enum\":[\"configmaps\",\"cronjobs\",\"customresources\",\"daemonsets\",\"deployments\",\"horizontalpodautoscalers\",\"ingresses\",\"jobs\",\"limitranges\",\"pods\",\"replicasets\",\"services\",\"statefulsets\"],\"type\":\"string\"}},\"serviceLocatorMethod\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"multiTenant\",\"singleTenant\",\"catalogRelation\"]}}},\"clusterLocatorMethods\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"config\"]},\"clusters\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"serviceAccountToken\":{\"type\":\"string\"},\"authProvider\":{\"enum\":[\"aws\",\"azure\",\"google\",\"googleServiceAccount\",\"oidc\",\"serviceAccount\"],\"type\":\"string\"},\"oidcTokenProvider\":{\"type\":\"string\"},\"skipTLSVerify\":{\"type\":\"boolean\"},\"skipMetricsLookup\":{\"type\":\"boolean\"},\"caData\":{\"type\":\"string\"},\"caFile\":{\"type\":\"string\"}}}}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"catalog\"]}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"localKubectlProxy\"]}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"gke\"]},\"projectId\":{\"type\":\"string\"},\"region\":{\"type\":\"string\"},\"skipTLSVerify\":{\"type\":\"boolean\"},\"skipMetricsLookup\":{\"type\":\"boolean\"}}}]}},\"customResources\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"group\":{\"type\":\"string\"},\"apiVersion\":{\"type\":\"string\"},\"plural\":{\"type\":\"string\"}}}},\"apiVersionOverrides\":{\"description\":\"(Optional) API Version Overrides\\nIf set, the specified api version will be used to make requests for the corresponding object.\\nIf running a legacy Kubernetes version, you may use this to override the default api versions\\nthat are not supported in your cluster.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"properties\":{\"pods\":{\"type\":\"string\"},\"services\":{\"type\":\"string\"},\"configmaps\":{\"type\":\"string\"},\"deployments\":{\"type\":\"string\"},\"limitranges\":{\"type\":\"string\"},\"replicasets\":{\"type\":\"string\"},\"horizontalpodautoscalers\":{\"type\":\"string\"},\"jobs\":{\"type\":\"string\"},\"cronjobs\":{\"type\":\"string\"},\"ingresses\":{\"type\":\"string\"},\"customresources\":{\"type\":\"string\"},\"statefulsets\":{\"type\":\"string\"},\"daemonsets\":{\"type\":\"string\"}}}}},\"linguist\":{\"description\":\"Configuration options for the linguist plugin\",\"type\":\"object\",\"properties\":{\"schedule\":{},\"batchSize\":{\"default\":20,\"type\":\"number\"},\"useSourceLocation\":{\"default\":false,\"type\":\"boolean\"},\"age\":{\"description\":\"Refresh generated language breakdown\"},\"kind\":{\"default\":\"['API', 'Component', 'Template']\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"linguistJsOptions\":{\"description\":\"[linguist-js](https://www.npmjs.com/package/linguist-js) options\"},\"tagsProcessor\":{\"description\":\"Options for the tags processor\",\"type\":\"object\",\"properties\":{\"bytesThreshold\":{\"description\":\"Determines how many bytes of a language should be in a repo\\nfor it to be added as an entity tag. Defaults to 0.\",\"type\":\"number\"},\"languageTypes\":{\"description\":\"The types of linguist languages that should be processed. Can be\\nany of \\\"programming\\\", \\\"data\\\", \\\"markup\\\", \\\"prose\\\". Defaults to [\\\"programming\\\"].\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"languageMap\":{\"description\":\"A custom mapping of linguist languages to how they should be rendered as entity tags.\\nIf a language is mapped to '' it will not be included as a tag.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"cacheTTL\":{\"description\":\"How long to cache entity languages for in memory. Used to avoid constant db hits during\\nprocessing. Defaults to 30 minutes.\"}}}}},\"opencost\":{\"description\":\"Configurations for the OpenCost plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base URL for the OpenCost API\",\"type\":\"string\"}}},\"periskop\":{\"description\":\"Configuration options for the periskop plugin\",\"type\":\"object\",\"properties\":{\"instances\":{\"description\":\"Integration configuration for the periskop servers\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The name of the given Periskop instance\",\"type\":\"string\"},\"url\":{\"description\":\"The hostname of the given Periskop instance\",\"type\":\"string\"}}}}}},\"pagerDuty\":{\"description\":\"Configuration for the PagerDuty plugin\",\"type\":\"object\",\"properties\":{\"eventsBaseUrl\":{\"description\":\"Optional Events Base URL to override the default.\",\"type\":\"string\"}}},\"permission\":{\"description\":\"Configuration options for Backstage permissions and authorization\",\"type\":\"object\",\"properties\":{\"enabled\":{\"description\":\"Whether authorization is enabled in Backstage. Defaults to false, which means authorization\\nrequests will be automatically allowed without invoking the authorization policy.\",\"type\":\"boolean\"}}},\"playlist\":{\"type\":\"object\",\"properties\":{\"title\":{\"description\":\"(Optional) The title that will shown in the UI; Defaults to`Playlist` if undefined.\",\"type\":\"string\"}}},\"proxy\":{\"type\":\"object\",\"properties\":{\"skipInvalidProxies\":{\"description\":\"Rather than failing to start up, the proxy backend will instead just warn on invalid endpoints.\",\"type\":\"boolean\"},\"reviveConsumedRequestBodies\":{\"description\":\"Revive request bodies that have already been consumed by earlier middleware.\",\"type\":\"boolean\"},\"endpoints\":{\"description\":\"A list of forwarding-proxies. Each key is a route to match,\\nbelow the prefix that the proxy plugin is mounted on. It must\\nstart with a '/'.\",\"type\":\"object\",\"additionalProperties\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"target\":{\"description\":\"Target of the proxy. Url string to be parsed with the url module.\",\"type\":\"string\"},\"headers\":{\"description\":\"Object with extra headers to be added to target requests.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"properties\":{\"Authorization\":{\"type\":\"string\"},\"authorization\":{\"type\":\"string\"},\"X-Api-Key\":{\"type\":\"string\"},\"x-api-key\":{\"type\":\"string\"}}},\"changeOrigin\":{\"description\":\"Changes the origin of the host header to the target URL. Default: true.\",\"type\":\"boolean\"},\"pathRewrite\":{\"description\":\"Rewrite target's url path. Object-keys will be used as RegExp to match paths.\\nIf pathRewrite is not specified, it is set to a single rewrite that removes the entire prefix and route.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"allowedMethods\":{\"description\":\"Limit the forwarded HTTP methods, for example allowedMethods: ['GET'] to enforce read-only access.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"allowedHeaders\":{\"description\":\"Limit the forwarded HTTP methods. By default, only the headers that are considered safe for CORS\\nand headers that are set by the proxy will be forwarded.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},{\"type\":\"string\"}]}}}},\"rollbar\":{\"description\":\"Configuration options for the rollbar plugin\",\"type\":\"object\",\"properties\":{\"organization\":{\"description\":\"The Rollbar organization name. This can be omitted by using the `rollbar.com/project-slug` annotation.\",\"type\":\"string\"},\"accountToken\":{\"description\":\"The authentication token for accessing the Rollbar API\",\"type\":\"string\"}}},\"scaffolder\":{\"description\":\"Configuration options for the scaffolder plugin\",\"type\":\"object\",\"properties\":{\"defaultAuthor\":{\"description\":\"The commit author info used when new components are created.\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"}}},\"defaultCommitMessage\":{\"description\":\"The commit message used when new components are created.\",\"type\":\"string\"},\"concurrentTasksLimit\":{\"description\":\"Sets the number of concurrent tasks that can be run at any given time on the TaskWorker.\\n\\nDefaults to 10.\\n\\nSet to 0 to disable task workers altogether.\",\"type\":\"number\"}}},\"confluence\":{\"description\":\"Configuration options for the Confluence to Markdown action\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base URL for accessing the Confluence API\",\"type\":\"string\"},\"auth\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Authentication method - basic, bearer, username/password\",\"enum\":[\"basic\",\"bearer\",\"userpass\"],\"type\":\"string\"},\"token\":{\"description\":\"Token used for the basic and bearer auth methods\",\"type\":\"string\"},\"email\":{\"description\":\"Email used with the token for the basic auth method\",\"type\":\"string\"},\"username\":{\"description\":\"Username used with the Username/Password auth method\",\"type\":\"string\"},\"password\":{\"description\":\"Password used with the Username/Password auth method\",\"type\":\"string\"}}}}},\"search\":{\"description\":\"Configuration options for the search plugin\",\"type\":\"object\",\"properties\":{\"maxPageLimit\":{\"description\":\"Sets the maximum max page limit size. Defaults to 100.\",\"type\":\"number\"},\"permissions\":{\"description\":\"Options related to the search integration with the Backstage permissions system\",\"type\":\"object\",\"properties\":{\"queryLatencyBudgetMs\":{\"description\":\"Limits the amount of time the search backend will spend retrieving and\\nauthorizing results from the search engine when permissions are\\nenabled. When the latency of the query endpoint reaches this threshold,\\nthe results obtained up until that point will be returned, even if the\\npage is incomplete.\\n\\nThis limit is only expected to be hit for broad queries from users with\\nextremely restrictive visibility, or for very high page offsets.\",\"default\":1000,\"type\":\"number\"}}},\"query\":{\"description\":\"An object representing the default search query configuration.\\nBy configuring and modifying the values of this object,\\nyou can customize the default values of the search queries\\nand define how it behaves by default.\",\"type\":\"object\",\"properties\":{\"pageLimit\":{\"description\":\"A number indicating the maximum number of results to be returned\\nper page during pagination.\",\"enum\":[10,100,25,50],\"type\":\"number\"}}},\"collators\":{\"type\":\"object\",\"properties\":{\"catalog\":{\"description\":\"Configuration options for `@backstage/plugin-search-backend-module-catalog`\",\"type\":\"object\",\"properties\":{\"locationTemplate\":{\"description\":\"A templating string with placeholders, to form the final location of\\nthe entity.\\n\\nDefaults to '/catalog/:namespace/:kind/:name'\",\"type\":\"string\"},\"filter\":{\"description\":\"A filter expression passed to the catalog client, to select what\\nentities to collate.\\n\\nDefaults to no filter, ie indexing all entities.\",\"type\":\"object\",\"additionalProperties\":true},\"batchSize\":{\"description\":\"The number of entities to process at a time. Keep this at a\\nreasonable number to avoid overloading either the catalog or the\\nsearch backend.\\n\\nDefaults to 500\",\"type\":\"number\"},\"schedule\":{\"description\":\"The schedule for how often to run the collation job.\"}}},\"explore\":{\"description\":\"Configuration options for `@backstage/plugin-search-backend-module-explore`\",\"type\":\"object\",\"properties\":{\"schedule\":{\"description\":\"The schedule for how often to run the collation job.\"}}},\"techdocs\":{\"description\":\"Configuration options for `@backstage/plugin-search-backend-module-techdocs`\",\"type\":\"object\",\"properties\":{\"schedule\":{\"description\":\"The schedule for how often to run the collation job.\"},\"locationTemplate\":{\"description\":\"A templating string with placeholders, to form the final location of\\nthe entity.\\n\\nDefaults to `'/docs/:namespace/:kind/:name/:path'`.\",\"type\":\"string\"},\"parallelismLimit\":{\"description\":\"An abstract value that controls the concurrency level of the\\ncollation process. Increasing this value will both increase the\\nnumber of entities fetched at a time from the catalog, as well as how\\nmany things are being processed concurrently.\\n\\nDefaults to `10`.\",\"type\":\"number\"},\"legacyPathCasing\":{\"description\":\"Defaults to `false`.\",\"type\":\"boolean\"}}}}},\"elasticsearch\":{\"description\":\"Options for ElasticSearch\",\"type\":\"object\",\"properties\":{\"batchSize\":{\"description\":\"Batch size for elastic search indexing tasks. Defaults to 1000.\",\"type\":\"number\"},\"highlightOptions\":{\"description\":\"Options for configuring highlight settings\\nSee https://www.elastic.co/guide/en/elasticsearch/reference/7.17/highlighting.html\",\"type\":\"object\",\"properties\":{\"fragmentSize\":{\"description\":\"The size of the highlighted fragment in characters. Defaults to 1000.\",\"type\":\"number\"},\"numFragments\":{\"description\":\"Number of result fragments to extract. Fragments will be concatenated with `fragmentDelimiter`. Defaults to 1.\",\"type\":\"number\"},\"fragmentDelimiter\":{\"description\":\"Delimiter string used to concatenate fragments. Defaults to \\\" ... \\\".\",\"type\":\"string\"}}},\"indexTemplates\":{\"description\":\"Elasticsearch specific index template bodies\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"body\":{\"type\":\"object\",\"properties\":{\"index_patterns\":{\"description\":\"Array of wildcard (*) expressions used to match the names of data streams and indices during creation.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"composed_of\":{\"description\":\"An ordered list of component template names.\\nComponent templates are merged in the order specified,\\nmeaning that the last component template specified has the highest precedence.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"template\":{\"description\":\"See available properties of template\\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-put-template.html#put-index-template-api-request-body\",\"type\":\"object\"}}}}}},\"clientOptions\":{\"description\":\"Miscellaneous options for the client\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"ssl\":{\"type\":\"object\",\"properties\":{\"rejectUnauthorized\":{\"description\":\"If true the server will reject any connection which is not\\nauthorized with the list of supplied CAs.\",\"default\":true,\"type\":\"boolean\"}}},\"provider\":{\"type\":\"string\",\"enum\":[\"elastic\"]},\"cloudId\":{\"description\":\"Elastic.co CloudID\\nSee: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication\",\"type\":\"string\"},\"auth\":{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"}}}}},{\"type\":\"object\",\"properties\":{\"ssl\":{\"type\":\"object\",\"properties\":{\"rejectUnauthorized\":{\"description\":\"If true the server will reject any connection which is not\\nauthorized with the list of supplied CAs.\",\"default\":true,\"type\":\"boolean\"}}},\"provider\":{\"type\":\"string\",\"enum\":[\"aws\"]},\"node\":{\"description\":\"Node configuration.\\nURL AWS ES endpoint to connect to.\\nEg. https://my-es-cluster.eu-west-1.es.amazonaws.com\",\"type\":\"string\"}}},{\"type\":\"object\",\"properties\":{\"ssl\":{\"type\":\"object\",\"properties\":{\"rejectUnauthorized\":{\"description\":\"If true the server will reject any connection which is not\\nauthorized with the list of supplied CAs.\",\"default\":true,\"type\":\"boolean\"}}},\"node\":{\"description\":\"Node configuration.\\nURL/URLS to ElasticSearch node to connect to.\\nEither direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'\",\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"auth\":{\"description\":\"Authentication credentials for ElasticSearch\\nIf both ApiKey/Bearer token and username+password is provided, tokens take precedence\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"}}},{\"type\":\"object\",\"properties\":{\"apiKey\":{\"description\":\"Base64 Encoded API key to be used to connect to the cluster.\\nSee: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html\",\"type\":\"string\"}}}]}}},{\"type\":\"object\",\"properties\":{\"ssl\":{\"type\":\"object\",\"properties\":{\"rejectUnauthorized\":{\"description\":\"If true the server will reject any connection which is not\\nauthorized with the list of supplied CAs.\",\"default\":true,\"type\":\"boolean\"}}},\"provider\":{\"type\":\"string\",\"enum\":[\"opensearch\"]},\"node\":{\"description\":\"Node configuration.\\nURL/URLS to OpenSearch node to connect to.\\nEither direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'\",\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},\"auth\":{\"description\":\"Authentication credentials for OpenSearch\\nIf both ApiKey/Bearer token and username+password is provided, tokens take precedence\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"}}},{\"type\":\"object\",\"properties\":{\"apiKey\":{\"type\":\"string\"}}}]}}}]}}},\"pg\":{\"description\":\"Options for PG\",\"type\":\"object\",\"properties\":{\"highlightOptions\":{\"description\":\"Options for configuring highlight settings\\nSee https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-HEADLINE\",\"type\":\"object\",\"properties\":{\"useHighlight\":{\"description\":\"Used to enable to disable the highlight feature. The default value is true\",\"type\":\"boolean\"},\"maxWords\":{\"description\":\"Used to set the longest headlines to output. The default value is 35.\",\"type\":\"number\"},\"minWords\":{\"description\":\"Used to set the shortest headlines to output. The default value is 15.\",\"type\":\"number\"},\"shortWord\":{\"description\":\"Words of this length or less will be dropped at the start and end of a headline, unless they are query terms.\\nThe default value of three (3) eliminates common English articles.\",\"type\":\"number\"},\"highlightAll\":{\"description\":\"If true the whole document will be used as the headline, ignoring the preceding three parameters. The default is false.\",\"type\":\"boolean\"},\"maxFragments\":{\"description\":\"Maximum number of text fragments to display. The default value of zero selects a non-fragment-based headline generation method.\\nA value greater than zero selects fragment-based headline generation (see the linked documentation above for more details).\",\"type\":\"number\"},\"fragmentDelimiter\":{\"description\":\"Delimiter string used to concatenate fragments. Defaults to \\\" ... \\\".\",\"type\":\"string\"}}},\"indexerBatchSize\":{\"description\":\"Batch size to use when indexing\",\"type\":\"number\"}}}}},\"sentry\":{\"description\":\"Configuration options for the sentry plugin\",\"type\":\"object\",\"properties\":{\"organization\":{\"description\":\"The 'organization' attribute\",\"type\":\"string\"}}},\"sonarqube\":{\"description\":\"Optional configurations for the SonarQube plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base url of the sonarqube installation. Defaults to https://sonarcloud.io.\",\"type\":\"string\"},\"externalBaseUrl\":{\"description\":\"The external url of the sonarqube installation.\\nUse this if you want to use a different url for the frontend than the backend.\",\"type\":\"string\"},\"apiKey\":{\"description\":\"The api key to access the sonarqube instance under baseUrl.\",\"type\":\"string\"},\"instances\":{\"description\":\"The optional sonarqube instances.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The name of the sonarqube instance.\",\"type\":\"string\"},\"baseUrl\":{\"description\":\"The base url of the sonarqube instance.\",\"type\":\"string\"},\"externalBaseUrl\":{\"description\":\"The external url of the sonarqube instance.\\nUse this if you want to use a different url for the frontend than the backend.\",\"type\":\"string\"},\"apiKey\":{\"description\":\"The api key to access the sonarqube instance.\",\"type\":\"string\"}}}}}},\"splunkOnCall\":{\"description\":\"Splunk On Call Plugin specific configs\",\"type\":\"object\",\"properties\":{\"eventsRestEndpoint\":{\"type\":\"string\"}}},\"stackoverflow\":{\"description\":\"Configuration options for the stack overflow plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The base url of the Stack Overflow API used for the plugin\",\"type\":\"string\"},\"apiKey\":{\"description\":\"The API key to authenticate to Stack Overflow API\",\"type\":\"string\"},\"teamName\":{\"description\":\"The name of the team for a Stack Overflow for Teams account\",\"type\":\"string\"},\"apiAccessToken\":{\"description\":\"The API Access Token to authenticate to Stack Overflow API\",\"type\":\"string\"}}},\"stackstorm\":{\"type\":\"object\",\"properties\":{\"webUrl\":{\"description\":\"StackStorm Web UI url\\nUsed in links to StackStorm web UI\",\"type\":\"string\"}}},\"techdocs\":{\"description\":\"Configuration options for the techdocs plugin\",\"type\":\"object\",\"properties\":{\"builder\":{\"description\":\"Documentation building process depends on the builder attr\",\"enum\":[\"external\",\"local\"],\"type\":\"string\"},\"legacyUseCaseSensitiveTripletPaths\":{\"description\":\"Allows fallback to case-sensitive triplets in case of migration issues.\",\"type\":\"boolean\"},\"sanitizer\":{\"type\":\"object\",\"properties\":{\"allowedIframeHosts\":{\"description\":\"Allows iframe tag only for listed hosts\\nExample:\\n allowedIframeHosts: [\\\"example.com\\\"]\\n this will allow all iframes with the host `example.com` in the src attribute\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"generator\":{\"description\":\"Techdocs generator information\",\"type\":\"object\",\"properties\":{\"runIn\":{\"description\":\"Where to run the techdocs (mkdocs) generator\",\"enum\":[\"docker\",\"local\"],\"type\":\"string\"},\"dockerImage\":{\"description\":\"Override the default techdocs docker image\",\"type\":\"string\"},\"pullImage\":{\"description\":\"Pull the latest docker image\",\"type\":\"boolean\"},\"mkdocs\":{\"description\":\"Override behavior specific to mkdocs.\",\"type\":\"object\",\"properties\":{\"legacyCopyReadmeMdToIndexMd\":{\"description\":\"(Optional and not recommended) Configures the techdocs generator to\\nattempt to ensure an index.md exists falling back to using <docs-dir>/README.md\\nor README.md in case a default <docs-dir>/index.md is not provided.\\nNote that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior\\nwill be broken in these scenarios.\",\"type\":\"boolean\"},\"defaultPlugins\":{\"description\":\"List of mkdocs plugins which should be added as default to all mkdocs.yml files.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}},\"publisher\":{\"description\":\"Techdocs publisher information\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"type\":{\"enum\":[\"awsS3\",\"azureBlobStorage\",\"googleGcs\",\"local\",\"openStackSwift\"],\"type\":\"string\"},\"local\":{\"type\":\"object\",\"properties\":{\"publishDirectory\":{\"description\":\"Directory to store generated static files.\",\"type\":\"string\"}}}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"awsS3\"]},\"awsS3\":{\"description\":\"Required when 'type' is set to awsS3\",\"type\":\"object\",\"properties\":{\"accountId\":{\"description\":\"(Optional) The AWS account ID where the storage bucket is located.\\nCredentials for the account ID will be sourced from the 'aws' app config section.\\nSee the\\n[integration-aws-node package](https://github.com/backstage/backstage/blob/master/packages/integration-aws-node/README.md)\\nfor details on how to configure the credentials in the app config.\\nIf account ID is not set and no credentials are set, environment variables or aws config file will be used to authenticate.\",\"type\":\"string\"},\"credentials\":{\"description\":\"(Optional) Credentials used to access a storage bucket.\\nThis section is now deprecated. Configuring the account ID is now preferred, with credentials in the 'aws'\\napp config section.\\nIf not set and no account ID is set, environment variables or aws config file will be used to authenticate.\",\"type\":\"object\",\"properties\":{\"accessKeyId\":{\"description\":\"User access key id\",\"type\":\"string\"},\"secretAccessKey\":{\"description\":\"User secret access key\",\"type\":\"string\"},\"roleArn\":{\"description\":\"ARN of role to be assumed\",\"type\":\"string\"}}},\"bucketName\":{\"description\":\"(Required) Cloud Storage Bucket Name\",\"type\":\"string\"},\"region\":{\"description\":\"(Optional) AWS Region.\\nIf not set, AWS_REGION environment variable or aws config file will be used.\",\"type\":\"string\"},\"endpoint\":{\"description\":\"(Optional) AWS Endpoint.\\nThe endpoint URI to send requests to. The default endpoint is built from the configured region.\",\"type\":\"string\"},\"s3ForcePathStyle\":{\"description\":\"(Optional) Whether to use path style URLs when communicating with S3.\\nDefaults to false.\\nThis allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used to host tech docs.\",\"type\":\"boolean\"},\"sse\":{\"description\":\"(Optional) AWS Server Side Encryption\\nDefaults to undefined.\\nIf not set, encrypted buckets will fail to publish.\\nhttps://docs.aws.amazon.com/AmazonS3/latest/userguide/specifying-s3-encryption.html\",\"enum\":[\"AES256\",\"aws:kms\"],\"type\":\"string\"}}}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"openStackSwift\"]},\"openStackSwift\":{\"description\":\"Required when 'type' is set to openStackSwift\",\"type\":\"object\",\"properties\":{\"credentials\":{\"description\":\"(Required) Credentials used to access a storage bucket.\",\"type\":\"object\",\"properties\":{\"id\":{\"description\":\"(Required) Application Credential ID\",\"type\":\"string\"},\"secret\":{\"description\":\"(Required) Application Credential Secret\",\"type\":\"string\"}}},\"containerName\":{\"description\":\"(Required) Cloud Storage Container Name\",\"type\":\"string\"},\"authUrl\":{\"description\":\"(Required) Auth url sometimes OpenStack uses different port check your OpenStack apis.\",\"type\":\"string\"},\"swiftUrl\":{\"description\":\"(Required) Swift URL\",\"type\":\"string\"}}}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"azureBlobStorage\"]},\"azureBlobStorage\":{\"description\":\"Required when 'type' is set to azureBlobStorage\",\"type\":\"object\",\"properties\":{\"connectionString\":{\"description\":\"(Optional) Connection string of the storage container.\",\"type\":\"string\"},\"credentials\":{\"description\":\"(Optional) Credentials used to access a storage container.\",\"type\":\"object\",\"properties\":{\"accountName\":{\"description\":\"Account access name\",\"type\":\"string\"},\"accountKey\":{\"description\":\"(Optional) Account secret primary key\\nIf not set, environment variables will be used to authenticate.\",\"type\":\"string\"}}},\"containerName\":{\"description\":\"(Required) Cloud Storage Container Name\",\"type\":\"string\"}}}}},{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"googleGcs\"]},\"googleGcs\":{\"description\":\"Required when 'type' is set to googleGcs\",\"type\":\"object\",\"properties\":{\"bucketName\":{\"description\":\"(Required) Cloud Storage Bucket Name\",\"type\":\"string\"},\"credentials\":{\"description\":\"(Optional) API key used to write to a storage bucket.\\nIf not set, environment variables will be used to authenticate.\",\"type\":\"string\"},\"projectId\":{\"description\":\"(Optional) GCP project ID that contains the bucket. Should be\\nset if credentials is not set, or if the service account in\\nthe credentials belongs to a different project to the bucket.\",\"type\":\"string\"}}}}}]},\"cache\":{\"type\":\"object\",\"properties\":{\"ttl\":{\"description\":\"The cache time-to-live for TechDocs sites (in milliseconds). Set this\\nto a non-zero value to cache TechDocs sites and assets as they are\\nread from storage.\\n\\nNote: you must also configure `backend.cache` appropriately as well,\\nand to pass a PluginCacheManager instance to TechDocs Backend's\\ncreateRouter method in your backend.\",\"type\":\"number\"},\"readTimeout\":{\"description\":\"The time (in milliseconds) that the TechDocs backend will wait for\\na cache service to respond before continuing on as though the cached\\nobject was not found (e.g. when the cache sercice is unavailable).\\n\\nDefaults to 1000 milliseconds.\",\"type\":\"number\"}}}}},\"vault\":{\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The baseUrl for your Vault instance.\",\"type\":\"string\"},\"publicUrl\":{\"description\":\"The publicUrl for your Vault instance (Optional).\",\"type\":\"string\"},\"token\":{\"description\":\"The token used by Backstage to access Vault.\",\"type\":\"string\"},\"secretEngine\":{\"description\":\"The secret engine name where in vault. Defaults to `secrets`.\",\"type\":\"string\"},\"kvVersion\":{\"description\":\"The version of the K/V API. Defaults to `2`.\",\"enum\":[1,2],\"type\":\"number\"}}},\"scorecards\":{\"description\":\"Extra configuration for score card plugin\",\"type\":\"object\",\"properties\":{\"jsonDataUrl\":{\"description\":\"The public absolute root URL with json file defining the score card entries.\",\"type\":\"string\"},\"wikiLinkTemplate\":{\"description\":\"The template for the link to the wiki, e.g. \\\"https://TBD/XXX/_wiki/wikis/XXX.wiki/{id}\\\"\",\"type\":\"string\"}}},\"travisci\":{\"description\":\"Configuration options for the travisci plugin\",\"type\":\"object\",\"properties\":{\"baseUrl\":{\"description\":\"The 'baseUrl' attribute. It should point to the address of the travis portal.\\nIf not provided, frontend plugin will use 'https://travis-ci.com/'\",\"type\":\"string\"}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Application Configuration Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/app-config.json","title":"Application Configuration Schema","type":"object","description":"This is the schema describing the structure of the app-config.yaml configuration file.","properties":{"app":{"type":"object","description":"Generic frontend configuration.","properties":{"baseUrl":{"type":"string","description":"The public absolute root URL that the frontend."},"title":{"type":"string","description":"The title of the app, as shown in the Backstage web interface."},"datadogRum":{"type":"object","description":"Datadog RUM events configuration","properties":{"env":{"type":"string","description":"Environment for Datadog RUM events"},"clientToken":{"type":"string","description":"clientToken for Datadog RUM events"},"applicationId":{"type":"string","description":"applicationId for Datadog RUM events"},"site":{"type":"string","description":"site for Datadog RUM events"}}},"listen":{"type":"object","description":"Listening configuration for local development","properties":{"host":{"type":"string","description":"The host that the frontend should be bound to. Only used for local development."},"port":{"type":"number","description":"The port that the frontend should be bound to. Only used for local development."}}},"https":{"type":"object","description":"Only used for local development. The https object is passed to webpack in order to enable using https on localhost.","properties":{"certificate":{"type":"object","description":"Parent object containing certificate and the private key","properties":{"key":{"type":"string","description":"Https Certificate private key. Use $file to load in a file"},"cert":{"type":"string","description":"Https Certificate. Use $file to load in a file"}}}}},"support":{"description":"Information about support of this Backstage instance and how to contact the integrator team.","type":"object","properties":{"url":{"description":"The primary support url.","type":"string"},"items":{"description":"A list of categorized support item groupings.","type":"array","items":{"type":"object","properties":{"title":{"description":"The title of the support item grouping.","type":"string"},"icon":{"description":"An optional icon for the support item grouping.","type":"string"},"links":{"description":"A list of support links for the Backstage instance inside this grouping.","type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"title":{"type":"string"}}}}}}}}},"extensions":{"type":"array","items":{"anyOf":[{"type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"attachTo":{"type":"object","properties":{"id":{"type":"string"},"input":{"type":"string"}}},"disabled":{"type":"boolean"},"config":{}}},{"type":"boolean"}]}},{"type":"string"}]}},"analytics":{"type":"object","properties":{"ga":{"type":"object","properties":{"trackingId":{"description":"Google Analytics tracking ID, e.g. UA-000000-0","type":"string"},"scriptSrc":{"description":"URL to Google Analytics analytics.js script\nDefaults to fetching from GA source (eg. https://www.google-analytics.com/analytics.js)","type":"string"},"identity":{"description":"Controls how the identityApi is used when sending data to GA:\n\n- `disabled`: (Default) Explicitly prevents a user's identity from\n being used when capturing events in GA.\n- `optional`: Pageviews and hits are forwarded to GA as they happen\n and only include user identity metadata once known. Guarantees\n that hits are captured for all sessions, even if no sign in\n occurs, but may result in dropped hits in User ID views.\n- `required`: All pageviews and hits are deferred until an identity\n is known. Guarantees that all data sent to GA correlates to a user\n identity, but prevents GA from receiving events for sessions in\n which a user does not sign in. An `identityApi` instance must be\n passed during instantiation when set to this value.","enum":["disabled","optional","required"],"type":"string"},"virtualSearchPageView":{"description":"Controls whether to send virtual pageviews on `search` events.\nCan be used to enable Site Search in GA.","type":"object","properties":{"mode":{"description":"- `disabled`: (Default) no virtual pageviews are sent\n- `only`: Sends virtual pageview _instead_ of the `search` event\n- `both`: Sends both the `search` event _and_ the virtual pageview","enum":["both","disabled","only"],"type":"string"},"mountPath":{"description":"Specifies on which path the main Search page is mounted.\nDefaults to `/search`.","type":"string"},"searchQuery":{"description":"Specifies which query param is used for the term query in the virtual pageview URL.\nDefaults to `query`.","type":"string"},"categoryQuery":{"description":"Specifies which query param is used for the category query in the virtual pageview URL.\nSkipped by default.","type":"string"}}},"debug":{"description":"Whether or not to log analytics debug statements to the console.\nDefaults to false.","type":"boolean"},"testMode":{"description":"Prevents events from actually being sent when set to true. Defaults\nto false.","type":"boolean"},"customDimensionsMetrics":{"description":"Configuration informing how Analytics Context and Event Attributes\nmetadata will be captured in Google Analytics.","type":"array","items":{"type":"object","properties":{"type":{"description":"Specifies whether the corresponding metadata should be collected\nas a Google Analytics custom dimension or custom metric.","enum":["dimension","metric"],"type":"string"},"index":{"description":"The index of the Google Analytics custom dimension or metric that\nthe metadata should be written to.","type":"number"},"source":{"description":"Specifies whether the desired value lives as an attribute on the\nAnalytics Context or the Event's Attributes.","enum":["attributes","context"],"type":"string"},"key":{"description":"The property of the context or attributes that should be captured.\ne.g. to capture the Plugin ID associated with an event, the source\nshould be set to \"context\" and the key should be set to pluginId.","type":"string"}}}}}},"ga4":{"type":"object","properties":{"measurementId":{"description":"Google Analytics measurement ID, e.g. G-000000-0","type":"string"},"identity":{"description":"Controls how the identityApi is used when sending data to GA:\n\n- `disabled`: (Default) Explicitly prevents a user's identity from\n being used when capturing events in GA.\n- `optional`: Pageviews and hits are forwarded to GA as they happen\n and only include user identity metadata once known. Guarantees\n that hits are captured for all sessions, even if no sign in\n occurs, but may result in dropped hits in User ID views.\n- `required`: All pageviews and hits are deferred until an identity\n is known. Guarantees that all data sent to GA correlates to a user\n identity, but prevents GA from receiving events for sessions in\n which a user does not sign in. An `identityApi` instance must be\n passed during instantiation when set to this value.","enum":["disabled","optional","required"],"type":"string"},"debug":{"description":"Whether to log analytics debug statements to the console.\nDefaults to false.","type":"boolean"},"testMode":{"description":"Prevents events from actually being sent when set to true. Defaults\nto false.","type":"boolean"},"contentGrouping":{"description":"Content grouping definition\nFeature available in Google Analytics 4\nMore information https://support.google.com/analytics/answer/11523339?hl=en\nData can be grouped by pluginId, routeRef\nTakes 24 hours before metrics shows up in GA dashboard\nSpecifies the dimension to be used for content grouping\nCan be one of pluginId, extension or routeRef","enum":["extension","pluginId","routeRef"],"type":"string"},"allowedContexts":{"description":"Configuration informing how Analytics Context and Event Attributes\nmetadata will be captured in Google Analytics.\nContexts that will be sent as parameters in the event.\ncontext-name will be prefixed by c_, for example, pluginId will be c_pluginId in the event.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"array","items":[{"type":"string","enum":["*"]}],"minItems":1,"maxItems":1}]},"allowedAttributes":{"description":"Attributes that will be sent as parameters in the event\nattribute-name will be prefixed by a_, for example , testAttribute will be c_testAttribute in the event.","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"array","items":[{"type":"string","enum":["*"]}],"minItems":1,"maxItems":1}]}}},"newRelic":{"type":"object","properties":{"endpoint":{"description":"Data ingestion endpoint to use, either bam.eu01.nr-data.net (EU) or bam.nr-data.net (US)","enum":["bam.eu01.nr-data.net","bam.nr-data.net"],"type":"string"},"accountId":{"description":"New Relic Account ID, e.g. 1234567","type":"string"},"applicationId":{"description":"New Relic Application ID, e.g. 987654321","type":"string"},"licenseKey":{"description":"New Relic License Key, e.g. NRJS-12a3456bc78de9123f4","type":"string"},"distributedTracingEnabled":{"description":"Whether to enabled distributed tracing, defaults to false","type":"boolean"},"cookiesEnabled":{"description":"Whether to enabled tracing of cookies, defaults to false","type":"boolean"}}}}},"packageName":{"description":"The name of the app package (in most Backstage repositories, this is the\n\"name\" field in `packages/app/package.json`) that content should be served\nfrom. The same app package should be added as a dependency to the backend\npackage in order for it to be accessible at runtime.\n\nIn a typical setup with a single app package, this will default to 'app'.","type":"string"},"disableConfigInjection":{"description":"Disables the configuration injection. This can be useful if you're running in an environment\nwith a read-only filesystem, or for some other reason don't want configuration to be injected.\n\nNote that this will cause the configuration used when building the app bundle to be used, unless\na separate configuration loading strategy is set up.\n\nThis also disables configuration injection though `APP_CONFIG_` environment variables.","type":"boolean"},"disableStaticFallbackCache":{"description":"By default the app backend plugin will cache previously deployed static assets in the database.\nIf you disable this, it is recommended to set a `staticFallbackHandler` instead.","type":"boolean"}}},"allure":{"type":"object","properties":{"baseUrl":{"type":"string"}}},"firehydrant":{"type":"object","properties":{"baseUrl":{"type":"string"}}},"lighthouse":{"type":"object","properties":{"baseUrl":{"type":"string"}}},"nomad":{"type":"object","properties":{"addr":{"type":"string","description":"The address of the Nomad API. See: https://developer.hashicorp.com/nomad/api-docs#addressing-and-ports"},"token":{"type":"string","description":"The token to call the Nomad API with. See: https://developer.hashicorp.com/nomad/api-docs#authentication"}}},"auth":{"type":"object","description":"Configuration that provides information on available configured authentication providers.","properties":{"providers":{"type":"object","description":"The available auth-provider options and attributes","additionalProperties":{"type":"object","additionalProperties":true},"properties":{"google":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"callbackUrl":{"type":"string"}}}},"github":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"callbackUrl":{"type":"string"},"enterpriseInstanceUrl":{"type":"string"}}}},"saml":{"type":"object","properties":{"entryPoint":{"type":"string"},"logoutUrl":{"type":"string"},"issuer":{"type":"string"},"cert":{"type":"string"},"audience":{"type":"string"},"privateKey":{"type":"string"},"authnContext":{"type":"array","items":{"type":"string"}},"identifierFormat":{"type":"string"},"decryptionPvk":{"type":"string"},"signatureAlgorithm":{"enum":["sha256","sha512"],"type":"string"},"digestAlgorithm":{"type":"string"},"acceptedClockSkewMs":{"type":"number"}}},"okta":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"audience":{"type":"string"},"authServerId":{"type":"string"},"idp":{"type":"string"},"callbackUrl":{"type":"string"}}}},"oauth2":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"authorizationUrl":{"type":"string"},"tokenUrl":{"type":"string"},"scope":{"type":"string"},"disableRefresh":{"type":"boolean"},"includeBasicAuth":{"type":"boolean"}}}},"oidc":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"callbackUrl":{"type":"string"},"metadataUrl":{"type":"string"},"tokenEndpointAuthMethod":{"type":"string"},"tokenSignedResponseAlg":{"type":"string"},"scope":{"type":"string"},"prompt":{"type":"string"}}}},"auth0":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"domain":{"type":"string"},"callbackUrl":{"type":"string"},"audience":{"type":"string"},"connection":{"type":"string"},"connectionScope":{"type":"string"}}}},"microsoft":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"tenantId":{"type":"string"},"callbackUrl":{"type":"string"}}}},"onelogin":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"issuer":{"type":"string"},"callbackUrl":{"type":"string"}}}},"awsalb":{"type":"object","properties":{"iss":{"type":"string"},"region":{"type":"string"}}},"cfaccess":{"type":"object","properties":{"teamName":{"type":"string"}}},"gcpIap":{"description":"Configuration for the Google Cloud Platform Identity-Aware Proxy (IAP) auth provider.","type":"object","additionalProperties":{"type":"object","properties":{"audience":{"description":"The audience to use when validating incoming JWT tokens.\nSee https://backstage.io/docs/auth/google/gcp-iap-auth","type":"string"},"jwtHeader":{"description":"The name of the header to read the JWT token from, defaults to `'x-goog-iap-jwt-assertion'`.","type":"string"}}}},"gitlab":{"type":"object","additionalProperties":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"audience":{"type":"string"},"callbackUrl":{"type":"string"}}}}}},"environment":{"description":"The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.\ndefault value: 'development'\noptional values: 'development' | 'production'","type":"string"},"session":{"type":"object","properties":{"secret":{"description":"The secret attribute of session object.","type":"string"}}},"identityTokenAlgorithm":{"description":"JWS \"alg\" (Algorithm) Header Parameter value. Defaults to ES256.\nMust match one of the algorithms defined for IdentityClient.\nWhen setting a different algorithm, check if the `key` field\nof the `signing_keys` table can fit the length of the generated keys.\nIf not, add a knex migration file in the migrations folder.\nMore info on supported algorithms: https://github.com/panva/jose","type":"string"},"keyStore":{"description":"To control how to store JWK data in auth-backend","type":"object","properties":{"provider":{"enum":["database","firestore","memory"],"type":"string"},"firestore":{"type":"object","properties":{"host":{"description":"The host to connect to","type":"string"},"port":{"description":"The port to connect to","type":"number"},"ssl":{"description":"Whether to use SSL when connecting.","type":"boolean"},"projectId":{"description":"The Google Cloud Project ID","type":"string"},"keyFilename":{"description":"Local file containing the Service Account credentials.\nYou can omit this value to automatically read from\nGOOGLE_APPLICATION_CREDENTIALS env which is useful for local\ndevelopment.","type":"string"},"path":{"description":"The path to use for the collection. Defaults to 'sessions'","type":"string"},"timeout":{"description":"Timeout used for database operations. Defaults to 10000ms","type":"number"}}}}}}},"backend":{"type":"object","description":"Generic backend configuration.","properties":{"auth":{"description":"Backend configuration for when request authentication is enabled","type":"object","properties":{"keys":{"description":"Keys shared by all backends for signing and validating backend tokens.","type":"array","items":{"type":"object","properties":{"secret":{"description":"Secret for generating tokens. Should be a base64 string, recommended\nlength is 24 bytes.","type":"string"}}}}}},"baseUrl":{"type":"string","description":"The public absolute root URL that the backend is reachable at, from the browser's perspective."},"listen":{"description":"Address that the backend should listen to.","anyOf":[{"type":"object","properties":{"host":{"description":"Address of the interface that the backend should bind to.","type":"string"},"port":{"description":"Port that the backend should listen to.","anyOf":[{"type":"number"},{"type":"string"}]}}},{"type":"string"}]},"https":{"description":"HTTPS configuration for the backend. If omitted the backend will serve HTTP.\n\nSetting this to `true` will cause self-signed certificates to be generated, which\ncan be useful for local development or other non-production scenarios.","anyOf":[{"type":"object","properties":{"certificate":{"description":"Certificate configuration","type":"object","properties":{"cert":{"description":"PEM encoded certificate. Use $file to load in a file","type":"string"},"key":{"description":"PEM encoded certificate key. Use $file to load in a file.","type":"string"}}}}},{"enum":[true],"type":"boolean"}]},"database":{"description":"Database connection configuration, select base database type using the `client` field","type":"object","properties":{"client":{"description":"Default database client to use","enum":["better-sqlite3","pg","sqlite3"],"type":"string"},"connection":{"description":"Base database connection string, or object with individual connection properties","anyOf":[{"type":"object","additionalProperties":{},"properties":{"password":{"description":"Password that belongs to the client User","type":"string"}}},{"type":"string"}]},"prefix":{"description":"Database name prefix override","type":"string"},"ensureExists":{"description":"Whether to ensure the given database exists by creating it if it does not.\nDefaults to true if unspecified.","type":"boolean"},"pluginDivisionMode":{"description":"How plugins databases are managed/divided in the provided database instance.\n\n`database` -> Plugins are each given their own database to manage their schemas/tables.\n\n`schema` -> Plugins will be given their own schema (in the specified/default database)\n to manage their tables.\n\nNOTE: Currently only supported by the `pg` client.","default":"database","enum":["database","schema"],"type":"string"},"role":{"description":"Configures the ownership of newly created schemas in pg databases.","type":"string"},"knexConfig":{"description":"Arbitrary config object to pass to knex when initializing\n(https://knexjs.org/#Installation-client). Most notable is the debug\nand asyncStackTraces booleans","type":"object","additionalProperties":true},"plugin":{"description":"Plugin specific database configuration and client override","type":"object","additionalProperties":{"type":"object","properties":{"client":{"description":"Database client override","enum":["better-sqlite3","pg","sqlite3"],"type":"string"},"connection":{"description":"Database connection string or Knex object override","anyOf":[{"type":"object","properties":{},"additionalProperties":true},{"type":"string"}]},"ensureExists":{"description":"Whether to ensure the given database exists by creating it if it does not.\nDefaults to base config if unspecified.","type":"boolean"},"knexConfig":{"description":"Arbitrary config object to pass to knex when initializing\n(https://knexjs.org/#Installation-client). Most notable is the\ndebug and asyncStackTraces booleans.\n\nThis is merged recursively into the base knexConfig","type":"object","additionalProperties":true},"role":{"description":"Configures the ownership of newly created schemas in pg databases.","type":"string"}}}}}},"cache":{"description":"Cache connection configuration, select cache type using the `store` field","anyOf":[{"type":"object","properties":{"store":{"type":"string","enum":["memory"]}}},{"type":"object","properties":{"store":{"type":"string","enum":["redis"]},"connection":{"description":"A redis connection string in the form `redis://user:pass@host:port`.","type":"string"}}},{"type":"object","properties":{"store":{"type":"string","enum":["memcache"]},"connection":{"description":"A memcache connection string in the form `user:pass@host:port`.","type":"string"}}}]},"cors":{"type":"object","properties":{"origin":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"methods":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"allowedHeaders":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"exposedHeaders":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"credentials":{"type":"boolean"},"maxAge":{"type":"number"},"preflightContinue":{"type":"boolean"},"optionsSuccessStatus":{"type":"number"}}},"reading":{"description":"Configuration related to URL reading, used for example for reading catalog info\nfiles, scaffolder templates, and techdocs content.","type":"object","properties":{"allow":{"description":"A list of targets to allow outgoing requests to. Users will be able to make\nrequests on behalf of the backend to the targets that are allowed by this list.","type":"array","items":{"type":"object","properties":{"host":{"description":"A host to allow outgoing requests to, being either a full host or\na subdomain wildcard pattern with a leading `*`. For example `example.com`\nand `*.example.com` are valid values, `prod.*.example.com` is not.\nThe host may also contain a port, for example `example.com:8080`.","type":"string"},"paths":{"description":"An optional list of paths. In case they are present only targets matching\nany of them will are allowed. You can use trailing slashes to make sure only\nsubdirectories are allowed, for example `/mydir/` will allow targets with\npaths like `/mydir/a` but will block paths like `/mydir2`.","type":"array","items":{"type":"string"}}}}}}},"csp":{"description":"Content Security Policy options.\n\nThe keys are the plain policy ID, e.g. \"upgrade-insecure-requests\". The\nvalues are on the format that the helmet library expects them, as an\narray of strings. There is also the special value false, which means to\nremove the default value that Backstage puts in place for that policy.","type":"object","additionalProperties":{"anyOf":[{"type":"array","items":{"type":"string"}},{"enum":[false],"type":"boolean"}]}}}},"discovery":{"description":"Discovery options.","type":"object","properties":{"endpoints":{"description":"Endpoints\n\nA list of target baseUrls and the associated plugins.","type":"array","items":{"type":"object","properties":{"target":{"description":"The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys.\nTargets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.","anyOf":[{"type":"object","properties":{"external":{"type":"string"},"internal":{"type":"string"}}},{"type":"string"}]},"plugins":{"description":"Array of plugins which use the target baseUrl.","type":"array","items":{"type":"string"}}}}}}},"organization":{"description":"Configuration that provides information about the organization that the app is for.","type":"object","properties":{"name":{"description":"The name of the organization that the app belongs to.","type":"string"}}},"homepage":{"description":"This config was used by the HomepageTimer but has been replaced by the HeaderWorldClock in the home plugin","deprecated":"in favor of the HeaderWorldClock which is found in the home plugin","type":"object","properties":{"clocks":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"timezone":{"type":"string"}}}}}},"enableExperimentalRedirectFlow":{"description":"Enable redirect authentication flow type, instead of a popup for authentication.","type":"boolean"},"integrations":{"description":"Configuration for integrations towards various external repository provider systems","type":"object","properties":{"azure":{"description":"Integration configuration for Azure","type":"array","items":{"type":"object","properties":{"host":{"description":"The hostname of the given Azure instance","type":"string"},"token":{"description":"Token used to authenticate requests.","deprecated":"Use `credentials` instead.","type":"string"},"credential":{"description":"The credential to use for requests.\n\nIf no credential is specified anonymous access is used.","deprecated":"Use `credentials` instead.","type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"tenantId":{"type":"string"},"personalAccessToken":{"type":"string"}}},"credentials":{"description":"The credentials to use for requests. If multiple credentials are specified the first one that matches the organization is used.\nIf not organization matches the first credential without an organization is used.\n\nIf no credentials are specified at all, either a default credential (for Azure DevOps) or anonymous access (for Azure DevOps Server) is used.","type":"array","items":{"type":"object","properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"tenantId":{"type":"string"},"personalAccessToken":{"type":"string"}}}}}}},"bitbucket":{"description":"Integration configuration for Bitbucket","deprecated":"replaced by bitbucketCloud and bitbucketServer","type":"array","items":{"type":"object","properties":{"host":{"description":"The hostname of the given Bitbucket instance","type":"string"},"token":{"description":"Token used to authenticate requests.","type":"string"},"apiBaseUrl":{"description":"The base url for the Bitbucket API, for example https://api.bitbucket.org/2.0","type":"string"},"username":{"description":"The username to use for authenticated requests.","type":"string"},"appPassword":{"description":"Bitbucket app password used to authenticate requests.","type":"string"}}}},"bitbucketCloud":{"description":"Integration configuration for Bitbucket Cloud","type":"array","items":{"type":"object","properties":{"username":{"description":"The username to use for authenticated requests.","type":"string"},"appPassword":{"description":"Bitbucket Cloud app password used to authenticate requests.","type":"string"}}}},"bitbucketServer":{"description":"Integration configuration for Bitbucket Server","type":"array","items":{"type":"object","properties":{"host":{"description":"The hostname of the given Bitbucket Server instance","type":"string"},"token":{"description":"Token used to authenticate requests.","type":"string"},"username":{"description":"Username used to authenticate requests with Basic Auth.","type":"string"},"password":{"description":"Password (or token as password) used to authenticate requests with Basic Auth.","type":"string"},"apiBaseUrl":{"description":"The base url for the Bitbucket Server API, for example https://<host>/rest/api/1.0","type":"string"}}}},"gerrit":{"description":"Integration configuration for Gerrit","type":"array","items":{"type":"object","properties":{"host":{"description":"The hostname of the given Gerrit instance","type":"string"},"baseUrl":{"description":"The base url for the Gerrit instance.","type":"string"},"cloneUrl":{"description":"The base url for cloning repos.","type":"string"},"username":{"description":"The username to use for authenticated requests.","type":"string"},"password":{"description":"Gerrit password used to authenticate requests. This can be either a password\nor a generated access token.","type":"string"}}}},"github":{"description":"Integration configuration for GitHub","type":"array","items":{"type":"object","properties":{"host":{"description":"The hostname of the given GitHub instance","type":"string"},"token":{"description":"Token used to authenticate requests.","type":"string"},"apiBaseUrl":{"description":"The base url for the GitHub API, for example https://api.github.com","type":"string"},"rawBaseUrl":{"description":"The base url for GitHub raw resources, for example https://raw.githubusercontent.com","type":"string"},"apps":{"description":"GitHub Apps configuration","type":"array","items":{"type":"object","properties":{"appId":{"description":"The numeric GitHub App ID, string for environment variables","anyOf":[{"type":"number"},{"type":"string"}]},"privateKey":{"description":"The private key to use for auth against the app","type":"string"},"webhookSecret":{"description":"The secret used for webhooks","type":"string"},"clientId":{"description":"The client ID to use","type":"string"},"clientSecret":{"description":"The client secret to use","type":"string"},"allowedInstallationOwners":{"description":"List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations.\nHowever you can list the installations with the GitHub API. You can find the list of installations here:\nhttps://api.github.com/app/installations\nThe relevant documentation for this is here.\nhttps://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples","type":"array","items":{"type":"string"}}}}}}}},"gitlab":{"description":"Integration configuration for GitLab","type":"array","items":{"type":"object","properties":{"host":{"description":"The host of the target that this matches on, e.g. \"gitlab.com\".","type":"string"},"apiBaseUrl":{"description":"The base URL of the API of this provider, e.g.\n\"https://gitlab.com/api/v4\", with no trailing slash.\n\nMay be omitted specifically for public GitLab; then it will be deduced.","type":"string"},"token":{"description":"The authorization token to use for requests to this provider.\n\nIf no token is specified, anonymous access is used.","type":"string"},"baseUrl":{"description":"The baseUrl of this provider, e.g. \"https://gitlab.com\", which is\npassed into the GitLab client.\n\nIf no baseUrl is provided, it will default to https://${host}.","type":"string"}}}},"googleGcs":{"description":"Integration configuration for Google Cloud Storage","type":"object","properties":{"clientEmail":{"description":"Service account email used to authenticate requests.","type":"string"},"privateKey":{"description":"Service account private key used to authenticate requests.","type":"string"}}},"awsS3":{"description":"Integration configuration for AWS S3 Service","type":"array","items":{"type":"object","properties":{"endpoint":{"description":"AWS Endpoint.\nThe endpoint URI to send requests to. The default endpoint is built from the configured region.","type":"string"},"s3ForcePathStyle":{"description":"Whether to use path style URLs when communicating with S3.\nDefaults to false.\nThis allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.","type":"boolean"},"accessKeyId":{"description":"Account access key used to authenticate requests.","type":"string"},"secretAccessKey":{"description":"Account secret key used to authenticate requests.","type":"string"},"roleArn":{"description":"ARN of the role to be assumed","type":"string"},"externalId":{"description":"External ID to use when assuming role","type":"string"}}}},"gitea":{"description":"Integration configuration for Gitea","type":"array","items":{"type":"object","properties":{"host":{"description":"The hostname of the given Gitea instance","type":"string"},"baseUrl":{"description":"The base url for the Gitea instance.","type":"string"},"username":{"description":"The username to use for authenticated requests.","type":"string"},"password":{"description":"Gitea password used to authenticate requests. This can be either a password\nor a generated access token.","type":"string"}}}}}},"aws":{"description":"Configuration for access to AWS accounts","type":"object","properties":{"accountDefaults":{"description":"Defaults for retrieving AWS account credentials","type":"object","properties":{"roleName":{"description":"The IAM role to assume to retrieve temporary AWS credentials","type":"string"},"partition":{"description":"The AWS partition of the IAM role, e.g. \"aws\", \"aws-cn\"","type":"string"},"region":{"description":"The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \"ap-northeast-1\"","type":"string"},"externalId":{"description":"The unique identifier needed to assume the role to retrieve temporary AWS credentials","type":"string"}}},"mainAccount":{"description":"Main account to use for retrieving AWS account credentials","type":"object","properties":{"accessKeyId":{"description":"The access key ID for a set of static AWS credentials","type":"string"},"secretAccessKey":{"description":"The secret access key for a set of static AWS credentials","type":"string"},"profile":{"description":"The configuration profile from a credentials file at ~/.aws/credentials and\na configuration file at ~/.aws/config.","type":"string"},"region":{"description":"The STS regional endpoint to use for the main account, e.g. \"ap-northeast-1\"","type":"string"}}},"accounts":{"description":"Configuration for retrieving AWS accounts credentials","type":"array","items":{"type":"object","properties":{"accountId":{"description":"The account ID of the target account that this matches on, e.g. \"123456789012\"","type":"string"},"accessKeyId":{"description":"The access key ID for a set of static AWS credentials","type":"string"},"secretAccessKey":{"description":"The secret access key for a set of static AWS credentials","type":"string"},"profile":{"description":"The configuration profile from a credentials file at ~/.aws/credentials and\na configuration file at ~/.aws/config.","type":"string"},"roleName":{"description":"The IAM role to assume to retrieve temporary AWS credentials","type":"string"},"partition":{"description":"The AWS partition of the IAM role, e.g. \"aws\", \"aws-cn\"","type":"string"},"region":{"description":"The STS regional endpoint to use when retrieving temporary AWS credentials, e.g. \"ap-northeast-1\"","type":"string"},"externalId":{"description":"The unique identifier needed to assume the role to retrieve temporary AWS credentials","type":"string"}}}}}},"airbrake":{"description":"Configuration options for the Airbrake plugin","type":"object","properties":{"apiKey":{"description":"The API Key to authenticate requests. More details on how to get this\nhere: https://airbrake.io/docs/api/#authentication","type":"string"}}},"apacheAirflow":{"description":"Configurations for the Apache Airflow plugin","type":"object","properties":{"baseUrl":{"description":"The base url of the Apache Airflow installation.","type":"string"}}},"azureDevOps":{"description":"Configuration options for the azure-devops-backend plugin","type":"object","properties":{"host":{"description":"The hostname of the given Azure instance","type":"string"},"token":{"description":"Token used to authenticate requests.","type":"string"},"organization":{"description":"The organization of the given Azure instance","type":"string"}}},"catalog":{"description":"Configuration options for the catalog plugin.","type":"object","properties":{"rules":{"description":"Rules to apply to all catalog entities, from any location.\n\nAn undefined list of matchers means match all, an empty list of\nmatchers means match none.\n\nThis is commonly used to put in what amounts to an allowlist of kinds\nthat regular users of Backstage are permitted to register locations\nfor. This can be used to stop them from registering yaml files\ndescribing for example a Group entity called \"admin\" that they make\nthemselves members of, or similar.","type":"array","items":{"type":"object","properties":{"allow":{"description":"Allow entities of these particular kinds.\n\nE.g. [\"Component\", \"API\", \"Template\", \"Location\"]","type":"array","items":{"type":"string"}},"locations":{"description":"Limit this rule to a specific location\n\nExample with a fixed location\n { \"type\": \"url\", \"exact\": \"https://github.com/a/b/blob/file.yaml\"}\n\nExample using a Regex\n { \"type\": \"url\", \"pattern\": \"https://github.com/org/*\\/blob/master/*.yaml\"}\n\nUsing both exact and pattern will result in an error starting the application","type":"array","items":{"type":"object","properties":{"type":{"description":"The type of location, e.g. \"url\".","type":"string"},"exact":{"description":"The exact location, e.g.\n\"https://github.com/org/repo/blob/master/users.yaml\".\n\nThe exact location can also be used to match on locations\nthat contain glob characters themselves, e.g.\n\"https://github.com/org/*\\/blob/master/*.yaml\".","type":"string"},"pattern":{"description":"The pattern allowed for the location, e.g.\n\"https://github.com/org/*\\/blob/master/*.yaml\".","type":"string"}}}}}}},"readonly":{"description":"Readonly defines whether the catalog allows writes after startup.\n\nSetting 'readonly=false' allows users to register their own components.\nThis is the default value.\n\nSetting 'readonly=true' configures catalog to only allow reads. This can\nbe used in combination with static locations to only serve operator\nprovided locations. Effectively this removes the ability to register new\ncomponents to a running backstage instance.","type":"boolean"},"locations":{"description":"A set of static locations that the catalog shall always keep itself\nup-to-date with. This is commonly used for large, permanent integrations\nthat are defined by the Backstage operators at an organization, rather\nthan individual things that users register dynamically.\n\nThese have (optional) rules of their own. These override what the global\nrules above specify. This way, you can prevent everybody from register\ne.g. User and Group entities, except for one or a few static locations\nthat have those two kinds explicitly allowed.\n\nFor example:\n\n```yaml\nrules:\n - allow: [Component, API, Template, Location]\nlocations:\n - type: url\n target: https://github.com/org/repo/blob/master/users.yaml\n rules:\n - allow: [User, Group]\n - type: url\n target: https://github.com/org/repo/blob/master/systems.yaml\n rules:\n - allow: [System]\n```","type":"array","items":{"type":"object","properties":{"type":{"description":"The type of location, e.g. \"url\".","type":"string"},"target":{"description":"The target URL of the location, e.g.\n\"https://github.com/org/repo/blob/master/users.yaml\".","type":"string"},"rules":{"description":"Optional extra rules that apply to this particular location.\n\nThese override the global rules above.","type":"array","items":{"type":"object","properties":{"allow":{"description":"Allow entities of these particular kinds.\n\nE.g. [\"Group\", \"User\"]","type":"array","items":{"type":"string"}}}}}}}},"orphanStrategy":{"description":"The strategy to use for entities that are orphaned, i.e. no longer have\nany other entities or providers referencing them. The default value is\n\"keep\".","enum":["delete","keep"],"type":"string"},"processingInterval":{"description":"The interval at which the catalog should process its entities."},"processors":{"type":"object","description":"List of processor-specific options and attributes","properties":{"awsOrganization":{"description":"AwsOrganizationCloudAccountProcessor configuration","type":"object","properties":{"provider":{"type":"object","properties":{"roleArn":{"description":"The role to be assumed by this processor","type":"string"}}}}},"githubMultiOrg":{"description":"GithubMultiOrgReaderProcessor configuration","type":"object","properties":{"orgs":{"description":"The configuration parameters for each GitHub org to process.","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the GitHub org to process.","type":"string"},"groupNamespace":{"description":"The namespace of the group created for this org.\n\nDefaults to org name if omitted.","type":"string"},"userNamespace":{"description":"The namespace of the users created from this org.\n\nDefaults to empty string if omitted.","type":"string"}}}}}},"ldapOrg":{"description":"LdapOrgReaderProcessor configuration","type":"object","properties":{"providers":{"description":"The configuration parameters for each single LDAP provider.","type":"array","items":{"type":"object","properties":{"target":{"description":"The prefix of the target that this matches on, e.g.\n\"ldaps://ds.example.net\", with no trailing slash.","type":"string"},"bind":{"description":"The settings to use for the bind command. If none are specified,\nthe bind command is not issued.","type":"object","properties":{"dn":{"description":"The DN of the user to auth as.\n\nE.g. \"uid=ldap-robot,ou=robots,ou=example,dc=example,dc=net\"","type":"string"},"secret":{"description":"The secret of the user to auth as (its password).","type":"string"}}},"tls":{"description":"TLS settings","type":"object","properties":{"rejectUnauthorized":{"type":"boolean"}}},"users":{"description":"The settings that govern the reading and interpretation of users.","type":"object","properties":{"dn":{"description":"The DN under which users are stored.\n\nE.g. \"ou=people,ou=example,dc=example,dc=net\"","type":"string"},"options":{"description":"The search options to use. The default is scope \"one\" and\nattributes \"*\" and \"+\".\n\nIt is common to want to specify a filter, to narrow down the set\nof matching items.","type":"object","properties":{"scope":{"enum":["base","one","sub"],"type":"string"},"filter":{"type":"string"},"attributes":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"sizeLimit":{"type":"number"},"timeLimit":{"type":"number"},"derefAliases":{"type":"number"},"typesOnly":{"type":"boolean"},"paged":{"anyOf":[{"type":"object","properties":{"pageSize":{"type":"number"},"pagePause":{"type":"boolean"}}},{"type":"boolean"}]}}},"set":{"description":"JSON paths (on a.b.c form) and hard coded values to set on those\npaths.\n\nThis can be useful for example if you want to hard code a\nnamespace or similar on the generated entities.","type":"object"},"map":{"description":"Mappings from well known entity fields, to LDAP attribute names","type":"object","properties":{"rdn":{"description":"The name of the attribute that holds the relative\ndistinguished name of each entry. Defaults to \"uid\".","type":"string"},"name":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.name field of the entity. Defaults to \"uid\".","type":"string"},"description":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.description field of the entity.","type":"string"},"displayName":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.displayName field of the entity. Defaults to\n\"cn\".","type":"string"},"email":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.email field of the entity. Defaults to\n\"mail\".","type":"string"},"picture":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.picture field of the entity.","type":"string"},"memberOf":{"description":"The name of the attribute that shall be used for the values of\nthe spec.memberOf field of the entity. Defaults to \"memberOf\".","type":"string"}}}}},"groups":{"description":"The settings that govern the reading and interpretation of groups.","type":"object","properties":{"dn":{"description":"The DN under which groups are stored.\n\nE.g. \"ou=people,ou=example,dc=example,dc=net\"","type":"string"},"options":{"description":"The search options to use. The default is scope \"one\" and\nattributes \"*\" and \"+\".\n\nIt is common to want to specify a filter, to narrow down the set\nof matching items.","type":"object","properties":{"scope":{"enum":["base","one","sub"],"type":"string"},"filter":{"type":"string"},"attributes":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"sizeLimit":{"type":"number"},"timeLimit":{"type":"number"},"derefAliases":{"type":"number"},"typesOnly":{"type":"boolean"},"paged":{"anyOf":[{"type":"object","properties":{"pageSize":{"type":"number"},"pagePause":{"type":"boolean"}}},{"type":"boolean"}]}}},"set":{"description":"JSON paths (on a.b.c form) and hard coded values to set on those\npaths.\n\nThis can be useful for example if you want to hard code a\nnamespace or similar on the generated entities.","type":"object"},"map":{"description":"Mappings from well known entity fields, to LDAP attribute names","type":"object","properties":{"rdn":{"description":"The name of the attribute that holds the relative\ndistinguished name of each entry. Defaults to \"cn\".","type":"string"},"name":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.name field of the entity. Defaults to \"cn\".","type":"string"},"description":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.description field of the entity. Defaults to\n\"description\".","type":"string"},"type":{"description":"The name of the attribute that shall be used for the value of\nthe spec.type field of the entity. Defaults to \"groupType\".","type":"string"},"displayName":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.displayName field of the entity. Defaults to\n\"cn\".","type":"string"},"email":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.email field of the entity.","type":"string"},"picture":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.picture field of the entity.","type":"string"},"memberOf":{"description":"The name of the attribute that shall be used for the values of\nthe spec.parent field of the entity. Defaults to \"memberOf\".","type":"string"},"members":{"description":"The name of the attribute that shall be used for the values of\nthe spec.children field of the entity. Defaults to \"member\".","type":"string"}}}}}}}}}},"microsoftGraphOrg":{"description":"MicrosoftGraphOrgReaderProcessor configuration","deprecated":"Use `catalog.providers.microsoftGraphOrg` instead.","type":"object","properties":{"providers":{"description":"The configuration parameters for each single Microsoft Graph provider.","type":"array","items":{"type":"object","properties":{"target":{"description":"The prefix of the target that this matches on, e.g.\n\"https://graph.microsoft.com/v1.0\", with no trailing slash.","type":"string"},"authority":{"description":"The auth authority used.\n\nDefault value \"https://login.microsoftonline.com\"","type":"string"},"tenantId":{"description":"The tenant whose org data we are interested in.","type":"string"},"clientId":{"description":"The OAuth client ID to use for authenticating requests.","type":"string"},"clientSecret":{"description":"The OAuth client secret to use for authenticating requests.","type":"string"},"userFilter":{"description":"The filter to apply to extract users.\n\nE.g. \"accountEnabled eq true and userType eq 'member'\"","type":"string"},"groupFilter":{"description":"The filter to apply to extract groups.\n\nE.g. \"securityEnabled eq false and mailEnabled eq true\"","type":"string"},"userSelect":{"description":"The fields to be fetched on query.\n\nE.g. [\"id\", \"displayName\", \"description\"]","type":"array","items":{"type":"string"}},"groupSearch":{"description":"The search criteria to apply to extract users by groups memberships.\n\nE.g. \"\\\"displayName:-team\\\"\" would only match groups which contain '-team'","type":"string"},"groupSelect":{"description":"The fields to be fetched on query.\n\nE.g. [\"id\", \"displayName\", \"description\"]","type":"array","items":{"type":"string"}},"userGroupMemberFilter":{"description":"The filter to apply to extract users by groups memberships.\n\nE.g. \"displayName eq 'Backstage Users'\"","type":"string"},"userGroupMemberSearch":{"description":"The search criteria to apply to extract groups.\n\nE.g. \"\\\"displayName:-team\\\"\" would only match groups which contain '-team'","type":"string"}}}}}}}},"providers":{"type":"object","description":"List of provider-specific options and attributes","properties":{"awsS3":{"description":"AwsS3EntityProvider configuration\n\nUses \"default\" as default id for the single config variant.","anyOf":[{"type":"object","properties":{"bucketName":{"description":"(Required) AWS S3 Bucket Name","type":"string"},"prefix":{"description":"(Optional) AWS S3 Object key prefix\nIf not set, all keys will be accepted, no filtering will be applied.","type":"string"},"region":{"description":"(Optional) AWS Region.\nIf not set, AWS_REGION environment variable or aws config file will be used.","type":"string"},"accountId":{"description":"(Optional) AWS Account id.\nIf not set, main account is used.","type":"string"},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}},{"type":"object","additionalProperties":{"type":"object","properties":{"bucketName":{"description":"(Required) AWS S3 Bucket Name","type":"string"},"prefix":{"description":"(Optional) AWS S3 Object key prefix\nIf not set, all keys will be accepted, no filtering will be applied.","type":"string"},"region":{"description":"(Optional) AWS Region.\nIf not set, AWS_REGION environment variable or aws config file will be used.","type":"string"},"accountId":{"description":"(Optional) AWS Account id.\nIf not set, main account is used.","type":"string"},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}}}]},"azureDevOps":{"description":"AzureDevopsEntityProvider configuration","type":"object","additionalProperties":{"type":"object","properties":{"host":{"description":"(Optional) The DevOps host; leave empty for `dev.azure.com`, otherwise set to your self-hosted instance host.","type":"string"},"organization":{"description":"(Required) Your organization slug.","type":"string"},"project":{"description":"(Required) Your project slug.","type":"string"},"repository":{"description":"(Optional) The repository name. Wildcards are supported as show on the examples above.\nIf not set, all repositories will be searched.","type":"string"},"path":{"description":"(Optional) Where to find catalog-info.yaml files. Wildcards are supported.\nIf not set, defaults to /catalog-info.yaml.","type":"string"},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}}},"bitbucketCloud":{"description":"BitbucketCloudEntityProvider configuration\n\nUses \"default\" as default id for the single config variant.","anyOf":[{"type":"object","properties":{"catalogPath":{"description":"(Optional) Path to the catalog file. Default to \"/catalog-info.yaml\".","type":"string"},"workspace":{"description":"(Required) Your workspace.","type":"string"},"filters":{"description":"(Optional) Filters applied to discovered catalog files in repositories.","type":"object","properties":{"repoSlug":{"description":"(Optional) Regular expression filter for the repository slug.","type":"string"},"projectKey":{"description":"(Optional) Regular expression filter for the project key.","type":"string"}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the discovery."}}},{"type":"object","additionalProperties":{"type":"object","properties":{"catalogPath":{"description":"(Optional) Path to the catalog file. Default to \"/catalog-info.yaml\".","type":"string"},"workspace":{"description":"(Required) Your workspace.","type":"string"},"filters":{"description":"(Optional) Filters applied to discovered catalog files in repositories.","type":"object","properties":{"repoSlug":{"description":"(Optional) Regular expression filter for the repository slug.","type":"string"},"projectKey":{"description":"(Optional) Regular expression filter for the project key.","type":"string"}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the discovery."}}}}]},"bitbucketServer":{"description":"BitbucketServerEntityProvider configuration\n\nUses \"default\" as default id for the single config variant.","anyOf":[{"type":"object","properties":{"catalogPath":{"description":"(Optional) Path to the catalog file. Default to \"/catalog-info.yaml\".","type":"string"},"filters":{"description":"(Optional) Filters applied to discovered catalog files in repositories.","type":"object","properties":{"repoSlug":{"description":"(Optional) Regular expression filter for the repository slug.","type":"string"},"projectKey":{"description":"(Optional) Regular expression filter for the project key.","type":"string"}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}},{"type":"object","additionalProperties":{"type":"object","properties":{"catalogPath":{"description":"(Optional) Path to the catalog file. Default to \"/catalog-info.yaml\".","type":"string"},"filters":{"description":"(Optional) Filters applied to discovered catalog files in repositories.","type":"object","properties":{"repoSlug":{"description":"(Optional) Regular expression filter for the repository slug.","type":"string"},"projectKey":{"description":"(Optional) Regular expression filter for the project key.","type":"string"}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}}}]},"gcp":{"description":"GCPCatalogModuleConfig configuration","type":"object","properties":{"gke":{"description":"Config for GKE clusters","type":"object","properties":{"parents":{"description":"Locations to list clusters from","type":"array","items":{"type":"string"}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}}}},"gerrit":{"description":"GerritEntityProvider configuration\n\nMaps provider id with configuration.","type":"object","additionalProperties":{"type":"object","properties":{"host":{"description":"(Required) The host of the Gerrit integration to use.","type":"string"},"query":{"description":"(Required) The query to use for the \"List Projects\" API call. Used to limit the\nscope of the projects that the provider tries to ingest.","type":"string"},"branch":{"description":"(Optional) Branch.\nThe branch where the provider will try to find entities. Defaults to \"master\".","type":"string"}}}},"github":{"description":"GithubEntityProvider configuration\n\nUses \"default\" as default id for the single config variant.","anyOf":[{"type":"object","properties":{"host":{"description":"(Optional) The hostname of your GitHub Enterprise instance.\nDefault: `github.com`.","type":"string"},"organization":{"description":"(Required) Name of your organization account/workspace.","type":"string"},"catalogPath":{"description":"(Optional) Path where to look for `catalog-info.yaml` files.\nYou can use wildcards - `*` or `**` - to search the path and/or the filename\nDefault: `/catalog-info.yaml`.","type":"string"},"filters":{"description":"(Optional) Filter configuration.","type":"object","properties":{"branch":{"description":"(Optional) String used to filter results based on the branch name.","type":"string"},"repository":{"description":"(Optional) Regular expression used to filter results based on the repository name.","type":"string"},"allowForks":{"description":"(Optional) Allow Forks to be evaluated.","type":"boolean"},"topic":{"description":"(Optional) GitHub topic-based filters.","type":"object","properties":{"include":{"description":"(Optional) An array of strings used to filter in results based on their associated GitHub topics.\nIf configured, only repositories with one (or more) topic(s) present in the inclusion\nfilter will be ingested.\n\nIf `include` and `exclude` are used, `exclude` has higher priority.","type":"array","items":{"type":"string"}},"exclude":{"description":"(Optional) An array of strings used to filter out results based on their associated GitHub topics.\nIf configured, all repositories _except_ those with one (or more) topics(s) present in\nthe exclusion filter will be ingested.\n\nIf `include` and `exclude` are used, `exclude` has higher priority.","type":"array","items":{"type":"string"}}}}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}},{"type":"object","additionalProperties":{"type":"object","properties":{"host":{"description":"(Optional) The hostname of your GitHub Enterprise instance.\nDefault: `github.com`.","type":"string"},"organization":{"description":"(Required) Name of your organization account/workspace.","type":"string"},"catalogPath":{"description":"(Optional) Path where to look for `catalog-info.yaml` files.\nYou can use wildcards - `*` or `**` - to search the path and/or the filename\nDefault: `/catalog-info.yaml`.","type":"string"},"filters":{"description":"(Optional) Filter configuration.","type":"object","properties":{"branch":{"description":"(Optional) String used to filter results based on the branch name.","type":"string"},"repository":{"description":"(Optional) Regular expression used to filter results based on the repository name.","type":"string"},"allowForks":{"description":"(Optional) GitHub topic-based filters.","type":"boolean"},"topic":{"description":"(Optional) Allow Forks to be evaluated.","type":"object","properties":{"include":{"description":"(Optional) An array of strings used to filter in results based on their associated GitHub topics.\nIf configured, only repositories with one (or more) topic(s) present in the inclusion\nfilter will be ingested.\n\nIf `include` and `exclude` are used, `exclude` has higher priority.","type":"array","items":{"type":"string"}},"exclude":{"description":"(Optional) An array of strings used to filter out results based on their associated GitHub topics.\nIf configured, all repositories _except_ those with one (or more) topics(s) present in\nthe exclusion filter will be ingested.\n\nIf `include` and `exclude` are used, `exclude` has higher priority.","type":"array","items":{"type":"string"}}}}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}}}]},"githubOrg":{"description":"Configuration for catalogModuleGithubOrgEntityProvider","anyOf":[{"type":"object","properties":{"id":{"description":"A stable id for this provider. Entities from this provider will\nbe associated with this ID, so you should take care not to change\nit over time since that may lead to orphaned entities and/or\nconflicts.","type":"string"},"githubUrl":{"description":"The target that this provider should consume.","type":"string"},"orgs":{"description":"The list of the GitHub orgs to consume. By default will consume all accessible\norgs on the given GitHub instance (support for GitHub App integration only).","type":"array","items":{"type":"string"}},"schedule":{"description":"The refresh schedule to use."}}},{"type":"array","items":{"type":"object","properties":{"id":{"description":"A stable id for this provider. Entities from this provider will\nbe associated with this ID, so you should take care not to change\nit over time since that may lead to orphaned entities and/or\nconflicts.","type":"string"},"githubUrl":{"description":"The target that this provider should consume.","type":"string"},"orgs":{"description":"The list of the GitHub orgs to consume. By default will consume all accessible\norgs on the given GitHub instance (support for GitHub App integration only).","type":"array","items":{"type":"string"}},"schedule":{"description":"The refresh schedule to use."}}}}]},"gitlab":{"description":"GitlabDiscoveryEntityProvider configuration","type":"object","additionalProperties":{"type":"object","properties":{"host":{"description":"(Required) Gitlab's host name.","type":"string"},"group":{"description":"(Optional) Gitlab's group[/subgroup] where the discovery is done.\nIf not defined the whole instance will be scanned.","type":"string"},"branch":{"description":"(Optional) Default branch to read the catalog-info.yaml file.\nIf not set, 'master' will be used.","type":"string"},"entityFilename":{"description":"(Optional) The name used for the catalog file.\nIf not set, 'catalog-info.yaml' will be used.","type":"string"},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."},"projectPattern":{"description":"(Optional) RegExp for the Project Name Pattern","type":"string"},"userPattern":{"description":"(Optional) RegExp for the User Name Pattern","type":"string"},"groupPattern":{"description":"(Optional) RegExp for the Group Name Pattern","type":"string"},"skipForkedRepos":{"description":"(Optional) Skip forked repository","type":"boolean"}}}},"microsoftGraphOrg":{"description":"MicrosoftGraphOrgEntityProvider configuration.","anyOf":[{"type":"object","properties":{"target":{"description":"The prefix of the target that this matches on, e.g.\n\"https://graph.microsoft.com/v1.0\", with no trailing slash.","type":"string"},"authority":{"description":"The auth authority used.\n\nDefault value \"https://login.microsoftonline.com\"","type":"string"},"tenantId":{"description":"The tenant whose org data we are interested in.","type":"string"},"clientId":{"description":"The OAuth client ID to use for authenticating requests.","type":"string"},"clientSecret":{"description":"The OAuth client secret to use for authenticating requests.","type":"string"},"queryMode":{"description":"By default, the Microsoft Graph API only provides the basic feature set\nfor querying. Certain features are limited to advanced query capabilities\n(see https://docs.microsoft.com/en-us/graph/aad-advanced-queries)\nand need to be enabled.\n\nSome features like `$expand` are not available for advanced queries, though.","type":"string"},"user":{"type":"object","properties":{"expand":{"description":"The \"expand\" argument to apply to users.\n\nE.g. \"manager\".","type":"string"},"filter":{"description":"The filter to apply to extract users.\n\nE.g. \"accountEnabled eq true and userType eq 'member'\"","type":"string"}}},"group":{"type":"object","properties":{"expand":{"description":"The \"expand\" argument to apply to groups.\n\nE.g. \"member\".","type":"string"},"filter":{"description":"The filter to apply to extract groups.\n\nE.g. \"securityEnabled eq false and mailEnabled eq true\"","type":"string"},"search":{"description":"The search criteria to apply to extract users by groups memberships.\n\nE.g. \"\\\"displayName:-team\\\"\" would only match groups which contain '-team'","type":"string"},"select":{"description":"The fields to be fetched on query.\n\nE.g. [\"id\", \"displayName\", \"description\"]","type":"array","items":{"type":"string"}}}},"userGroupMember":{"type":"object","properties":{"filter":{"description":"The filter to apply to extract users by groups memberships.\n\nE.g. \"displayName eq 'Backstage Users'\"","type":"string"},"search":{"description":"The search criteria to apply to extract groups.\n\nE.g. \"\\\"displayName:-team\\\"\" would only match groups which contain '-team'","type":"string"}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}},{"type":"object","additionalProperties":{"type":"object","properties":{"target":{"description":"The prefix of the target that this matches on, e.g.\n\"https://graph.microsoft.com/v1.0\", with no trailing slash.","type":"string"},"authority":{"description":"The auth authority used.\n\nDefault value \"https://login.microsoftonline.com\"","type":"string"},"tenantId":{"description":"The tenant whose org data we are interested in.","type":"string"},"clientId":{"description":"The OAuth client ID to use for authenticating requests.","type":"string"},"clientSecret":{"description":"The OAuth client secret to use for authenticating requests.","type":"string"},"queryMode":{"description":"By default, the Microsoft Graph API only provides the basic feature set\nfor querying. Certain features are limited to advanced query capabilities\n(see https://docs.microsoft.com/en-us/graph/aad-advanced-queries)\nand need to be enabled.\n\nSome features like `$expand` are not available for advanced queries, though.","type":"string"},"user":{"type":"object","properties":{"filter":{"description":"The filter to apply to extract users.\n\nE.g. \"accountEnabled eq true and userType eq 'member'\"","type":"string"}}},"group":{"type":"object","properties":{"filter":{"description":"The filter to apply to extract groups.\n\nE.g. \"securityEnabled eq false and mailEnabled eq true\"","type":"string"},"search":{"description":"The search criteria to apply to extract users by groups memberships.\n\nE.g. \"\\\"displayName:-team\\\"\" would only match groups which contain '-team'","type":"string"},"select":{"description":"The fields to be fetched on query.\n\nE.g. [\"id\", \"displayName\", \"description\"]","type":"array","items":{"type":"string"}}}},"userGroupMember":{"type":"object","properties":{"filter":{"description":"The filter to apply to extract users by groups memberships.\n\nE.g. \"displayName eq 'Backstage Users'\"","type":"string"},"search":{"description":"The search criteria to apply to extract groups.\n\nE.g. \"\\\"displayName:-team\\\"\" would only match groups which contain '-team'","type":"string"}}},"schedule":{"description":"(Optional) TaskScheduleDefinition for the refresh."}}}}]},"puppetdb":{"description":"PuppetDB Entity Provider configuration. Uses \"default\" as default ID for the single config variant.","anyOf":[{"type":"object","properties":{"baseUrl":{"description":"(Required) The base URL of PuppetDB API instance.","type":"string"},"query":{"description":"(Optional) PQL query to filter PuppetDB nodes.","type":"string"},"schedule":{"description":"(Optional) Task schedule definition for the refresh."}}},{"type":"object","additionalProperties":{"type":"object","properties":{"baseUrl":{"description":"(Required) The base URL of PuppetDB API instance.","type":"string"},"query":{"description":"(Optional) PQL query to filter PuppetDB nodes.","type":"string"},"schedule":{"description":"(Optional) Task schedule definition for the refresh."}}}}]}}},"import":{"description":"List of import flow specific options and attributes","type":"object","properties":{"entityFilename":{"description":"Catalog entity descriptor filename, defaults to \"catalog-info.yaml\"","type":"string"},"pullRequestBranchName":{"description":"A branch name used in pull request when registering existing component via UI\nValid git refname required, see: https://git-scm.com/docs/git-check-ref-format\nDefaults to \"backstage-integration\"","type":"string"}}}}},"ldap":{"description":"LdapOrgEntityProvider / LdapOrgReaderProcessor configuration","type":"object","properties":{"providers":{"description":"The configuration parameters for each single LDAP provider.","type":"array","items":{"type":"object","properties":{"target":{"description":"The prefix of the target that this matches on, e.g.\n\"ldaps://ds.example.net\", with no trailing slash.","type":"string"},"bind":{"description":"The settings to use for the bind command. If none are specified,\nthe bind command is not issued.","type":"object","properties":{"dn":{"description":"The DN of the user to auth as.\n\nE.g. \"uid=ldap-robot,ou=robots,ou=example,dc=example,dc=net\"","type":"string"},"secret":{"description":"The secret of the user to auth as (its password).","type":"string"}}},"tls":{"description":"TLS settings","type":"object","properties":{"rejectUnauthorized":{"type":"boolean"}}},"users":{"description":"The settings that govern the reading and interpretation of users.","type":"object","properties":{"dn":{"description":"The DN under which users are stored.\n\nE.g. \"ou=people,ou=example,dc=example,dc=net\"","type":"string"},"options":{"description":"The search options to use. The default is scope \"one\" and\nattributes \"*\" and \"+\".\n\nIt is common to want to specify a filter, to narrow down the set\nof matching items.","type":"object","properties":{"scope":{"enum":["base","one","sub"],"type":"string"},"filter":{"type":"string"},"attributes":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"sizeLimit":{"type":"number"},"timeLimit":{"type":"number"},"derefAliases":{"type":"number"},"typesOnly":{"type":"boolean"},"paged":{"anyOf":[{"type":"object","properties":{"pageSize":{"type":"number"},"pagePause":{"type":"boolean"}}},{"type":"boolean"}]}}},"set":{"description":"JSON paths (on a.b.c form) and hard coded values to set on those\npaths.\n\nThis can be useful for example if you want to hard code a\nnamespace or similar on the generated entities.","type":"object"},"map":{"description":"Mappings from well known entity fields, to LDAP attribute names","type":"object","properties":{"rdn":{"description":"The name of the attribute that holds the relative\ndistinguished name of each entry. Defaults to \"uid\".","type":"string"},"name":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.name field of the entity. Defaults to \"uid\".","type":"string"},"description":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.description field of the entity.","type":"string"},"displayName":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.displayName field of the entity. Defaults to\n\"cn\".","type":"string"},"email":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.email field of the entity. Defaults to\n\"mail\".","type":"string"},"picture":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.picture field of the entity.","type":"string"},"memberOf":{"description":"The name of the attribute that shall be used for the values of\nthe spec.memberOf field of the entity. Defaults to \"memberOf\".","type":"string"}}}}},"groups":{"description":"The settings that govern the reading and interpretation of groups.","type":"object","properties":{"dn":{"description":"The DN under which groups are stored.\n\nE.g. \"ou=people,ou=example,dc=example,dc=net\"","type":"string"},"options":{"description":"The search options to use. The default is scope \"one\" and\nattributes \"*\" and \"+\".\n\nIt is common to want to specify a filter, to narrow down the set\nof matching items.","type":"object","properties":{"scope":{"enum":["base","one","sub"],"type":"string"},"filter":{"type":"string"},"attributes":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"sizeLimit":{"type":"number"},"timeLimit":{"type":"number"},"derefAliases":{"type":"number"},"typesOnly":{"type":"boolean"},"paged":{"anyOf":[{"type":"object","properties":{"pageSize":{"type":"number"},"pagePause":{"type":"boolean"}}},{"type":"boolean"}]}}},"set":{"description":"JSON paths (on a.b.c form) and hard coded values to set on those\npaths.\n\nThis can be useful for example if you want to hard code a\nnamespace or similar on the generated entities.","type":"object"},"map":{"description":"Mappings from well known entity fields, to LDAP attribute names","type":"object","properties":{"rdn":{"description":"The name of the attribute that holds the relative\ndistinguished name of each entry. Defaults to \"cn\".","type":"string"},"name":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.name field of the entity. Defaults to \"cn\".","type":"string"},"description":{"description":"The name of the attribute that shall be used for the value of\nthe metadata.description field of the entity. Defaults to\n\"description\".","type":"string"},"type":{"description":"The name of the attribute that shall be used for the value of\nthe spec.type field of the entity. Defaults to \"groupType\".","type":"string"},"displayName":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.displayName field of the entity. Defaults to\n\"cn\".","type":"string"},"email":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.email field of the entity.","type":"string"},"picture":{"description":"The name of the attribute that shall be used for the value of\nthe spec.profile.picture field of the entity.","type":"string"},"memberOf":{"description":"The name of the attribute that shall be used for the values of\nthe spec.parent field of the entity. Defaults to \"memberOf\".","type":"string"},"members":{"description":"The name of the attribute that shall be used for the values of\nthe spec.children field of the entity. Defaults to \"member\".","type":"string"}}}}}}}}}},"codescene":{"description":"Configuration options for the CodeScene plugin","type":"object","properties":{"baseUrl":{"description":"The base url of the CodeScene installation.","type":"string"}}},"costInsights":{"type":"object","properties":{"engineerCost":{"type":"number"},"engineerThreshold":{"type":"number"},"baseCurrency":{"type":"object","properties":{"locale":{"type":"string"},"options":{"type":"object","properties":{"localeMatcher":{"type":"string"},"style":{"type":"string"},"currency":{"type":"string"},"currencySign":{"type":"string"},"useGrouping":{"type":"boolean"},"minimumIntegerDigits":{"type":"number"},"minimumFractionDigits":{"type":"number"},"maximumFractionDigits":{"type":"number"},"minimumSignificantDigits":{"type":"number"},"maximumSignificantDigits":{"type":"number"}}}}},"products":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"icon":{"enum":["compute","data","database","ml","search","storage"],"type":"string"}}}},"metrics":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"default":{"type":"boolean"}}}},"currencies":{"type":"object","additionalProperties":{"type":"object","properties":{"label":{"type":"string"},"unit":{"type":"string"},"kind":{"type":"string"},"prefix":{"type":"string"},"rate":{"type":"number"},"default":{"type":"boolean"}}}}}},"devTools":{"description":"DevTools configuration.","type":"object","properties":{"externalDependencies":{"description":"External dependency configuration.","type":"object","properties":{"endpoints":{"description":"The list of endpoints to check.","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the endpoint.","type":"string"},"type":{"description":"Type of check to perform; currently fetch or ping","type":"string"},"target":{"description":"The target of the endpoint; currently either a URL for fetch or server name for ping.","type":"string"}}}}}},"info":{"description":"Info configuration","type":"object","properties":{"packagePrefixes":{"description":"A list of package prefixes that DevTools will use for filtering all available dependencies\n(default is [\"@backstage\"])","type":"array","items":{"type":"string"}}}}}},"dynatrace":{"description":"dynatrace config","type":"object","properties":{"baseUrl":{"description":"base url for links","type":"string"}}},"events":{"type":"object","properties":{"http":{"type":"object","properties":{"topics":{"description":"Topics for which a route has to be registered\nat which we can receive events via HTTP POST requests\n(i.e. received from webhooks).","type":"array","items":{"type":"string"}}}},"modules":{"type":"object","properties":{"awsSqs":{"description":"events-backend-module-aws-sqs plugin configuration.","type":"object","properties":{"awsSqsConsumingEventPublisher":{"description":"Configuration for AwsSqsConsumingEventPublisher.","type":"object","properties":{"topics":{"description":"Contains a record per topic for which an AWS SQS queue\nshould be used as source of events.","type":"object","additionalProperties":{"type":"object","properties":{"queue":{"description":"(Required) Queue-related configuration.","type":"object","properties":{"region":{"description":"(Required) The region of the AWS SQS queue.","type":"string"},"url":{"description":"(Required) The absolute URL for the AWS SQS queue to be used.","type":"string"},"visibilityTimeout":{"description":"(Optional) Visibility timeout for messages in flight."},"waitTime":{"description":"(Optional) Wait time when polling for available messages.\nDefault: 20 seconds."}}},"timeout":{"description":"(Optional) Timeout for the task execution which includes polling for messages\nand publishing the events to the event broker\nand the wait time after empty receives.\n\nMust be greater than `queue.waitTime` + `waitTimeAfterEmptyReceive`."},"waitTimeAfterEmptyReceive":{"description":"(Optional) Wait time before polling again if no message was received.\nDefault: 1 minute."}}}}}}}},"github":{"description":"events-backend-module-github plugin configuration.","type":"object","properties":{"webhookSecret":{"description":"Secret token for webhook requests used to verify signatures.\n\nSee https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\nfor more details.","type":"string"}}},"gitlab":{"description":"events-backend-module-gitlab plugin configuration.","type":"object","properties":{"webhookSecret":{"description":"Secret token for webhook requests used to verify tokens.\n\nSee https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#validate-payloads-by-using-a-secret-token\nfor more details.","type":"string"}}}}}}},"explore":{"type":"object","properties":{"tools":{"description":"Tools to be used for the explore tool provider.","type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"image":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"lifecycle":{"type":"string"}}}}}},"fossa":{"type":"object","properties":{"organizationId":{"description":"The organization id in fossa.","type":"string"},"externalLinkBaseUrl":{"description":"The base url to use for external links (from Backstage to Fossa).","type":"string"}}},"gocd":{"description":"Configurations for the GoCD plugin","type":"object","properties":{"baseUrl":{"description":"The base url of the GoCD installation.","type":"string"}}},"ilert":{"type":"object","properties":{"baseUrl":{"description":"Domain used by users to access iLert web UI.\nExample: https://my-app.ilert.com/","type":"string"},"proxyPath":{"description":"Path to use for requests via the proxy, defaults to /ilert/api","type":"string"}}},"jenkins":{"type":"object","properties":{"baseUrl":{"description":"Default instance baseUrl, can be specified on a named instance called \"default\"","type":"string"},"username":{"description":"Default instance username, can be specified on a named instance called \"default\"","type":"string"},"apiKey":{"description":"Default Instance apiKey, can be specified on a named instance called \"default\"","type":"string"},"instances":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the instance, this will be used in an annotation on catalog entities to refer to jobs on this instance.\n\nUse a name of \"default\" to specify the jenkins instance details if the annotation doesn't explicitly name an\ninstance.","type":"string"},"baseUrl":{"type":"string"},"username":{"type":"string"},"apiKey":{"type":"string"},"extraRequestHeaders":{"type":"object","additionalProperties":{"type":"string"},"properties":{"Authorization":{"type":"string"},"authorization":{"type":"string"}}}}}}}},"kafka":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Cluster name","type":"string"},"dashboardUrl":{"description":"Cluster dashboard url","type":"string"},"brokers":{"description":"List of brokers in the Kafka cluster to connect to.","type":"array","items":{"type":"string"}},"ssl":{"description":"Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect.\nSee https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options","anyOf":[{"type":"object","properties":{"ca":{"type":"array","items":{"type":"string"}},"key":{"type":"string"},"cert":{"type":"string"},"rejectUnauthorized":{"type":"boolean"}}},{"type":"boolean"}]},"sasl":{"description":"Optional SASL connection parameters.","type":"object","properties":{"mechanism":{"enum":["plain","scram-sha-256","scram-sha-512"],"type":"string"},"username":{"type":"string"},"password":{"type":"string"}}}}}},"clientId":{"description":"Client ID used to Backstage uses to identify when connecting to the Kafka cluster.","type":"string"}}},"kubernetes":{"type":"object","properties":{"objectTypes":{"type":"array","items":{"enum":["configmaps","cronjobs","customresources","daemonsets","deployments","horizontalpodautoscalers","ingresses","jobs","limitranges","pods","replicasets","services","statefulsets"],"type":"string"}},"serviceLocatorMethod":{"type":"object","properties":{"type":{"type":"string","enum":["multiTenant","singleTenant","catalogRelation"]}}},"clusterLocatorMethods":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["config"]},"clusters":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"serviceAccountToken":{"type":"string"},"authProvider":{"enum":["aws","azure","google","googleServiceAccount","oidc","serviceAccount"],"type":"string"},"oidcTokenProvider":{"type":"string"},"skipTLSVerify":{"type":"boolean"},"skipMetricsLookup":{"type":"boolean"},"caData":{"type":"string"},"caFile":{"type":"string"}}}}}},{"type":"object","properties":{"type":{"type":"string","enum":["catalog"]}}},{"type":"object","properties":{"type":{"type":"string","enum":["localKubectlProxy"]}}},{"type":"object","properties":{"type":{"type":"string","enum":["gke"]},"projectId":{"type":"string"},"region":{"type":"string"},"skipTLSVerify":{"type":"boolean"},"skipMetricsLookup":{"type":"boolean"}}}]}},"customResources":{"type":"array","items":{"type":"object","properties":{"group":{"type":"string"},"apiVersion":{"type":"string"},"plural":{"type":"string"}}}},"apiVersionOverrides":{"description":"(Optional) API Version Overrides\nIf set, the specified api version will be used to make requests for the corresponding object.\nIf running a legacy Kubernetes version, you may use this to override the default api versions\nthat are not supported in your cluster.","type":"object","additionalProperties":{"type":"string"},"properties":{"pods":{"type":"string"},"services":{"type":"string"},"configmaps":{"type":"string"},"deployments":{"type":"string"},"limitranges":{"type":"string"},"replicasets":{"type":"string"},"horizontalpodautoscalers":{"type":"string"},"jobs":{"type":"string"},"cronjobs":{"type":"string"},"ingresses":{"type":"string"},"customresources":{"type":"string"},"statefulsets":{"type":"string"},"daemonsets":{"type":"string"}}}}},"linguist":{"description":"Configuration options for the linguist plugin","type":"object","properties":{"schedule":{},"batchSize":{"default":20,"type":"number"},"useSourceLocation":{"default":false,"type":"boolean"},"age":{"description":"Refresh generated language breakdown"},"kind":{"default":"['API', 'Component', 'Template']","type":"array","items":{"type":"string"}},"linguistJsOptions":{"description":"[linguist-js](https://www.npmjs.com/package/linguist-js) options"},"tagsProcessor":{"description":"Options for the tags processor","type":"object","properties":{"bytesThreshold":{"description":"Determines how many bytes of a language should be in a repo\nfor it to be added as an entity tag. Defaults to 0.","type":"number"},"languageTypes":{"description":"The types of linguist languages that should be processed. Can be\nany of \"programming\", \"data\", \"markup\", \"prose\". Defaults to [\"programming\"].","type":"array","items":{"type":"string"}},"languageMap":{"description":"A custom mapping of linguist languages to how they should be rendered as entity tags.\nIf a language is mapped to '' it will not be included as a tag.","type":"object","additionalProperties":{"type":"string"}},"cacheTTL":{"description":"How long to cache entity languages for in memory. Used to avoid constant db hits during\nprocessing. Defaults to 30 minutes."}}}}},"opencost":{"description":"Configurations for the OpenCost plugin","type":"object","properties":{"baseUrl":{"description":"The base URL for the OpenCost API","type":"string"}}},"periskop":{"description":"Configuration options for the periskop plugin","type":"object","properties":{"instances":{"description":"Integration configuration for the periskop servers","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the given Periskop instance","type":"string"},"url":{"description":"The hostname of the given Periskop instance","type":"string"}}}}}},"pagerDuty":{"description":"Configuration for the PagerDuty plugin","type":"object","properties":{"eventsBaseUrl":{"description":"Optional Events Base URL to override the default.","type":"string"}}},"permission":{"description":"Configuration options for Backstage permissions and authorization","type":"object","properties":{"enabled":{"description":"Whether authorization is enabled in Backstage. Defaults to false, which means authorization\nrequests will be automatically allowed without invoking the authorization policy.","type":"boolean"}}},"playlist":{"type":"object","properties":{"title":{"description":"(Optional) The title that will shown in the UI; Defaults to`Playlist` if undefined.","type":"string"}}},"proxy":{"type":"object","properties":{"skipInvalidProxies":{"description":"Rather than failing to start up, the proxy backend will instead just warn on invalid endpoints.","type":"boolean"},"reviveConsumedRequestBodies":{"description":"Revive request bodies that have already been consumed by earlier middleware.","type":"boolean"},"endpoints":{"description":"A list of forwarding-proxies. Each key is a route to match,\nbelow the prefix that the proxy plugin is mounted on. It must\nstart with a '/'.","type":"object","additionalProperties":{"anyOf":[{"type":"object","properties":{"target":{"description":"Target of the proxy. Url string to be parsed with the url module.","type":"string"},"headers":{"description":"Object with extra headers to be added to target requests.","type":"object","additionalProperties":{"type":"string"},"properties":{"Authorization":{"type":"string"},"authorization":{"type":"string"},"X-Api-Key":{"type":"string"},"x-api-key":{"type":"string"}}},"changeOrigin":{"description":"Changes the origin of the host header to the target URL. Default: true.","type":"boolean"},"pathRewrite":{"description":"Rewrite target's url path. Object-keys will be used as RegExp to match paths.\nIf pathRewrite is not specified, it is set to a single rewrite that removes the entire prefix and route.","type":"object","additionalProperties":{"type":"string"}},"allowedMethods":{"description":"Limit the forwarded HTTP methods, for example allowedMethods: ['GET'] to enforce read-only access.","type":"array","items":{"type":"string"}},"allowedHeaders":{"description":"Limit the forwarded HTTP methods. By default, only the headers that are considered safe for CORS\nand headers that are set by the proxy will be forwarded.","type":"array","items":{"type":"string"}}}},{"type":"string"}]}}}},"rollbar":{"description":"Configuration options for the rollbar plugin","type":"object","properties":{"organization":{"description":"The Rollbar organization name. This can be omitted by using the `rollbar.com/project-slug` annotation.","type":"string"},"accountToken":{"description":"The authentication token for accessing the Rollbar API","type":"string"}}},"scaffolder":{"description":"Configuration options for the scaffolder plugin","type":"object","properties":{"defaultAuthor":{"description":"The commit author info used when new components are created.","type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"}}},"defaultCommitMessage":{"description":"The commit message used when new components are created.","type":"string"},"concurrentTasksLimit":{"description":"Sets the number of concurrent tasks that can be run at any given time on the TaskWorker.\n\nDefaults to 10.\n\nSet to 0 to disable task workers altogether.","type":"number"}}},"confluence":{"description":"Configuration options for the Confluence to Markdown action","type":"object","properties":{"baseUrl":{"description":"The base URL for accessing the Confluence API","type":"string"},"auth":{"type":"object","properties":{"type":{"description":"Authentication method - basic, bearer, username/password","enum":["basic","bearer","userpass"],"type":"string"},"token":{"description":"Token used for the basic and bearer auth methods","type":"string"},"email":{"description":"Email used with the token for the basic auth method","type":"string"},"username":{"description":"Username used with the Username/Password auth method","type":"string"},"password":{"description":"Password used with the Username/Password auth method","type":"string"}}}}},"search":{"description":"Configuration options for the search plugin","type":"object","properties":{"maxPageLimit":{"description":"Sets the maximum max page limit size. Defaults to 100.","type":"number"},"permissions":{"description":"Options related to the search integration with the Backstage permissions system","type":"object","properties":{"queryLatencyBudgetMs":{"description":"Limits the amount of time the search backend will spend retrieving and\nauthorizing results from the search engine when permissions are\nenabled. When the latency of the query endpoint reaches this threshold,\nthe results obtained up until that point will be returned, even if the\npage is incomplete.\n\nThis limit is only expected to be hit for broad queries from users with\nextremely restrictive visibility, or for very high page offsets.","default":1000,"type":"number"}}},"query":{"description":"An object representing the default search query configuration.\nBy configuring and modifying the values of this object,\nyou can customize the default values of the search queries\nand define how it behaves by default.","type":"object","properties":{"pageLimit":{"description":"A number indicating the maximum number of results to be returned\nper page during pagination.","enum":[10,100,25,50],"type":"number"}}},"collators":{"type":"object","properties":{"catalog":{"description":"Configuration options for `@backstage/plugin-search-backend-module-catalog`","type":"object","properties":{"locationTemplate":{"description":"A templating string with placeholders, to form the final location of\nthe entity.\n\nDefaults to '/catalog/:namespace/:kind/:name'","type":"string"},"filter":{"description":"A filter expression passed to the catalog client, to select what\nentities to collate.\n\nDefaults to no filter, ie indexing all entities.","type":"object","additionalProperties":true},"batchSize":{"description":"The number of entities to process at a time. Keep this at a\nreasonable number to avoid overloading either the catalog or the\nsearch backend.\n\nDefaults to 500","type":"number"},"schedule":{"description":"The schedule for how often to run the collation job."}}},"explore":{"description":"Configuration options for `@backstage/plugin-search-backend-module-explore`","type":"object","properties":{"schedule":{"description":"The schedule for how often to run the collation job."}}},"techdocs":{"description":"Configuration options for `@backstage/plugin-search-backend-module-techdocs`","type":"object","properties":{"schedule":{"description":"The schedule for how often to run the collation job."},"locationTemplate":{"description":"A templating string with placeholders, to form the final location of\nthe entity.\n\nDefaults to `'/docs/:namespace/:kind/:name/:path'`.","type":"string"},"parallelismLimit":{"description":"An abstract value that controls the concurrency level of the\ncollation process. Increasing this value will both increase the\nnumber of entities fetched at a time from the catalog, as well as how\nmany things are being processed concurrently.\n\nDefaults to `10`.","type":"number"},"legacyPathCasing":{"description":"Defaults to `false`.","type":"boolean"}}}}},"elasticsearch":{"description":"Options for ElasticSearch","type":"object","properties":{"batchSize":{"description":"Batch size for elastic search indexing tasks. Defaults to 1000.","type":"number"},"highlightOptions":{"description":"Options for configuring highlight settings\nSee https://www.elastic.co/guide/en/elasticsearch/reference/7.17/highlighting.html","type":"object","properties":{"fragmentSize":{"description":"The size of the highlighted fragment in characters. Defaults to 1000.","type":"number"},"numFragments":{"description":"Number of result fragments to extract. Fragments will be concatenated with `fragmentDelimiter`. Defaults to 1.","type":"number"},"fragmentDelimiter":{"description":"Delimiter string used to concatenate fragments. Defaults to \" ... \".","type":"string"}}},"indexTemplates":{"description":"Elasticsearch specific index template bodies","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"body":{"type":"object","properties":{"index_patterns":{"description":"Array of wildcard (*) expressions used to match the names of data streams and indices during creation.","type":"array","items":{"type":"string"}},"composed_of":{"description":"An ordered list of component template names.\nComponent templates are merged in the order specified,\nmeaning that the last component template specified has the highest precedence.","type":"array","items":{"type":"string"}},"template":{"description":"See available properties of template\nhttps://www.elastic.co/guide/en/elasticsearch/reference/7.15/indices-put-template.html#put-index-template-api-request-body","type":"object"}}}}}},"clientOptions":{"description":"Miscellaneous options for the client","anyOf":[{"type":"object","properties":{"ssl":{"type":"object","properties":{"rejectUnauthorized":{"description":"If true the server will reject any connection which is not\nauthorized with the list of supplied CAs.","default":true,"type":"boolean"}}},"provider":{"type":"string","enum":["elastic"]},"cloudId":{"description":"Elastic.co CloudID\nSee: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication","type":"string"},"auth":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}}}},{"type":"object","properties":{"ssl":{"type":"object","properties":{"rejectUnauthorized":{"description":"If true the server will reject any connection which is not\nauthorized with the list of supplied CAs.","default":true,"type":"boolean"}}},"provider":{"type":"string","enum":["aws"]},"node":{"description":"Node configuration.\nURL AWS ES endpoint to connect to.\nEg. https://my-es-cluster.eu-west-1.es.amazonaws.com","type":"string"}}},{"type":"object","properties":{"ssl":{"type":"object","properties":{"rejectUnauthorized":{"description":"If true the server will reject any connection which is not\nauthorized with the list of supplied CAs.","default":true,"type":"boolean"}}},"node":{"description":"Node configuration.\nURL/URLS to ElasticSearch node to connect to.\nEither direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"auth":{"description":"Authentication credentials for ElasticSearch\nIf both ApiKey/Bearer token and username+password is provided, tokens take precedence","anyOf":[{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},{"type":"object","properties":{"apiKey":{"description":"Base64 Encoded API key to be used to connect to the cluster.\nSee: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html","type":"string"}}}]}}},{"type":"object","properties":{"ssl":{"type":"object","properties":{"rejectUnauthorized":{"description":"If true the server will reject any connection which is not\nauthorized with the list of supplied CAs.","default":true,"type":"boolean"}}},"provider":{"type":"string","enum":["opensearch"]},"node":{"description":"Node configuration.\nURL/URLS to OpenSearch node to connect to.\nEither direct URL like 'https://localhost:9200' or with credentials like 'https://username:password@localhost:9200'","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"auth":{"description":"Authentication credentials for OpenSearch\nIf both ApiKey/Bearer token and username+password is provided, tokens take precedence","anyOf":[{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},{"type":"object","properties":{"apiKey":{"type":"string"}}}]}}}]}}},"pg":{"description":"Options for PG","type":"object","properties":{"highlightOptions":{"description":"Options for configuring highlight settings\nSee https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-HEADLINE","type":"object","properties":{"useHighlight":{"description":"Used to enable to disable the highlight feature. The default value is true","type":"boolean"},"maxWords":{"description":"Used to set the longest headlines to output. The default value is 35.","type":"number"},"minWords":{"description":"Used to set the shortest headlines to output. The default value is 15.","type":"number"},"shortWord":{"description":"Words of this length or less will be dropped at the start and end of a headline, unless they are query terms.\nThe default value of three (3) eliminates common English articles.","type":"number"},"highlightAll":{"description":"If true the whole document will be used as the headline, ignoring the preceding three parameters. The default is false.","type":"boolean"},"maxFragments":{"description":"Maximum number of text fragments to display. The default value of zero selects a non-fragment-based headline generation method.\nA value greater than zero selects fragment-based headline generation (see the linked documentation above for more details).","type":"number"},"fragmentDelimiter":{"description":"Delimiter string used to concatenate fragments. Defaults to \" ... \".","type":"string"}}},"indexerBatchSize":{"description":"Batch size to use when indexing","type":"number"}}}}},"sentry":{"description":"Configuration options for the sentry plugin","type":"object","properties":{"organization":{"description":"The 'organization' attribute","type":"string"}}},"sonarqube":{"description":"Optional configurations for the SonarQube plugin","type":"object","properties":{"baseUrl":{"description":"The base url of the sonarqube installation. Defaults to https://sonarcloud.io.","type":"string"},"externalBaseUrl":{"description":"The external url of the sonarqube installation.\nUse this if you want to use a different url for the frontend than the backend.","type":"string"},"apiKey":{"description":"The api key to access the sonarqube instance under baseUrl.","type":"string"},"instances":{"description":"The optional sonarqube instances.","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the sonarqube instance.","type":"string"},"baseUrl":{"description":"The base url of the sonarqube instance.","type":"string"},"externalBaseUrl":{"description":"The external url of the sonarqube instance.\nUse this if you want to use a different url for the frontend than the backend.","type":"string"},"apiKey":{"description":"The api key to access the sonarqube instance.","type":"string"}}}}}},"splunkOnCall":{"description":"Splunk On Call Plugin specific configs","type":"object","properties":{"eventsRestEndpoint":{"type":"string"}}},"stackoverflow":{"description":"Configuration options for the stack overflow plugin","type":"object","properties":{"baseUrl":{"description":"The base url of the Stack Overflow API used for the plugin","type":"string"},"apiKey":{"description":"The API key to authenticate to Stack Overflow API","type":"string"},"teamName":{"description":"The name of the team for a Stack Overflow for Teams account","type":"string"},"apiAccessToken":{"description":"The API Access Token to authenticate to Stack Overflow API","type":"string"}}},"stackstorm":{"type":"object","properties":{"webUrl":{"description":"StackStorm Web UI url\nUsed in links to StackStorm web UI","type":"string"}}},"techdocs":{"description":"Configuration options for the techdocs plugin","type":"object","properties":{"builder":{"description":"Documentation building process depends on the builder attr","enum":["external","local"],"type":"string"},"legacyUseCaseSensitiveTripletPaths":{"description":"Allows fallback to case-sensitive triplets in case of migration issues.","type":"boolean"},"sanitizer":{"type":"object","properties":{"allowedIframeHosts":{"description":"Allows iframe tag only for listed hosts\nExample:\n allowedIframeHosts: [\"example.com\"]\n this will allow all iframes with the host `example.com` in the src attribute","type":"array","items":{"type":"string"}}}},"generator":{"description":"Techdocs generator information","type":"object","properties":{"runIn":{"description":"Where to run the techdocs (mkdocs) generator","enum":["docker","local"],"type":"string"},"dockerImage":{"description":"Override the default techdocs docker image","type":"string"},"pullImage":{"description":"Pull the latest docker image","type":"boolean"},"mkdocs":{"description":"Override behavior specific to mkdocs.","type":"object","properties":{"legacyCopyReadmeMdToIndexMd":{"description":"(Optional and not recommended) Configures the techdocs generator to\nattempt to ensure an index.md exists falling back to using <docs-dir>/README.md\nor README.md in case a default <docs-dir>/index.md is not provided.\nNote that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior\nwill be broken in these scenarios.","type":"boolean"},"defaultPlugins":{"description":"List of mkdocs plugins which should be added as default to all mkdocs.yml files.","type":"array","items":{"type":"string"}}}}}},"publisher":{"description":"Techdocs publisher information","anyOf":[{"type":"object","properties":{"type":{"enum":["awsS3","azureBlobStorage","googleGcs","local","openStackSwift"],"type":"string"},"local":{"type":"object","properties":{"publishDirectory":{"description":"Directory to store generated static files.","type":"string"}}}}},{"type":"object","properties":{"type":{"type":"string","enum":["awsS3"]},"awsS3":{"description":"Required when 'type' is set to awsS3","type":"object","properties":{"accountId":{"description":"(Optional) The AWS account ID where the storage bucket is located.\nCredentials for the account ID will be sourced from the 'aws' app config section.\nSee the\n[integration-aws-node package](https://github.com/backstage/backstage/blob/master/packages/integration-aws-node/README.md)\nfor details on how to configure the credentials in the app config.\nIf account ID is not set and no credentials are set, environment variables or aws config file will be used to authenticate.","type":"string"},"credentials":{"description":"(Optional) Credentials used to access a storage bucket.\nThis section is now deprecated. Configuring the account ID is now preferred, with credentials in the 'aws'\napp config section.\nIf not set and no account ID is set, environment variables or aws config file will be used to authenticate.","type":"object","properties":{"accessKeyId":{"description":"User access key id","type":"string"},"secretAccessKey":{"description":"User secret access key","type":"string"},"roleArn":{"description":"ARN of role to be assumed","type":"string"}}},"bucketName":{"description":"(Required) Cloud Storage Bucket Name","type":"string"},"region":{"description":"(Optional) AWS Region.\nIf not set, AWS_REGION environment variable or aws config file will be used.","type":"string"},"endpoint":{"description":"(Optional) AWS Endpoint.\nThe endpoint URI to send requests to. The default endpoint is built from the configured region.","type":"string"},"s3ForcePathStyle":{"description":"(Optional) Whether to use path style URLs when communicating with S3.\nDefaults to false.\nThis allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used to host tech docs.","type":"boolean"},"sse":{"description":"(Optional) AWS Server Side Encryption\nDefaults to undefined.\nIf not set, encrypted buckets will fail to publish.\nhttps://docs.aws.amazon.com/AmazonS3/latest/userguide/specifying-s3-encryption.html","enum":["AES256","aws:kms"],"type":"string"}}}}},{"type":"object","properties":{"type":{"type":"string","enum":["openStackSwift"]},"openStackSwift":{"description":"Required when 'type' is set to openStackSwift","type":"object","properties":{"credentials":{"description":"(Required) Credentials used to access a storage bucket.","type":"object","properties":{"id":{"description":"(Required) Application Credential ID","type":"string"},"secret":{"description":"(Required) Application Credential Secret","type":"string"}}},"containerName":{"description":"(Required) Cloud Storage Container Name","type":"string"},"authUrl":{"description":"(Required) Auth url sometimes OpenStack uses different port check your OpenStack apis.","type":"string"},"swiftUrl":{"description":"(Required) Swift URL","type":"string"}}}}},{"type":"object","properties":{"type":{"type":"string","enum":["azureBlobStorage"]},"azureBlobStorage":{"description":"Required when 'type' is set to azureBlobStorage","type":"object","properties":{"connectionString":{"description":"(Optional) Connection string of the storage container.","type":"string"},"credentials":{"description":"(Optional) Credentials used to access a storage container.","type":"object","properties":{"accountName":{"description":"Account access name","type":"string"},"accountKey":{"description":"(Optional) Account secret primary key\nIf not set, environment variables will be used to authenticate.","type":"string"}}},"containerName":{"description":"(Required) Cloud Storage Container Name","type":"string"}}}}},{"type":"object","properties":{"type":{"type":"string","enum":["googleGcs"]},"googleGcs":{"description":"Required when 'type' is set to googleGcs","type":"object","properties":{"bucketName":{"description":"(Required) Cloud Storage Bucket Name","type":"string"},"credentials":{"description":"(Optional) API key used to write to a storage bucket.\nIf not set, environment variables will be used to authenticate.","type":"string"},"projectId":{"description":"(Optional) GCP project ID that contains the bucket. Should be\nset if credentials is not set, or if the service account in\nthe credentials belongs to a different project to the bucket.","type":"string"}}}}}]},"cache":{"type":"object","properties":{"ttl":{"description":"The cache time-to-live for TechDocs sites (in milliseconds). Set this\nto a non-zero value to cache TechDocs sites and assets as they are\nread from storage.\n\nNote: you must also configure `backend.cache` appropriately as well,\nand to pass a PluginCacheManager instance to TechDocs Backend's\ncreateRouter method in your backend.","type":"number"},"readTimeout":{"description":"The time (in milliseconds) that the TechDocs backend will wait for\na cache service to respond before continuing on as though the cached\nobject was not found (e.g. when the cache sercice is unavailable).\n\nDefaults to 1000 milliseconds.","type":"number"}}}}},"vault":{"type":"object","properties":{"baseUrl":{"description":"The baseUrl for your Vault instance.","type":"string"},"publicUrl":{"description":"The publicUrl for your Vault instance (Optional).","type":"string"},"token":{"description":"The token used by Backstage to access Vault.","type":"string"},"secretEngine":{"description":"The secret engine name where in vault. Defaults to `secrets`.","type":"string"},"kvVersion":{"description":"The version of the K/V API. Defaults to `2`.","enum":[1,2],"type":"number"}}},"scorecards":{"description":"Extra configuration for score card plugin","type":"object","properties":{"jsonDataUrl":{"description":"The public absolute root URL with json file defining the score card entries.","type":"string"},"wikiLinkTemplate":{"description":"The template for the link to the wiki, e.g. \"https://TBD/XXX/_wiki/wikis/XXX.wiki/{id}\"","type":"string"}}},"travisci":{"description":"Configuration options for the travisci plugin","type":"object","properties":{"baseUrl":{"description":"The 'baseUrl' attribute. It should point to the address of the travis portal.\nIf not provided, frontend plugin will use 'https://travis-ci.com/'","type":"string"}}}}}
|
Provide a JSON object that satisfies the schema "Application Configuration Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Application Configuration Schema
|
schema-store
|
schema_store_43
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/apple-app-site-association.json\",\"$defs\":{\"app_ids\":{\"type\":\"array\",\"title\":\"AppIDs\",\"description\":\"Array of multiple AppIDs\",\"items\":{\"$ref\":\"#/$defs/app_id\"}},\"app_id\":{\"type\":\"string\",\"pattern\":\"^[A-Z0-9]{10}\\\\.([A-Za-z]{1}[A-Za-z\\\\d_]*\\\\.)+[A-Za-z][A-Za-z\\\\d_]*$\",\"title\":\"TeamID And AppID\",\"description\":\"10 character TeamID followed by AppID\"},\"component\":{\"type\":\"object\",\"title\":\"AppID component\",\"description\":\"A component for uri matching\",\"additionalProperties\":false,\"properties\":{\"/\":{\"type\":\"string\",\"title\":\"Path component\",\"description\":\"Define path matching\"},\"#\":{\"type\":\"string\",\"title\":\"Fragment component\",\"description\":\"Define fragment matching\"},\"?\":{\"title\":\"Query component\",\"description\":\"Define Query matching\",\"anyOf\":[{\"type\":\"object\"},{\"type\":\"string\"}]},\"exclude\":{\"type\":\"boolean\",\"title\":\"Exclusion flag\",\"description\":\"Whether to exclude a specific match\"}}}},\"required\":[\"applinks\"],\"title\":\"Apple Universal Links Config\",\"description\":\"Apple Universal Links Config Schema\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"webcredentials\":{\"type\":\"object\",\"title\":\"Webcredentials Config\",\"description\":\"Apple Webcredentials Config Schema\",\"properties\":{\"apps\":{\"$ref\":\"#/$defs/app_ids\"}}},\"appclips\":{\"type\":\"object\",\"title\":\"AppClip Config\",\"description\":\"Apple AppClip Config Schema\",\"properties\":{\"apps\":{\"$ref\":\"#/$defs/app_ids\"}}},\"applinks\":{\"type\":\"object\",\"title\":\"Universalink Configurations\",\"description\":\"Universalink Configurations Schema\",\"additionalProperties\":false,\"required\":[\"details\"],\"properties\":{\"apps\":{\"description\":\"Always empty [] for UniversaLink, can be omitted in later versions\",\"type\":\"array\",\"const\":[]},\"details\":{\"type\":\"array\",\"description\":\"AppIDs's Universalink URI Matching Configuration\",\"minItems\":1,\"items\":{\"title\":\"AppID's matching details\",\"description\":\"Details of specific AppIDs uri matching configuration\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"appIDs\":{\"title\":\"AppIDs\",\"description\":\"Array of AppIDs\",\"type\":\"array\",\"uniqueItems\":true,\"minItems\":1,\"items\":{\"$ref\":\"#/$defs/app_id\"}},\"appID\":{\"$ref\":\"#/$defs/app_id\"},\"paths\":{\"title\":\"Paths\",\"description\":\"Array of paths to be matched against\",\"type\":\"array\",\"uniqueItems\":true,\"minItems\":1,\"items\":{\"type\":\"string\",\"title\":\"Path\",\"description\":\"Single unique path to be matched against\"}},\"components\":{\"type\":\"array\",\"title\":\"URI Components\",\"description\":\"Array of path components to be matched, available in later versions\",\"minItems\":1,\"items\":{\"$ref\":\"#/$defs/component\"}}}}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Apple Universal Links Config\". Here are the required top‑level fields: applinks. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/apple-app-site-association.json","$defs":{"app_ids":{"type":"array","title":"AppIDs","description":"Array of multiple AppIDs","items":{"$ref":"#/$defs/app_id"}},"app_id":{"type":"string","pattern":"^[A-Z0-9]{10}\\.([A-Za-z]{1}[A-Za-z\\d_]*\\.)+[A-Za-z][A-Za-z\\d_]*$","title":"TeamID And AppID","description":"10 character TeamID followed by AppID"},"component":{"type":"object","title":"AppID component","description":"A component for uri matching","additionalProperties":false,"properties":{"/":{"type":"string","title":"Path component","description":"Define path matching"},"#":{"type":"string","title":"Fragment component","description":"Define fragment matching"},"?":{"title":"Query component","description":"Define Query matching","anyOf":[{"type":"object"},{"type":"string"}]},"exclude":{"type":"boolean","title":"Exclusion flag","description":"Whether to exclude a specific match"}}}},"required":["applinks"],"title":"Apple Universal Links Config","description":"Apple Universal Links Config Schema","type":"object","additionalProperties":false,"properties":{"webcredentials":{"type":"object","title":"Webcredentials Config","description":"Apple Webcredentials Config Schema","properties":{"apps":{"$ref":"#/$defs/app_ids"}}},"appclips":{"type":"object","title":"AppClip Config","description":"Apple AppClip Config Schema","properties":{"apps":{"$ref":"#/$defs/app_ids"}}},"applinks":{"type":"object","title":"Universalink Configurations","description":"Universalink Configurations Schema","additionalProperties":false,"required":["details"],"properties":{"apps":{"description":"Always empty [] for UniversaLink, can be omitted in later versions","type":"array","const":[]},"details":{"type":"array","description":"AppIDs's Universalink URI Matching Configuration","minItems":1,"items":{"title":"AppID's matching details","description":"Details of specific AppIDs uri matching configuration","type":"object","additionalProperties":false,"properties":{"appIDs":{"title":"AppIDs","description":"Array of AppIDs","type":"array","uniqueItems":true,"minItems":1,"items":{"$ref":"#/$defs/app_id"}},"appID":{"$ref":"#/$defs/app_id"},"paths":{"title":"Paths","description":"Array of paths to be matched against","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"string","title":"Path","description":"Single unique path to be matched against"}},"components":{"type":"array","title":"URI Components","description":"Array of path components to be matched, available in later versions","minItems":1,"items":{"$ref":"#/$defs/component"}}}}}}}}}
|
Provide a JSON object that satisfies the schema "Apple Universal Links Config". Here are the required top‑level fields: applinks. Return only the valid JSON object.
|
Apple Universal Links Config
|
schema-store
|
schema_store_44
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema\",\"title\":\".appsemblerc.yaml\",\"description\":\"A .appsemblerc.yaml file may be used to configure either an app or a block.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"description\":\"The name of a block. By default the name in package.json is used.\",\"type\":\"string\",\"pattern\":\"^@([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)/([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\"},\"description\":{\"description\":\"A short description of the block. By default the description in package.json is used.\",\"maxLength\":160},\"version\":{\"description\":\"A semantic version of the block representation of the block version. By default the version in package.json is used.\"},\"longDescription\":{\"description\":\"The long description of the block. Markdown is supported. By default the content of README.md is used.\",\"type\":\"string\"},\"layout\":{\"description\":\"The type of layout to be used for the block.\",\"enum\":[\"float\",\"grow\",\"hidden\",\"static\",null],\"default\":\"static\"},\"output\":{\"description\":\"Where to read build output from.\",\"type\":\"string\",\"default\":\"dist\"},\"webpack\":{\"description\":\"The path to the webpack configuration file relative to the block project directory. By default a file named webpack.config.js is used, with a fallback to the webpack configuration from @appsemble/webpack-config.\",\"type\":\"string\"},\"events\":{\"type\":\"object\",\"description\":\"An object describing the names of the events the block can listen and emit to. By default this is extracted from the block\\u2019s TypeScript module augmentations.\",\"additionalProperties\":false,\"properties\":{\"listen\":{\"description\":\"The events the block listens on.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\"}}}},\"emit\":{\"description\":\"The events the block may emit.\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"description\":{\"type\":\"string\"}}}}}},\"actions\":{\"description\":\"An object which describes the actions a block can trigger. This will be used to validate app definitions. By default this is extracted from the block\\u2019s TypeScript module augmentations.\",\"type\":\"object\",\"additionalProperties\":true},\"parameters\":{\"description\":\"A JSON schema which describes the block parameters. By default this is extracted from the block\\u2019s TypeScript module augmentations.\"},\"iconBackground\":{\"description\":\"The background color to use for maskable icons.\",\"type\":\"string\",\"pattern\":\"^#[a-zA-Z\\\\d]{6}$\"},\"context\":{\"type\":\"object\",\"description\":\"A context which can be specified using the --context command line parameter.\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"remote\":{\"description\":\"The remote the app should be under.\\n\\nIf remote is specified, this will override --remote passed on the command line.\",\"type\":\"string\",\"format\":\"uri\",\"default\":\"https://appsemble.app\"},\"organization\":{\"description\":\"The organization ID the app should be under.\\n\\nIf organization is specified, this will override --organization passed on the command line.\",\"type\":\"string\",\"pattern\":\"^([\\\\da-z](?:(?!.*--)[\\\\da-z-]*[\\\\da-z])?)$\",\"minLength\":1,\"maxLength\":30},\"icon\":{\"description\":\"The path to the app icon to use.\\n\\nIf icon is specified, this will override --icon passed on the command line.\",\"type\":\"string\",\"default\":\"icon.png\"},\"iconBackground\":{\"description\":\"The background color to use for maskable icons.\\n\\nIf iconBackground is specified, this will override --icon-background passed on the command line.\",\"type\":\"string\",\"pattern\":\"^#[a-zA-Z\\\\d]{6}$\"},\"maskableIcon\":{\"description\":\"The path to the maskable app icon to use.\\n\\nIf maskableIcon is specified, this will override --maskable-icon passed on the command line.\",\"type\":\"string\",\"default\":\"maskable-icon.png\"},\"id\":{\"description\":\"The id of the app to update.\\n\\nIf id is specified, this will override --id passed on the command line.\",\"type\":\"integer\",\"minimum\":1},\"variant\":{\"description\":\"The alternative app variant to use instead.\\n\\nIf variant is specified, this will override --variant passed on the command line.\",\"type\":\"string\"},\"visibility\":{\"description\":\"Determine the app visibility of the app in the Appsemble app store.\\n\\nThis doesn\\u2019t affect whether or not the app can be accessed on its own domain.\\n\\n- public: The app is publicly listed in the Appsemble app store.\\n- unlisted: The app store page can be accessed, but the app isn\\u2019t listed publicly in the Appsemble app store.\\n- private: The app is only visible to people who are part of the organization.\\n\\nIf visibility is specified, this will override --visibility passed on the command line.\",\"default\":\"unlisted\",\"enum\":[\"public\",\"unlisted\",\"private\"]},\"showAppDefinition\":{\"description\":\"Whether the app-definition should be shown.\\n\\nIf showAppDefinition is specified, this will override --show-app-definition passed on the command line.\",\"type\":\"boolean\"},\"template\":{\"description\":\"Whether the app should be a template app.\\n\\nIf template is specified, this will override --template passed on the command line.\",\"type\":\"boolean\",\"default\":false},\"sentryDsn\":{\"type\":\"string\",\"format\":\"uri\",\"description\":\"The custom Sentry DSN for the app.\\n\\nIf sentryDsn is specified, this will override --sentry-dsn passed on the command line.\"},\"sentryEnvironment\":{\"type\":\"string\",\"description\":\"The custom Sentry environment to use for the app.\\n\\nIf sentryEnvironment is specified, this will override --sentry-environment passed on the command line.\"},\"demoMode\":{\"type\":\"boolean\",\"description\":\"Whether the app should be in demoMode.\\n\\nIf demoMode is specified, this will override --demo-mode passed on the command line.\"},\"appLock\":{\"enum\":[\"fullLock\",\"studioLock\",\"unlocked\"],\"description\":\"Set the value of AppLock for your app.\\n\\nIf appLock is specified, this will override --app-lock passed on the command line.\"},\"collections\":{\"type\":\"array\",\"items\":[{\"type\":\"integer\",\"description\":\"The app collection id.\"}],\"description\":\"A list of collections the app should be added to.\\n\\nIf collections is specified, this will override --collections passed on the command line.\"},\"googleAnalyticsId\":{\"type\":\"string\",\"description\":\"The Google Analytics ID that should be used for the app.\\n\\nIf googleAnalyticsId is specified, this will override --google-analytics-id passed on the command line.\"},\"resources\":{\"type\":\"boolean\",\"description\":\"Whether to publish resources from the resources directory.\\n\\nIf resources is specified, this will override --resources passed on the command line.\"},\"assets\":{\"type\":\"boolean\",\"description\":\"Whether to publish assets from the assets directory.\\n\\nIf assets is specified, this will override --assets passed on the command line.\"},\"assetsClonable\":{\"type\":\"boolean\",\"description\":\"Whether app assets should be clonable.\\n\\nIf assetsClonable is specified, this will override --assets-clonable passed on the command line.\"}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \".appsemblerc.yaml\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema","title":".appsemblerc.yaml","description":"A .appsemblerc.yaml file may be used to configure either an app or a block.","type":"object","additionalProperties":false,"properties":{"name":{"description":"The name of a block. By default the name in package.json is used.","type":"string","pattern":"^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"},"description":{"description":"A short description of the block. By default the description in package.json is used.","maxLength":160},"version":{"description":"A semantic version of the block representation of the block version. By default the version in package.json is used."},"longDescription":{"description":"The long description of the block. Markdown is supported. By default the content of README.md is used.","type":"string"},"layout":{"description":"The type of layout to be used for the block.","enum":["float","grow","hidden","static",null],"default":"static"},"output":{"description":"Where to read build output from.","type":"string","default":"dist"},"webpack":{"description":"The path to the webpack configuration file relative to the block project directory. By default a file named webpack.config.js is used, with a fallback to the webpack configuration from @appsemble/webpack-config.","type":"string"},"events":{"type":"object","description":"An object describing the names of the events the block can listen and emit to. By default this is extracted from the block\u2019s TypeScript module augmentations.","additionalProperties":false,"properties":{"listen":{"description":"The events the block listens on.","type":"object","additionalProperties":{"type":"object","properties":{"description":{"type":"string"}}}},"emit":{"description":"The events the block may emit.","type":"object","additionalProperties":{"type":"object","properties":{"description":{"type":"string"}}}}}},"actions":{"description":"An object which describes the actions a block can trigger. This will be used to validate app definitions. By default this is extracted from the block\u2019s TypeScript module augmentations.","type":"object","additionalProperties":true},"parameters":{"description":"A JSON schema which describes the block parameters. By default this is extracted from the block\u2019s TypeScript module augmentations."},"iconBackground":{"description":"The background color to use for maskable icons.","type":"string","pattern":"^#[a-zA-Z\\d]{6}$"},"context":{"type":"object","description":"A context which can be specified using the --context command line parameter.","additionalProperties":{"type":"object","additionalProperties":false,"properties":{"remote":{"description":"The remote the app should be under.\n\nIf remote is specified, this will override --remote passed on the command line.","type":"string","format":"uri","default":"https://appsemble.app"},"organization":{"description":"The organization ID the app should be under.\n\nIf organization is specified, this will override --organization passed on the command line.","type":"string","pattern":"^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$","minLength":1,"maxLength":30},"icon":{"description":"The path to the app icon to use.\n\nIf icon is specified, this will override --icon passed on the command line.","type":"string","default":"icon.png"},"iconBackground":{"description":"The background color to use for maskable icons.\n\nIf iconBackground is specified, this will override --icon-background passed on the command line.","type":"string","pattern":"^#[a-zA-Z\\d]{6}$"},"maskableIcon":{"description":"The path to the maskable app icon to use.\n\nIf maskableIcon is specified, this will override --maskable-icon passed on the command line.","type":"string","default":"maskable-icon.png"},"id":{"description":"The id of the app to update.\n\nIf id is specified, this will override --id passed on the command line.","type":"integer","minimum":1},"variant":{"description":"The alternative app variant to use instead.\n\nIf variant is specified, this will override --variant passed on the command line.","type":"string"},"visibility":{"description":"Determine the app visibility of the app in the Appsemble app store.\n\nThis doesn\u2019t affect whether or not the app can be accessed on its own domain.\n\n- public: The app is publicly listed in the Appsemble app store.\n- unlisted: The app store page can be accessed, but the app isn\u2019t listed publicly in the Appsemble app store.\n- private: The app is only visible to people who are part of the organization.\n\nIf visibility is specified, this will override --visibility passed on the command line.","default":"unlisted","enum":["public","unlisted","private"]},"showAppDefinition":{"description":"Whether the app-definition should be shown.\n\nIf showAppDefinition is specified, this will override --show-app-definition passed on the command line.","type":"boolean"},"template":{"description":"Whether the app should be a template app.\n\nIf template is specified, this will override --template passed on the command line.","type":"boolean","default":false},"sentryDsn":{"type":"string","format":"uri","description":"The custom Sentry DSN for the app.\n\nIf sentryDsn is specified, this will override --sentry-dsn passed on the command line."},"sentryEnvironment":{"type":"string","description":"The custom Sentry environment to use for the app.\n\nIf sentryEnvironment is specified, this will override --sentry-environment passed on the command line."},"demoMode":{"type":"boolean","description":"Whether the app should be in demoMode.\n\nIf demoMode is specified, this will override --demo-mode passed on the command line."},"appLock":{"enum":["fullLock","studioLock","unlocked"],"description":"Set the value of AppLock for your app.\n\nIf appLock is specified, this will override --app-lock passed on the command line."},"collections":{"type":"array","items":[{"type":"integer","description":"The app collection id."}],"description":"A list of collections the app should be added to.\n\nIf collections is specified, this will override --collections passed on the command line."},"googleAnalyticsId":{"type":"string","description":"The Google Analytics ID that should be used for the app.\n\nIf googleAnalyticsId is specified, this will override --google-analytics-id passed on the command line."},"resources":{"type":"boolean","description":"Whether to publish resources from the resources directory.\n\nIf resources is specified, this will override --resources passed on the command line."},"assets":{"type":"boolean","description":"Whether to publish assets from the assets directory.\n\nIf assets is specified, this will override --assets passed on the command line."},"assetsClonable":{"type":"boolean","description":"Whether app assets should be clonable.\n\nIf assetsClonable is specified, this will override --assets-clonable passed on the command line."}}}}}}
|
Provide a JSON object that satisfies the schema ".appsemblerc.yaml". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
.appsemblerc.yaml
|
schema-store
|
schema_store_45
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema\",\"title\":\"appsettings.StormPetrel.json file schema\",\"description\":\"See more details in Configuration Documentation: https://github.com/Scandltd/storm-petrel/blob/main/generator/README.md#configuration\",\"type\":\"object\",\"definitions\":{\"targetProjectGeneratorExpression\":{\"type\":\"string\",\"description\":\"[optional] string, configures the default `Generator`. An expression for the `IGenerator` instance.\"},\"generatorConfig\":{\"type\":[\"object\",\"null\"],\"description\":\"[optional] object to configure `Generator` behavior.\",\"properties\":{\"BackuperExpression\":{\"type\":[\"string\",\"null\"],\"description\":\"[optional] string, instantiates `GeneratorBackuper` by default. An expression for the `IGeneratorBackuper` instance. Set to 'null' to skip creating backup files.\"},\"DumperExpression\":{\"type\":\"string\",\"description\":\"[optional] string, instantiates `GeneratorDumper` by default. An expression for the `IGeneratorDumper` instance.\"},\"RewriterExpression\":{\"type\":\"string\",\"description\":\"[optional] string, instantiates `GeneratorRewriter` by default. An expression for the `IGeneratorRewriter` instance.\"}}},\"isDisabled\":{\"type\":\"boolean\",\"description\":\"[optional] boolean, false is by default. Indicates whether the generator should create 'StormPetrel' classes. Even if set to 'false', the generator still adds classes like 'IGeneratorDumper', 'GeneratorDumper' to avoid test project compilation failures in the case when custom classes uses them.\"},\"ignoreFilePathRegex\":{\"type\":\"string\",\"description\":\"[optional] string, empty by default. Regular Expression to exclude certain paths from 'StormPetrel' class generation.\"},\"ignoreInvocationExpressionRegex\":{\"type\":\"string\",\"description\":\"[optional] string, empty by default. Regular Expression to detect invocation expressions to not execute StormPetrel rewriting for.\"},\"testVariablePairConfigs\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"ActualVarNameTokenRegex\":{\"type\":\"string\",\"description\":\"Default configuration object. Assumes variable pair names like (expected, actual), (myExpected, myActual), (expectedOne, actualOne), (ExpectedTwo, ActualTwo), etc.\"},\"ExpectedVarNameTokenRegex\":{\"type\":[\"string\",\"null\"],\"description\":\"Corresponds to the `ActualVarNameTokenRegex` for pairing.\"}}},\"description\":\"[optional] array of objects. Configures naming pairs for actual/expected variables to generate correct expected baselines.\"},\"serilog\":{\"type\":[\"object\",\"null\"],\"description\":\"[optional] Logging configuration using Serilog. Defaults to logging warnings to the test project's Logs folder. Set to 'null' to disable logging. Use the '{StormPetrelRootPath}' token to indicate the target test project root path.\"}},\"properties\":{\"TargetProjectGeneratorExpression\":{\"$ref\":\"#/definitions/targetProjectGeneratorExpression\"},\"GeneratorConfig\":{\"$ref\":\"#/definitions/generatorConfig\"},\"IsDisabled\":{\"$ref\":\"#/definitions/isDisabled\"},\"IgnoreFilePathRegex\":{\"$ref\":\"#/definitions/ignoreFilePathRegex\"},\"IgnoreInvocationExpressionRegex\":{\"$ref\":\"#/definitions/ignoreInvocationExpressionRegex\"},\"TestVariablePairConfigs\":{\"$ref\":\"#/definitions/testVariablePairConfigs\"}},\"patternProperties\":{\"^(Serilog|serilog)$\":{\"$ref\":\"#/definitions/serilog\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"appsettings.StormPetrel.json file schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema","title":"appsettings.StormPetrel.json file schema","description":"See more details in Configuration Documentation: https://github.com/Scandltd/storm-petrel/blob/main/generator/README.md#configuration","type":"object","definitions":{"targetProjectGeneratorExpression":{"type":"string","description":"[optional] string, configures the default `Generator`. An expression for the `IGenerator` instance."},"generatorConfig":{"type":["object","null"],"description":"[optional] object to configure `Generator` behavior.","properties":{"BackuperExpression":{"type":["string","null"],"description":"[optional] string, instantiates `GeneratorBackuper` by default. An expression for the `IGeneratorBackuper` instance. Set to 'null' to skip creating backup files."},"DumperExpression":{"type":"string","description":"[optional] string, instantiates `GeneratorDumper` by default. An expression for the `IGeneratorDumper` instance."},"RewriterExpression":{"type":"string","description":"[optional] string, instantiates `GeneratorRewriter` by default. An expression for the `IGeneratorRewriter` instance."}}},"isDisabled":{"type":"boolean","description":"[optional] boolean, false is by default. Indicates whether the generator should create 'StormPetrel' classes. Even if set to 'false', the generator still adds classes like 'IGeneratorDumper', 'GeneratorDumper' to avoid test project compilation failures in the case when custom classes uses them."},"ignoreFilePathRegex":{"type":"string","description":"[optional] string, empty by default. Regular Expression to exclude certain paths from 'StormPetrel' class generation."},"ignoreInvocationExpressionRegex":{"type":"string","description":"[optional] string, empty by default. Regular Expression to detect invocation expressions to not execute StormPetrel rewriting for."},"testVariablePairConfigs":{"type":"array","items":{"type":"object","properties":{"ActualVarNameTokenRegex":{"type":"string","description":"Default configuration object. Assumes variable pair names like (expected, actual), (myExpected, myActual), (expectedOne, actualOne), (ExpectedTwo, ActualTwo), etc."},"ExpectedVarNameTokenRegex":{"type":["string","null"],"description":"Corresponds to the `ActualVarNameTokenRegex` for pairing."}}},"description":"[optional] array of objects. Configures naming pairs for actual/expected variables to generate correct expected baselines."},"serilog":{"type":["object","null"],"description":"[optional] Logging configuration using Serilog. Defaults to logging warnings to the test project's Logs folder. Set to 'null' to disable logging. Use the '{StormPetrelRootPath}' token to indicate the target test project root path."}},"properties":{"TargetProjectGeneratorExpression":{"$ref":"#/definitions/targetProjectGeneratorExpression"},"GeneratorConfig":{"$ref":"#/definitions/generatorConfig"},"IsDisabled":{"$ref":"#/definitions/isDisabled"},"IgnoreFilePathRegex":{"$ref":"#/definitions/ignoreFilePathRegex"},"IgnoreInvocationExpressionRegex":{"$ref":"#/definitions/ignoreInvocationExpressionRegex"},"TestVariablePairConfigs":{"$ref":"#/definitions/testVariablePairConfigs"}},"patternProperties":{"^(Serilog|serilog)$":{"$ref":"#/definitions/serilog"}}}
|
Provide a JSON object that satisfies the schema "appsettings.StormPetrel.json file schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
appsettings.StormPetrel.json file schema
|
schema-store
|
schema_store_46
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"webOptimizer\":{\"title\":\"web optimizer\",\"type\":\"object\",\"description\":\"Settings for WebOptimizer.Core\",\"properties\":{\"enableCaching\":{\"description\":\"Determines if the \\\"cache-control\\\" HTTP headers should be set and if conditional GET (304) requests should be supported. This could be helpful to disable while in development mode.\",\"type\":\"boolean\"},\"enableTagHelperBundling\":{\"description\":\"Determines if `<script>` and `<link>` elements should point to the bundled path or a reference per source file should be created. This is helpful to disable when in development mode.\",\"type\":\"boolean\",\"default\":true}}},\"cdn\":{\"title\":\"CDN\",\"type\":\"object\",\"description\":\"Definitions for WebEssentials.AspNetCore.CdnTagHelpers\",\"properties\":{\"url\":{\"description\":\"An absolute URL used as a prefix for static resources\",\"type\":\"string\",\"pattern\":\"^((//|https?://).+|)$\"},\"prefetch\":{\"description\":\"If true, injects a <link rel='dns-prefetch'> tag that speeds up DNS resolution to the CDN.\",\"type\":\"boolean\",\"default\":true}}},\"pwa\":{\"properties\":{\"cacheId\":{\"description\":\"The cache identifier of the service worker (can be any string). Change this property to force the service worker to reload in browsers.\",\"type\":\"string\",\"default\":\"v1.0\"},\"offlineRoute\":{\"description\":\"The route to the page to show when offline.\",\"type\":\"string\",\"default\":\"/offline.html\"},\"registerServiceWorker\":{\"description\":\"Determines if a script that registers the service worker should be injected into the bottom of the HTML page.\",\"type\":\"boolean\",\"default\":true},\"registerWebmanifest\":{\"description\":\"Determines if a meta tag that points to the web manifest should be inserted at the end of the head element.\",\"type\":\"boolean\",\"default\":true},\"routesToPreCache\":{\"description\":\"A comma separated list of routes to pre-cache when service worker installs in the browser.\",\"type\":\"string\",\"default\":\"\"},\"strategy\":{\"description\":\"Selects one of the predefined service worker types.\",\"enum\":[\"cacheFirst\",\"cacheFirstSafe\",\"minimal\",\"networkFirst\"],\"default\":\"cacheFirstSafe\"}}},\"ElmahIo\":{\"properties\":{\"ApiKey\":{\"description\":\"An elmah.io API key with the Messages | Write permission.\",\"type\":\"string\",\"pattern\":\"^([0-9a-f]{32})|(#\\\\{.*\\\\}#?)$\"},\"LogId\":{\"description\":\"The Id of the elmah.io log to store messages in.\",\"type\":\"string\",\"pattern\":\"^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(#\\\\{.*\\\\}#?)$\"},\"Application\":{\"description\":\"An application name to put on all error messages.\",\"type\":\"string\"},\"HandledStatusCodesToLog\":{\"description\":\"A list of HTTP status codes (besides 404) to log even though no exception is thrown.\",\"type\":\"array\",\"items\":{\"type\":\"integer\"}},\"TreatLoggingAsBreadcrumbs\":{\"description\":\"Include log messages from Microsoft.Extensions.Logging as breadcrumbs.\",\"type\":\"boolean\"},\"HeartbeatId\":{\"description\":\"The Id of the elmah.io heartbeat to notify.\",\"type\":\"string\",\"pattern\":\"^([0-9a-f]{32})|(#\\\\{.*\\\\}#?)$\"}},\"required\":[\"ApiKey\",\"LogId\"]},\"protocols\":{\"description\":\"The protocols enabled on the endpoint.\",\"type\":\"string\",\"enum\":[\"None\",\"Http1\",\"Http2\",\"Http1AndHttp2\",\"Http3\",\"Http1AndHttp2AndHttp3\"]},\"certificate\":{\"title\":\"certificate\",\"description\":\"Certificate configuration.\",\"type\":\"object\",\"properties\":{\"Path\":{\"description\":\"The certificate file path. If a file path is specified then the certificate will be loaded from the file system.\",\"type\":\"string\"},\"KeyPath\":{\"description\":\"The certificate key file path. Available in .NET 5 and later.\",\"type\":\"string\"},\"Password\":{\"description\":\"The certificate password used to access the private key.\",\"type\":\"string\"},\"Subject\":{\"description\":\"The certificate subject. If a subject is specified then the certificate will be loaded from the certificate store.\",\"type\":\"string\"},\"Store\":{\"description\":\"The certificate store name. Defaults to 'My'.\",\"type\":\"string\",\"default\":\"My\"},\"Location\":{\"description\":\"The certificate store location. Defaults to 'CurrentUser'.\",\"type\":\"string\",\"enum\":[\"LocalMachine\",\"CurrentUser\"],\"default\":\"CurrentUser\"},\"AllowInvalid\":{\"description\":\"A value indicating whether or not to load certificates that are considered invalid. Defaults to false.\",\"type\":\"boolean\",\"default\":false}}},\"sslProtocols\":{\"description\":\"Specifies allowable SSL protocols. Defaults to 'None' which allows the operating system to choose the best protocol to use, and to block protocols that are not secure. Unless your app has a specific reason not to, you should use this default. Available in .NET 5 and later.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"None\",\"Tls\",\"Tls11\",\"Tls12\",\"Tls13\"],\"default\":\"None\"}},\"clientCertificateMode\":{\"description\":\"Specifies the client certificate requirements for a HTTPS connection. Defaults to 'NoCertificate'. Available in .NET 5 and later.\",\"type\":\"string\",\"enum\":[\"NoCertificate\",\"AllowCertificate\",\"RequireCertificate\"],\"default\":\"NoCertificate\"},\"kestrel\":{\"title\":\"kestrel\",\"type\":\"object\",\"description\":\"ASP.NET Core Kestrel server configuration.\",\"properties\":{\"Endpoints\":{\"title\":\"endpoints\",\"description\":\"Endpoints that Kestrel listens to for network requests. Each endpoint has a name specified by its JSON property name.\",\"type\":\"object\",\"additionalProperties\":{\"title\":\"endpoint options\",\"description\":\"Kestrel endpoint configuration.\",\"type\":\"object\",\"properties\":{\"Url\":{\"description\":\"The scheme, host name, and port the endpoint will listen on. A Url is required.\",\"type\":\"string\",\"format\":\"uri\"},\"Protocols\":{\"$ref\":\"#/definitions/protocols\"},\"SslProtocols\":{\"$ref\":\"#/definitions/sslProtocols\"},\"Certificate\":{\"$ref\":\"#/definitions/certificate\"},\"ClientCertificateMode\":{\"$ref\":\"#/definitions/clientCertificateMode\"},\"Sni\":{\"title\":\"SNI\",\"description\":\"Server Name Indication (SNI) configuration. This enables the mapping of client requested host names to certificates and other TLS settings. Wildcard names prefixed with '*.', as well as a top level '*' are supported. Available in .NET 5 and later.\",\"type\":\"object\",\"additionalProperties\":{\"title\":\"SNI options\",\"description\":\"Endpoint SNI configuration.\",\"type\":\"object\",\"properties\":{\"Protocols\":{\"$ref\":\"#/definitions/protocols\"},\"SslProtocols\":{\"$ref\":\"#/definitions/sslProtocols\"},\"Certificate\":{\"$ref\":\"#/definitions/certificate\"},\"ClientCertificateMode\":{\"$ref\":\"#/definitions/clientCertificateMode\"}}}}},\"required\":[\"Url\"]}},\"EndpointDefaults\":{\"title\":\"endpoint defaults\",\"description\":\"Default configuration applied to all endpoints. Named endpoint specific configuration overrides defaults.\",\"type\":\"object\",\"properties\":{\"Protocols\":{\"$ref\":\"#/definitions/protocols\"},\"SslProtocols\":{\"$ref\":\"#/definitions/sslProtocols\"},\"ClientCertificateMode\":{\"$ref\":\"#/definitions/clientCertificateMode\"}}},\"Certificates\":{\"title\":\"certificates\",\"description\":\"Certificates that Kestrel uses with HTTPS endpoints. Each certificate has a name specified by its JSON property name. The 'Default' certificate is used by HTTPS endpoints that haven't specified a certificate.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/certificate\"}}}},\"logLevelThreshold\":{\"description\":\"Log level threshold.\",\"type\":\"string\",\"enum\":[\"Trace\",\"Debug\",\"Information\",\"Warning\",\"Error\",\"Critical\",\"None\"]},\"logLevel\":{\"title\":\"logging level options\",\"description\":\"Log level configurations used when creating logs. Only logs that exceeds its matching log level will be enabled. Each log level configuration has a category specified by its JSON property name. For more information about configuring log levels, see https://docs.microsoft.com/aspnet/core/fundamentals/logging/#configure-logging.\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/logLevelThreshold\"}},\"logging\":{\"title\":\"logging options\",\"type\":\"object\",\"description\":\"Configuration for Microsoft.Extensions.Logging.\",\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"},\"Console\":{\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"},\"FormatterName\":{\"description\":\"Name of the log message formatter to use. Defaults to 'simple'.\",\"type\":\"string\",\"default\":\"simple\"},\"FormatterOptions\":{\"title\":\"formatter options\",\"description\":\"Log message formatter options. Additional properties are available on the options depending on the configured formatter. The formatter is specified by FormatterName.\",\"type\":\"object\",\"properties\":{\"IncludeScopes\":{\"description\":\"Include scopes when true. Defaults to false.\",\"type\":\"boolean\",\"default\":false},\"TimestampFormat\":{\"description\":\"Format string used to format timestamp in logging messages. Defaults to null.\",\"type\":\"string\"},\"UseUtcTimestamp\":{\"description\":\"Indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to false.\",\"type\":\"boolean\",\"default\":false}}},\"LogToStandardErrorThreshold\":{\"$ref\":\"#/definitions/logLevelThreshold\",\"description\":\"The minimum level of messages are written to Console.Error.\"}}},\"EventSource\":{\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"}}},\"Debug\":{\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"}}},\"EventLog\":{\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"}}},\"ElmahIo\":{\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"}}},\"ElmahIoBreadcrumbs\":{\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"}}}},\"additionalProperties\":{\"title\":\"provider logging settings\",\"type\":\"object\",\"description\":\"Logging configuration for a provider. The provider name must match the configuration's JSON property property name.\",\"properties\":{\"LogLevel\":{\"$ref\":\"#/definitions/logLevel\"}}}},\"allowedHosts\":{\"description\":\"ASP.NET Core host filtering middleware configuration. Allowed hosts is a semicolon-delimited list of host names without port numbers. Requests without a matching host name will be refused. Host names may be prefixed with a '*.' wildcard, or use '*' to allow all hosts.\",\"type\":\"string\"},\"connectionStrings\":{\"title\":\"connection string options\",\"description\":\"Connection string configuration. Get connection strings with the IConfiguration.GetConnectionString(string) extension method.\",\"type\":\"object\",\"additionalProperties\":{\"description\":\"Connection string configuration. Each connection string has a name specified by its JSON property name.\",\"type\":\"string\"}},\"NLog\":{\"title\":\"NLog options\",\"type\":\"object\",\"description\":\"NLog configuration\",\"default\":{},\"properties\":{\"autoReload\":{\"type\":\"boolean\",\"description\":\"Automatically reload the NLog configuration when notified that appsettings.json file has changed.\",\"default\":false},\"throwConfigExceptions\":{\"type\":[\"boolean\",\"null\"],\"description\":\"Throws an exception when there is a config error? If not set, then throwExceptions will be used for this setting.\",\"default\":false},\"throwExceptions\":{\"type\":\"boolean\",\"description\":\"Throws an exception when there is an error. For unit testing only and advanced troubleshooting.\",\"default\":false},\"internalLogLevel\":{\"type\":\"string\",\"description\":\"The minimal log level for the internal logger.\",\"enum\":[\"Trace\",\"Debug\",\"Info\",\"Warn\",\"Error\",\"Fatal\",\"Off\"],\"default\":\"Off\"},\"internalLogFile\":{\"type\":\"string\",\"description\":\"Write internal log to the specified filepath\"},\"internalLogToConsole\":{\"type\":\"boolean\",\"description\":\"Write internal log to a console\",\"default\":\"false\"},\"internalLogToConsoleError\":{\"type\":\"boolean\",\"description\":\"Write internal log to a console with error stream\",\"default\":\"false\"},\"globalThreshold\":{\"type\":\"string\",\"description\":\"Log events below this threshold are not logged.\",\"enum\":[\"Trace\",\"Debug\",\"Info\",\"Warn\",\"Error\",\"Fatal\",\"Off\"],\"default\":\"Off\"},\"autoShutdown\":{\"type\":\"boolean\",\"description\":\"Automatically call `LogFactory.Shutdown` on AppDomain.Unload or AppDomain.ProcessExit\",\"default\":\"true\"},\"extensions\":{\"type\":\"array\",\"description\":\"Load NLog extension packages for additional targets and layouts\",\"default\":[],\"items\":{\"title\":\"extension\",\"type\":\"object\",\"description\":\"\",\"default\":{},\"properties\":{\"assembly\":{\"type\":\"string\",\"description\":\"Assembly Name of the NLog extension package.\"},\"prefix\":{\"type\":\"string\",\"description\":\"Appends prefix to all type-names loaded from the assembly\",\"default\":\"\"},\"assemblyFile\":{\"type\":\"string\",\"description\":\"Absolute filepath to the Assembly-file of the NLog extension package.\",\"default\":\"\"}}}},\"variables\":{\"title\":\"variables\",\"type\":\"object\",\"description\":\"Key-value pair of variables\",\"propertyNames\":{\"pattern\":\"^[A-Za-z0-9_.-]+$\"},\"patternProperties\":{\".*\":{\"type\":[\"number\",\"string\",\"boolean\"]}}},\"targetDefaultWrapper\":{\"title\":\"default wrapper\",\"type\":\"object\",\"description\":\"Wrap all defined targets with this custom target wrapper.\",\"default\":{},\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"\"}}},\"targets\":{\"title\":\"targets\",\"type\":\"object\",\"description\":\"\",\"default\":{},\"properties\":{\"async\":{\"type\":\"boolean\",\"description\":\"Wrap all defined targets using AsyncWrapper with OverflowAction=Discard for better performance.\"}}},\"rules\":{\"oneOf\":[{\"type\":\"array\",\"description\":\"\",\"default\":[],\"items\":{\"$ref\":\"#/definitions/NLogRulesItem\"}},{\"title\":\"rules\",\"type\":\"object\",\"propertyNames\":{\"pattern\":\"^[0-9]+$\"},\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/NLogRulesItem\"}}}]}}},\"NLogRulesItem\":{\"title\":\"NLog rule item\",\"type\":\"object\",\"description\":\"Redirect LogEvents from matching Logger objects to specified targets\",\"default\":{},\"required\":[\"logger\"],\"properties\":{\"logger\":{\"type\":\"string\",\"description\":\"Match Logger objects based on their Logger-name. Can use wildcard characters ('*' or '?').\"},\"ruleName\":{\"type\":\"string\",\"description\":\"Rule identifier to allow rule lookup with Configuration.FindRuleByName and Configuration.RemoveRuleByName.\"},\"level\":{\"anyOf\":[{\"type\":\"string\",\"description\":\"\",\"enum\":[\"Trace\",\"Debug\",\"Info\",\"Warn\",\"Error\",\"Fatal\"]},{\"type\":\"string\"}]},\"levels\":{\"type\":\"string\",\"description\":\"Comma separated list of levels that this rule matches.\"},\"minLevel\":{\"anyOf\":[{\"type\":\"string\",\"description\":\"\",\"enum\":[\"Trace\",\"Debug\",\"Info\",\"Warn\",\"Error\",\"Fatal\"]},{\"type\":\"string\"}]},\"maxLevel\":{\"anyOf\":[{\"type\":\"string\",\"description\":\"\",\"enum\":[\"Trace\",\"Debug\",\"Info\",\"Warn\",\"Error\",\"Fatal\"]},{\"type\":\"string\"}]},\"finalMinLevel\":{\"anyOf\":[{\"type\":\"string\",\"description\":\"\",\"enum\":[\"Trace\",\"Debug\",\"Info\",\"Warn\",\"Error\",\"Fatal\"]},{\"type\":\"string\"}]},\"writeTo\":{\"type\":\"string\",\"description\":\"Name or names of a target - separated by comma. Remove this property for sending events to the blackhole.\"},\"final\":{\"type\":\"boolean\",\"description\":\"Ignore further rules if this one matches.\",\"default\":false},\"enabled\":{\"type\":\"boolean\",\"description\":\"\",\"default\":true},\"filters\":{\"oneOf\":[{\"type\":\"array\",\"description\":\"\",\"default\":[],\"items\":{\"title\":\"filter\",\"type\":\"object\",\"description\":\"\",\"default\":{},\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"\"},\"action\":{\"type\":\"string\",\"description\":\"Result action when filter matches logevent.\",\"enum\":[\"Neutral\",\"Log\",\"Ignore\",\"LogFinal\",\"IgnoreFinal\"],\"default\":\"Neutral\"}}}},{\"title\":\"filter\",\"type\":\"object\",\"description\":\"\",\"default\":{}}]},\"filterDefaultAction\":{\"type\":\"string\",\"description\":\"Default action if none of the filters match.\",\"enum\":[\"Neutral\",\"Log\",\"Ignore\",\"LogFinal\",\"IgnoreFinal\"],\"default\":\"Ignore\"}}},\"Serilog\":{\"type\":\"object\",\"title\":\"Serilog appSettings\",\"description\":\"Serilog appSettings Configuration\",\"properties\":{\"$schema\":{\"type\":\"string\",\"title\":\"Schema\",\"description\":\"Pointer to the schema against which this document should be validated.\"},\"Using\":{\"type\":\"array\",\"title\":\"List of Auto-discovery of configuration assemblies\",\"description\":\"Using section contains list of assemblies in which configuration methods. Can be required depending of the project type: See: https://github.com/serilog/serilog-settings-configuration#using-section-and-auto-discovery-of-configuration-assemblies\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/Serilog/definitions/AssemblyReference\"}},\"LevelSwitches\":{\"type\":\"object\",\"patternProperties\":{\"^(?<SerilogLevelSwitcherName>\\\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$\":{\"$ref\":\"#/definitions/Serilog/definitions/SerilogLogEventLevel\"}},\"additionalProperties\":false},\"FilterSwitches\":{\"type\":\"object\",\"patternProperties\":{\"^(?<SerilogLevelSwitcherName>\\\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$\":{\"type\":\"string\"}},\"additionalProperties\":false},\"MinimumLevel\":{\"type\":[\"string\",\"object\"],\"title\":\"Minimum LogLevel Threshold\",\"description\":\"Minimum LogLevel Threshold. (Support dynamic reload if the underlying IConfigurationProvider supports it)\",\"oneOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/SerilogLogEventLevel\"},{\"$ref\":\"#/definitions/Serilog/definitions/DetailedMinimumLevel\"}]},\"Properties\":{\"type\":\"object\",\"title\":\"Log events Properties\",\"description\":\"This section defines a static list of key-value pairs that will enrich log events.\",\"additionalProperties\":{\"type\":\"string\"}},\"Enrich\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReference\"}],\"title\":\"Log events Enriches\",\"description\":\"This section defines Enriches that will be applied to log events.\"},\"Destructure\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReference\"}],\"title\":\"Log events Destructure\",\"description\":\"This section defines Destructure.\"},\"Filter\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReference\"}],\"title\":\"Log events filters\",\"description\":\"This section defines filters that will be applied to log events.\"},\"WriteTo\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReference\"}],\"title\":\"Configuration for log destination\",\"description\":\"This section configures the sinks that log events will be emitted to.\"},\"AuditTo\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReference\"}],\"title\":\"Configuration for log destination for auditing\",\"description\":\"This section configures sinks for auditing, instead of regular (safe) logging. Obs: When auditing is used, exceptions from sinks and any intermediate filters propagate back to the caller.\"}},\"patternProperties\":{\"^Enrich:((?<EnvironmentVariableName>[a-zA-Z_]\\\\w*)|(?<ArrayIndex>\\\\d*))$\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"}],\"title\":\"Log events Enriches\",\"description\":\"This section defines Enriches that will be applied to log events.\"},\"^Destructure:((?<EnvironmentVariableName>[a-zA-Z_]\\\\w*)|(?<ArrayIndex>\\\\d*))$\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"}],\"title\":\"Log events Destructure\",\"description\":\"This section defines Destructure.\"},\"^Filter:((?<EnvironmentVariableName>[a-zA-Z_]\\\\w*)|(?<ArrayIndex>\\\\d*))$\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"}],\"title\":\"Log events filters\",\"description\":\"This section defines filters that will be applied to log events.\"},\"^WriteTo:((?<EnvironmentVariableName>[a-zA-Z_]\\\\w*)|(?<ArrayIndex>\\\\d*))$\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"}],\"title\":\"Configuration for log destination\",\"description\":\"This section configures the sinks that log events will be emitted to.\"},\"^AuditTo:((?<EnvironmentVariableName>[a-zA-Z_]\\\\w*)|(?<ArrayIndex>\\\\d*))$\":{\"allOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"}],\"title\":\"Configuration for log destination for auditing\",\"description\":\"This section configures sinks for auditing, instead of regular (safe) logging. Obs: When auditing is used, exceptions from sinks and any intermediate filters propagate back to the caller.\"}},\"additionalProperties\":false,\"definitions\":{\"SerilogLogEventLevel\":{\"type\":\"string\",\"title\":\"Log level\",\"description\":\"Log level threshold.\",\"enum\":[\"Verbose\",\"Debug\",\"Information\",\"Warning\",\"Error\",\"Fatal\"]},\"LoggingLevelSwitch\":{\"type\":\"string\",\"title\":\"LevelSwitches name\",\"description\":\"Log Level Switch string reference.\",\"pattern\":\"^(?<SerilogLevelSwitcherName>\\\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$\"},\"SerilogLogLevelThreshold\":{\"type\":\"string\",\"title\":\"Log Level or LevelSwitches name\",\"description\":\"A Serilog Log Level or a reference to a Log Level Switch name on `LevelSwitches` configuration.\",\"anyOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/SerilogLogEventLevel\"},{\"$ref\":\"#/definitions/Serilog/definitions/LoggingLevelSwitch\"}]},\"DetailedMinimumLevel\":{\"type\":\"object\",\"title\":\"Detailed Log level.\",\"description\":\"Detailed Log level threshold object. Allowing set log levels be overridden per logging source.\",\"properties\":{\"Default\":{\"$ref\":\"#/definitions/Serilog/definitions/SerilogLogLevelThreshold\"},\"ControlledBy\":{\"$ref\":\"#/definitions/Serilog/definitions/LoggingLevelSwitch\"},\"Override\":{\"type\":\"object\",\"title\":\"Logging Source Log level object.\",\"description\":\"Set the Log level threshold or LevelSwitcher reference per Logging Source.\",\"additionalProperties\":{\"$ref\":\"#/definitions/Serilog/definitions/SerilogLogLevelThreshold\"}}},\"additionalProperties\":false},\"AssemblyReference\":{\"type\":\"string\",\"title\":\"Assembly Name\",\"description\":\".NET Assembly Name, without the file extension\",\"minLength\":1,\"pattern\":\"^(?<AssemblyName>\\\\S+)$\"},\"ComplexMethodCallReference\":{\"type\":\"object\",\"properties\":{\"Name\":{\"$ref\":\"#/definitions/Serilog/definitions/CSharpMethodName\"},\"Args\":{\"type\":\"object\",\"patternProperties\":{\"^(?<CSharpMethodArgumentName>[a-zA-Z_]\\\\w*)$\":{}},\"additionalProperties\":false}},\"additionalProperties\":false,\"required\":[\"Name\"]},\"MethodCallReferenceItem\":{\"type\":[\"string\",\"object\",\"null\"],\"oneOf\":[{\"$ref\":\"#/definitions/Serilog/definitions/CSharpMethodName\"},{\"$ref\":\"#/definitions/Serilog/definitions/ComplexMethodCallReference\"}]},\"MethodCallReference\":{\"type\":[\"array\",\"string\",\"object\"],\"minLength\":1,\"pattern\":\"^(?<CSharpMethodName>[a-zA-Z_]\\\\w*)$\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"},\"additionalProperties\":{\"$ref\":\"#/definitions/Serilog/definitions/MethodCallReferenceItem\"}},\"CSharpMethodName\":{\"type\":\"string\",\"title\":\"Method Name\",\"description\":\"A name referring to a C# Class method\",\"minLength\":1,\"pattern\":\"^(?<CSharpMethodName>[a-zA-Z_]\\\\w*)$\"},\"CSharpMethodArgumentName\":{\"type\":\"string\",\"title\":\"Argument Name\",\"description\":\"A name referring to a C# Class method argument\",\"minLength\":1,\"pattern\":\"^(?<CSharpMethodArgumentName>[a-zA-Z_]\\\\w*)$\"},\"EnvironmentVariableName\":{\"type\":\"string\",\"title\":\"Environment Variable Name\",\"description\":\"A name referring to a OS Environment Variable\",\"minLength\":1,\"pattern\":\"^(?<EnvironmentVariableName>[a-zA-Z_]\\\\w*)$\"},\"SerilogLevelSwitcherName\":{\"type\":\"string\",\"title\":\"A Level Switcher Name\",\"description\":\"A name referring to a Serilog Settings Configuration Level Switcher\",\"minLength\":1,\"pattern\":\"^(?<SerilogLevelSwitcherName>\\\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$\"}}}},\"id\":\"https://json.schemastore.org/appsettings.json\",\"patternProperties\":{\"^WebOptimizer$\":{\"$ref\":\"#/definitions/webOptimizer\"},\"^webOptimizer$\":{\"$ref\":\"#/definitions/webOptimizer\"},\"^weboptimizer$\":{\"$ref\":\"#/definitions/webOptimizer\"},\"^(cdn|Cdn)$\":{\"$ref\":\"#/definitions/cdn\"},\"^(pwa|PWA|Pwa)$\":{\"$ref\":\"#/definitions/pwa\"},\"^(ElmahIo|Elmahio|elmahIo|elmahio)$\":{\"$ref\":\"#/definitions/ElmahIo\"},\"^(nlog|Nlog|NLog)$\":{\"$ref\":\"#/definitions/NLog\"},\"^(Serilog|serilog)$\":{\"$ref\":\"#/definitions/Serilog\"}},\"properties\":{\"Kestrel\":{\"$ref\":\"#/definitions/kestrel\"},\"Logging\":{\"$ref\":\"#/definitions/logging\"},\"AllowedHosts\":{\"$ref\":\"#/definitions/allowedHosts\"},\"ConnectionStrings\":{\"$ref\":\"#/definitions/connectionStrings\"}},\"title\":\"JSON schema ASP.NET Core's appsettings.json file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema ASP.NET Core's appsettings.json file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"webOptimizer":{"title":"web optimizer","type":"object","description":"Settings for WebOptimizer.Core","properties":{"enableCaching":{"description":"Determines if the \"cache-control\" HTTP headers should be set and if conditional GET (304) requests should be supported. This could be helpful to disable while in development mode.","type":"boolean"},"enableTagHelperBundling":{"description":"Determines if `<script>` and `<link>` elements should point to the bundled path or a reference per source file should be created. This is helpful to disable when in development mode.","type":"boolean","default":true}}},"cdn":{"title":"CDN","type":"object","description":"Definitions for WebEssentials.AspNetCore.CdnTagHelpers","properties":{"url":{"description":"An absolute URL used as a prefix for static resources","type":"string","pattern":"^((//|https?://).+|)$"},"prefetch":{"description":"If true, injects a <link rel='dns-prefetch'> tag that speeds up DNS resolution to the CDN.","type":"boolean","default":true}}},"pwa":{"properties":{"cacheId":{"description":"The cache identifier of the service worker (can be any string). Change this property to force the service worker to reload in browsers.","type":"string","default":"v1.0"},"offlineRoute":{"description":"The route to the page to show when offline.","type":"string","default":"/offline.html"},"registerServiceWorker":{"description":"Determines if a script that registers the service worker should be injected into the bottom of the HTML page.","type":"boolean","default":true},"registerWebmanifest":{"description":"Determines if a meta tag that points to the web manifest should be inserted at the end of the head element.","type":"boolean","default":true},"routesToPreCache":{"description":"A comma separated list of routes to pre-cache when service worker installs in the browser.","type":"string","default":""},"strategy":{"description":"Selects one of the predefined service worker types.","enum":["cacheFirst","cacheFirstSafe","minimal","networkFirst"],"default":"cacheFirstSafe"}}},"ElmahIo":{"properties":{"ApiKey":{"description":"An elmah.io API key with the Messages | Write permission.","type":"string","pattern":"^([0-9a-f]{32})|(#\\{.*\\}#?)$"},"LogId":{"description":"The Id of the elmah.io log to store messages in.","type":"string","pattern":"^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(#\\{.*\\}#?)$"},"Application":{"description":"An application name to put on all error messages.","type":"string"},"HandledStatusCodesToLog":{"description":"A list of HTTP status codes (besides 404) to log even though no exception is thrown.","type":"array","items":{"type":"integer"}},"TreatLoggingAsBreadcrumbs":{"description":"Include log messages from Microsoft.Extensions.Logging as breadcrumbs.","type":"boolean"},"HeartbeatId":{"description":"The Id of the elmah.io heartbeat to notify.","type":"string","pattern":"^([0-9a-f]{32})|(#\\{.*\\}#?)$"}},"required":["ApiKey","LogId"]},"protocols":{"description":"The protocols enabled on the endpoint.","type":"string","enum":["None","Http1","Http2","Http1AndHttp2","Http3","Http1AndHttp2AndHttp3"]},"certificate":{"title":"certificate","description":"Certificate configuration.","type":"object","properties":{"Path":{"description":"The certificate file path. If a file path is specified then the certificate will be loaded from the file system.","type":"string"},"KeyPath":{"description":"The certificate key file path. Available in .NET 5 and later.","type":"string"},"Password":{"description":"The certificate password used to access the private key.","type":"string"},"Subject":{"description":"The certificate subject. If a subject is specified then the certificate will be loaded from the certificate store.","type":"string"},"Store":{"description":"The certificate store name. Defaults to 'My'.","type":"string","default":"My"},"Location":{"description":"The certificate store location. Defaults to 'CurrentUser'.","type":"string","enum":["LocalMachine","CurrentUser"],"default":"CurrentUser"},"AllowInvalid":{"description":"A value indicating whether or not to load certificates that are considered invalid. Defaults to false.","type":"boolean","default":false}}},"sslProtocols":{"description":"Specifies allowable SSL protocols. Defaults to 'None' which allows the operating system to choose the best protocol to use, and to block protocols that are not secure. Unless your app has a specific reason not to, you should use this default. Available in .NET 5 and later.","type":"array","items":{"type":"string","enum":["None","Tls","Tls11","Tls12","Tls13"],"default":"None"}},"clientCertificateMode":{"description":"Specifies the client certificate requirements for a HTTPS connection. Defaults to 'NoCertificate'. Available in .NET 5 and later.","type":"string","enum":["NoCertificate","AllowCertificate","RequireCertificate"],"default":"NoCertificate"},"kestrel":{"title":"kestrel","type":"object","description":"ASP.NET Core Kestrel server configuration.","properties":{"Endpoints":{"title":"endpoints","description":"Endpoints that Kestrel listens to for network requests. Each endpoint has a name specified by its JSON property name.","type":"object","additionalProperties":{"title":"endpoint options","description":"Kestrel endpoint configuration.","type":"object","properties":{"Url":{"description":"The scheme, host name, and port the endpoint will listen on. A Url is required.","type":"string","format":"uri"},"Protocols":{"$ref":"#/definitions/protocols"},"SslProtocols":{"$ref":"#/definitions/sslProtocols"},"Certificate":{"$ref":"#/definitions/certificate"},"ClientCertificateMode":{"$ref":"#/definitions/clientCertificateMode"},"Sni":{"title":"SNI","description":"Server Name Indication (SNI) configuration. This enables the mapping of client requested host names to certificates and other TLS settings. Wildcard names prefixed with '*.', as well as a top level '*' are supported. Available in .NET 5 and later.","type":"object","additionalProperties":{"title":"SNI options","description":"Endpoint SNI configuration.","type":"object","properties":{"Protocols":{"$ref":"#/definitions/protocols"},"SslProtocols":{"$ref":"#/definitions/sslProtocols"},"Certificate":{"$ref":"#/definitions/certificate"},"ClientCertificateMode":{"$ref":"#/definitions/clientCertificateMode"}}}}},"required":["Url"]}},"EndpointDefaults":{"title":"endpoint defaults","description":"Default configuration applied to all endpoints. Named endpoint specific configuration overrides defaults.","type":"object","properties":{"Protocols":{"$ref":"#/definitions/protocols"},"SslProtocols":{"$ref":"#/definitions/sslProtocols"},"ClientCertificateMode":{"$ref":"#/definitions/clientCertificateMode"}}},"Certificates":{"title":"certificates","description":"Certificates that Kestrel uses with HTTPS endpoints. Each certificate has a name specified by its JSON property name. The 'Default' certificate is used by HTTPS endpoints that haven't specified a certificate.","type":"object","additionalProperties":{"$ref":"#/definitions/certificate"}}}},"logLevelThreshold":{"description":"Log level threshold.","type":"string","enum":["Trace","Debug","Information","Warning","Error","Critical","None"]},"logLevel":{"title":"logging level options","description":"Log level configurations used when creating logs. Only logs that exceeds its matching log level will be enabled. Each log level configuration has a category specified by its JSON property name. For more information about configuring log levels, see https://docs.microsoft.com/aspnet/core/fundamentals/logging/#configure-logging.","type":"object","additionalProperties":{"$ref":"#/definitions/logLevelThreshold"}},"logging":{"title":"logging options","type":"object","description":"Configuration for Microsoft.Extensions.Logging.","properties":{"LogLevel":{"$ref":"#/definitions/logLevel"},"Console":{"properties":{"LogLevel":{"$ref":"#/definitions/logLevel"},"FormatterName":{"description":"Name of the log message formatter to use. Defaults to 'simple'.","type":"string","default":"simple"},"FormatterOptions":{"title":"formatter options","description":"Log message formatter options. Additional properties are available on the options depending on the configured formatter. The formatter is specified by FormatterName.","type":"object","properties":{"IncludeScopes":{"description":"Include scopes when true. Defaults to false.","type":"boolean","default":false},"TimestampFormat":{"description":"Format string used to format timestamp in logging messages. Defaults to null.","type":"string"},"UseUtcTimestamp":{"description":"Indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to false.","type":"boolean","default":false}}},"LogToStandardErrorThreshold":{"$ref":"#/definitions/logLevelThreshold","description":"The minimum level of messages are written to Console.Error."}}},"EventSource":{"properties":{"LogLevel":{"$ref":"#/definitions/logLevel"}}},"Debug":{"properties":{"LogLevel":{"$ref":"#/definitions/logLevel"}}},"EventLog":{"properties":{"LogLevel":{"$ref":"#/definitions/logLevel"}}},"ElmahIo":{"properties":{"LogLevel":{"$ref":"#/definitions/logLevel"}}},"ElmahIoBreadcrumbs":{"properties":{"LogLevel":{"$ref":"#/definitions/logLevel"}}}},"additionalProperties":{"title":"provider logging settings","type":"object","description":"Logging configuration for a provider. The provider name must match the configuration's JSON property property name.","properties":{"LogLevel":{"$ref":"#/definitions/logLevel"}}}},"allowedHosts":{"description":"ASP.NET Core host filtering middleware configuration. Allowed hosts is a semicolon-delimited list of host names without port numbers. Requests without a matching host name will be refused. Host names may be prefixed with a '*.' wildcard, or use '*' to allow all hosts.","type":"string"},"connectionStrings":{"title":"connection string options","description":"Connection string configuration. Get connection strings with the IConfiguration.GetConnectionString(string) extension method.","type":"object","additionalProperties":{"description":"Connection string configuration. Each connection string has a name specified by its JSON property name.","type":"string"}},"NLog":{"title":"NLog options","type":"object","description":"NLog configuration","default":{},"properties":{"autoReload":{"type":"boolean","description":"Automatically reload the NLog configuration when notified that appsettings.json file has changed.","default":false},"throwConfigExceptions":{"type":["boolean","null"],"description":"Throws an exception when there is a config error? If not set, then throwExceptions will be used for this setting.","default":false},"throwExceptions":{"type":"boolean","description":"Throws an exception when there is an error. For unit testing only and advanced troubleshooting.","default":false},"internalLogLevel":{"type":"string","description":"The minimal log level for the internal logger.","enum":["Trace","Debug","Info","Warn","Error","Fatal","Off"],"default":"Off"},"internalLogFile":{"type":"string","description":"Write internal log to the specified filepath"},"internalLogToConsole":{"type":"boolean","description":"Write internal log to a console","default":"false"},"internalLogToConsoleError":{"type":"boolean","description":"Write internal log to a console with error stream","default":"false"},"globalThreshold":{"type":"string","description":"Log events below this threshold are not logged.","enum":["Trace","Debug","Info","Warn","Error","Fatal","Off"],"default":"Off"},"autoShutdown":{"type":"boolean","description":"Automatically call `LogFactory.Shutdown` on AppDomain.Unload or AppDomain.ProcessExit","default":"true"},"extensions":{"type":"array","description":"Load NLog extension packages for additional targets and layouts","default":[],"items":{"title":"extension","type":"object","description":"","default":{},"properties":{"assembly":{"type":"string","description":"Assembly Name of the NLog extension package."},"prefix":{"type":"string","description":"Appends prefix to all type-names loaded from the assembly","default":""},"assemblyFile":{"type":"string","description":"Absolute filepath to the Assembly-file of the NLog extension package.","default":""}}}},"variables":{"title":"variables","type":"object","description":"Key-value pair of variables","propertyNames":{"pattern":"^[A-Za-z0-9_.-]+$"},"patternProperties":{".*":{"type":["number","string","boolean"]}}},"targetDefaultWrapper":{"title":"default wrapper","type":"object","description":"Wrap all defined targets with this custom target wrapper.","default":{},"required":["type"],"properties":{"type":{"type":"string","description":""}}},"targets":{"title":"targets","type":"object","description":"","default":{},"properties":{"async":{"type":"boolean","description":"Wrap all defined targets using AsyncWrapper with OverflowAction=Discard for better performance."}}},"rules":{"oneOf":[{"type":"array","description":"","default":[],"items":{"$ref":"#/definitions/NLogRulesItem"}},{"title":"rules","type":"object","propertyNames":{"pattern":"^[0-9]+$"},"patternProperties":{".*":{"$ref":"#/definitions/NLogRulesItem"}}}]}}},"NLogRulesItem":{"title":"NLog rule item","type":"object","description":"Redirect LogEvents from matching Logger objects to specified targets","default":{},"required":["logger"],"properties":{"logger":{"type":"string","description":"Match Logger objects based on their Logger-name. Can use wildcard characters ('*' or '?')."},"ruleName":{"type":"string","description":"Rule identifier to allow rule lookup with Configuration.FindRuleByName and Configuration.RemoveRuleByName."},"level":{"anyOf":[{"type":"string","description":"","enum":["Trace","Debug","Info","Warn","Error","Fatal"]},{"type":"string"}]},"levels":{"type":"string","description":"Comma separated list of levels that this rule matches."},"minLevel":{"anyOf":[{"type":"string","description":"","enum":["Trace","Debug","Info","Warn","Error","Fatal"]},{"type":"string"}]},"maxLevel":{"anyOf":[{"type":"string","description":"","enum":["Trace","Debug","Info","Warn","Error","Fatal"]},{"type":"string"}]},"finalMinLevel":{"anyOf":[{"type":"string","description":"","enum":["Trace","Debug","Info","Warn","Error","Fatal"]},{"type":"string"}]},"writeTo":{"type":"string","description":"Name or names of a target - separated by comma. Remove this property for sending events to the blackhole."},"final":{"type":"boolean","description":"Ignore further rules if this one matches.","default":false},"enabled":{"type":"boolean","description":"","default":true},"filters":{"oneOf":[{"type":"array","description":"","default":[],"items":{"title":"filter","type":"object","description":"","default":{},"required":["type"],"properties":{"type":{"type":"string","description":""},"action":{"type":"string","description":"Result action when filter matches logevent.","enum":["Neutral","Log","Ignore","LogFinal","IgnoreFinal"],"default":"Neutral"}}}},{"title":"filter","type":"object","description":"","default":{}}]},"filterDefaultAction":{"type":"string","description":"Default action if none of the filters match.","enum":["Neutral","Log","Ignore","LogFinal","IgnoreFinal"],"default":"Ignore"}}},"Serilog":{"type":"object","title":"Serilog appSettings","description":"Serilog appSettings Configuration","properties":{"$schema":{"type":"string","title":"Schema","description":"Pointer to the schema against which this document should be validated."},"Using":{"type":"array","title":"List of Auto-discovery of configuration assemblies","description":"Using section contains list of assemblies in which configuration methods. Can be required depending of the project type: See: https://github.com/serilog/serilog-settings-configuration#using-section-and-auto-discovery-of-configuration-assemblies","uniqueItems":true,"items":{"$ref":"#/definitions/Serilog/definitions/AssemblyReference"}},"LevelSwitches":{"type":"object","patternProperties":{"^(?<SerilogLevelSwitcherName>\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$":{"$ref":"#/definitions/Serilog/definitions/SerilogLogEventLevel"}},"additionalProperties":false},"FilterSwitches":{"type":"object","patternProperties":{"^(?<SerilogLevelSwitcherName>\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$":{"type":"string"}},"additionalProperties":false},"MinimumLevel":{"type":["string","object"],"title":"Minimum LogLevel Threshold","description":"Minimum LogLevel Threshold. (Support dynamic reload if the underlying IConfigurationProvider supports it)","oneOf":[{"$ref":"#/definitions/Serilog/definitions/SerilogLogEventLevel"},{"$ref":"#/definitions/Serilog/definitions/DetailedMinimumLevel"}]},"Properties":{"type":"object","title":"Log events Properties","description":"This section defines a static list of key-value pairs that will enrich log events.","additionalProperties":{"type":"string"}},"Enrich":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReference"}],"title":"Log events Enriches","description":"This section defines Enriches that will be applied to log events."},"Destructure":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReference"}],"title":"Log events Destructure","description":"This section defines Destructure."},"Filter":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReference"}],"title":"Log events filters","description":"This section defines filters that will be applied to log events."},"WriteTo":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReference"}],"title":"Configuration for log destination","description":"This section configures the sinks that log events will be emitted to."},"AuditTo":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReference"}],"title":"Configuration for log destination for auditing","description":"This section configures sinks for auditing, instead of regular (safe) logging. Obs: When auditing is used, exceptions from sinks and any intermediate filters propagate back to the caller."}},"patternProperties":{"^Enrich:((?<EnvironmentVariableName>[a-zA-Z_]\\w*)|(?<ArrayIndex>\\d*))$":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"}],"title":"Log events Enriches","description":"This section defines Enriches that will be applied to log events."},"^Destructure:((?<EnvironmentVariableName>[a-zA-Z_]\\w*)|(?<ArrayIndex>\\d*))$":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"}],"title":"Log events Destructure","description":"This section defines Destructure."},"^Filter:((?<EnvironmentVariableName>[a-zA-Z_]\\w*)|(?<ArrayIndex>\\d*))$":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"}],"title":"Log events filters","description":"This section defines filters that will be applied to log events."},"^WriteTo:((?<EnvironmentVariableName>[a-zA-Z_]\\w*)|(?<ArrayIndex>\\d*))$":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"}],"title":"Configuration for log destination","description":"This section configures the sinks that log events will be emitted to."},"^AuditTo:((?<EnvironmentVariableName>[a-zA-Z_]\\w*)|(?<ArrayIndex>\\d*))$":{"allOf":[{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"}],"title":"Configuration for log destination for auditing","description":"This section configures sinks for auditing, instead of regular (safe) logging. Obs: When auditing is used, exceptions from sinks and any intermediate filters propagate back to the caller."}},"additionalProperties":false,"definitions":{"SerilogLogEventLevel":{"type":"string","title":"Log level","description":"Log level threshold.","enum":["Verbose","Debug","Information","Warning","Error","Fatal"]},"LoggingLevelSwitch":{"type":"string","title":"LevelSwitches name","description":"Log Level Switch string reference.","pattern":"^(?<SerilogLevelSwitcherName>\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$"},"SerilogLogLevelThreshold":{"type":"string","title":"Log Level or LevelSwitches name","description":"A Serilog Log Level or a reference to a Log Level Switch name on `LevelSwitches` configuration.","anyOf":[{"$ref":"#/definitions/Serilog/definitions/SerilogLogEventLevel"},{"$ref":"#/definitions/Serilog/definitions/LoggingLevelSwitch"}]},"DetailedMinimumLevel":{"type":"object","title":"Detailed Log level.","description":"Detailed Log level threshold object. Allowing set log levels be overridden per logging source.","properties":{"Default":{"$ref":"#/definitions/Serilog/definitions/SerilogLogLevelThreshold"},"ControlledBy":{"$ref":"#/definitions/Serilog/definitions/LoggingLevelSwitch"},"Override":{"type":"object","title":"Logging Source Log level object.","description":"Set the Log level threshold or LevelSwitcher reference per Logging Source.","additionalProperties":{"$ref":"#/definitions/Serilog/definitions/SerilogLogLevelThreshold"}}},"additionalProperties":false},"AssemblyReference":{"type":"string","title":"Assembly Name","description":".NET Assembly Name, without the file extension","minLength":1,"pattern":"^(?<AssemblyName>\\S+)$"},"ComplexMethodCallReference":{"type":"object","properties":{"Name":{"$ref":"#/definitions/Serilog/definitions/CSharpMethodName"},"Args":{"type":"object","patternProperties":{"^(?<CSharpMethodArgumentName>[a-zA-Z_]\\w*)$":{}},"additionalProperties":false}},"additionalProperties":false,"required":["Name"]},"MethodCallReferenceItem":{"type":["string","object","null"],"oneOf":[{"$ref":"#/definitions/Serilog/definitions/CSharpMethodName"},{"$ref":"#/definitions/Serilog/definitions/ComplexMethodCallReference"}]},"MethodCallReference":{"type":["array","string","object"],"minLength":1,"pattern":"^(?<CSharpMethodName>[a-zA-Z_]\\w*)$","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"},"additionalProperties":{"$ref":"#/definitions/Serilog/definitions/MethodCallReferenceItem"}},"CSharpMethodName":{"type":"string","title":"Method Name","description":"A name referring to a C# Class method","minLength":1,"pattern":"^(?<CSharpMethodName>[a-zA-Z_]\\w*)$"},"CSharpMethodArgumentName":{"type":"string","title":"Argument Name","description":"A name referring to a C# Class method argument","minLength":1,"pattern":"^(?<CSharpMethodArgumentName>[a-zA-Z_]\\w*)$"},"EnvironmentVariableName":{"type":"string","title":"Environment Variable Name","description":"A name referring to a OS Environment Variable","minLength":1,"pattern":"^(?<EnvironmentVariableName>[a-zA-Z_]\\w*)$"},"SerilogLevelSwitcherName":{"type":"string","title":"A Level Switcher Name","description":"A name referring to a Serilog Settings Configuration Level Switcher","minLength":1,"pattern":"^(?<SerilogLevelSwitcherName>\\${0,1}[A-Za-z]+[A-Za-z0-9]*)$"}}}},"id":"https://json.schemastore.org/appsettings.json","patternProperties":{"^WebOptimizer$":{"$ref":"#/definitions/webOptimizer"},"^webOptimizer$":{"$ref":"#/definitions/webOptimizer"},"^weboptimizer$":{"$ref":"#/definitions/webOptimizer"},"^(cdn|Cdn)$":{"$ref":"#/definitions/cdn"},"^(pwa|PWA|Pwa)$":{"$ref":"#/definitions/pwa"},"^(ElmahIo|Elmahio|elmahIo|elmahio)$":{"$ref":"#/definitions/ElmahIo"},"^(nlog|Nlog|NLog)$":{"$ref":"#/definitions/NLog"},"^(Serilog|serilog)$":{"$ref":"#/definitions/Serilog"}},"properties":{"Kestrel":{"$ref":"#/definitions/kestrel"},"Logging":{"$ref":"#/definitions/logging"},"AllowedHosts":{"$ref":"#/definitions/allowedHosts"},"ConnectionStrings":{"$ref":"#/definitions/connectionStrings"}},"title":"JSON schema ASP.NET Core's appsettings.json file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema ASP.NET Core's appsettings.json file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema ASP.NET Core's appsettings.json file
|
schema-store
|
schema_store_47
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/appsscript.json\",\"definitions\":{\"homepageTrigger\":{\"title\":\"homepage trigger\",\"type\":\"object\",\"description\":\"The Google Workspace add-on manifest configuration for homepage triggers.\",\"properties\":{\"enabled\":{\"description\":\"Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.\",\"type\":\"boolean\"},\"runFunction\":{\"description\":\"The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.\",\"type\":\"string\"}}}},\"properties\":{\"runtimeVersion\":{\"description\":\"Version of the server to use when executing this project.\",\"type\":\"string\",\"enum\":[\"STABLE\",\"V8\",\"DEPRECATED_ES5\"],\"default\":\"STABLE\"},\"timeZone\":{\"description\":\"The script time zone in one of the available ZoneId values such as \\\"America/Denver\\\".\",\"type\":\"string\",\"default\":\"America/New_York\"},\"dependencies\":{\"title\":\"dependencies\",\"description\":\"A list of advanced services and libraries.\",\"type\":\"object\",\"properties\":{\"enabledAdvancedServices\":{\"description\":\"The list of advanced services enabled for use by the script project.\",\"type\":\"array\",\"items\":{\"title\":\"advanced service\",\"description\":\"A single advanced service.\",\"type\":\"object\",\"required\":[\"userSymbol\",\"serviceId\",\"version\"],\"properties\":{\"userSymbol\":{\"description\":\"The identifier used to refer to this service in the code of the Apps Script project.\",\"type\":\"string\",\"default\":\"Sheets\"},\"serviceId\":{\"description\":\"The identifier of the service that is shown in the API discovery document (e.g., drive).\",\"type\":\"string\",\"default\":\"sheets\"},\"version\":{\"description\":\"The enabled version of the service (e.g., \\\"v1\\\").\",\"type\":\"string\",\"default\":\"v4\"}}}},\"libraries\":{\"description\":\"The list of libraries used by the script project.\",\"type\":\"array\",\"items\":{\"title\":\"library\",\"description\":\"A single library.\",\"type\":\"object\",\"required\":[\"userSymbol\",\"libraryId\",\"version\"],\"properties\":{\"userSymbol\":{\"description\":\"The label that is used in the script project code to refer to this library.\",\"type\":\"string\",\"default\":\"OAuth2\"},\"libraryId\":{\"description\":\"The script ID of the library's script project. You can find a script ID in the library script's URL or in the script editor by selecting **File > Project properties**.\",\"type\":\"string\",\"default\":\"1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF\",\"maxLength\":57,\"minLength\":57},\"version\":{\"description\":\"The version of the library that is used by the script. This is either a version number or stable, meaning the last version created.\",\"type\":\"string\",\"default\":\"41\"},\"developmentMode\":{\"description\":\"If true, version is ignored and the script uses the current library project saved code, even if that code has not been saved to a new version.\",\"type\":\"boolean\",\"default\":true}}}}}},\"webapp\":{\"title\":\"script\",\"description\":\"The script project's web app configuration. Only used if the project is deployed as a web app.\",\"type\":\"object\",\"properties\":{\"access\":{\"description\":\"The levels of permission for running the web app.\",\"type\":\"string\",\"enum\":[\"MYSELF\",\"DOMAIN\",\"ANYONE\",\"ANYONE_ANONYMOUS\"],\"default\":\"MYSELF\"},\"executeAs\":{\"description\":\"The identity under which the web app executes.\",\"type\":\"string\",\"enum\":[\"USER_ACCESSING\",\"USER_DEPLOYING\"],\"default\":\"USER_DEPLOYING\"}}},\"exceptionLogging\":{\"description\":\"The location where exceptions are logged.\",\"type\":\"string\",\"enum\":[\"NONE\",\"STACKDRIVER\"]},\"oauthScopes\":{\"description\":\"The definition of authorization scopes used by the script project.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uri\"}},\"urlFetchWhitelist\":{\"description\":\"A list of HTTPS URL prefixes. If present, any URL endpoint fetched must match one of the prefixes in this list. This can help to protect user data.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"hostname\"}},\"executionApi\":{\"title\":\"api options\",\"description\":\"The script project's API executable configuration. Only used if the project is deployed for API execution.\",\"type\":\"object\",\"properties\":{\"access\":{\"description\":\"Determines who has permission to run the script from the API.\",\"type\":\"string\",\"enum\":[\"MYSELF\",\"DOMAIN\",\"ANYONE\",\"ANYONE_ANONYMOUS\"]}}},\"sheets\":{\"title\":\"sheet manifest\",\"description\":\"Defines manifest values specific to Sheets.\",\"type\":\"object\",\"properties\":{\"macros\":{\"description\":\"A list of defined macros and their associated properties.\",\"type\":\"array\",\"items\":{\"title\":\"macros\",\"description\":\"A defined macros and it's associated properties.\",\"type\":\"object\",\"properties\":{\"menuName\":{\"description\":\"The name of the macro as it appears in the Google Sheets UI.\",\"type\":\"string\",\"default\":\"My Macro\"},\"functionName\":{\"description\":\"The name of the Apps Script function that executes the macro. By default this matches the menuName for functions automatically created, but this is not a requirement.\",\"type\":\"string\",\"default\":\"myFunction\"},\"defaultShortcut\":{\"description\":\"Defines the keyboard shortcut that executes the macro. This must be of the form Ctrl+Alt+Shift+Number, where Number is a single-digit. Macros without shortcuts can only be executed from the Tools > Macros menu.\",\"type\":\"string\",\"default\":\"Ctrl+Alt+Shift+1\"}},\"required\":[\"menuName\",\"functionName\",\"defaultShortcut\"]}}}},\"dataStudio\":{\"title\":\"add-on manifest\",\"description\":\"Data Studio add-on manifest.\",\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"Display name for add-on.\",\"type\":\"string\"},\"logoUrl\":{\"description\":\"URL for logo image of add-on.\",\"type\":\"string\",\"format\":\"hostname\"},\"company\":{\"description\":\"Company name for the add-on.\",\"type\":\"string\"},\"addonUrl\":{\"type\":\"string\",\"format\":\"hostname\"},\"companyUrl\":{\"type\":\"string\",\"format\":\"hostname\"},\"supportUrl\":{\"description\":\"URL for support information of the add-on.\",\"type\":\"string\",\"format\":\"hostname\"},\"description\":{\"description\":\"Short description about the add-on.\",\"type\":\"string\"},\"sources\":{\"description\":\"List of sources or services that can be accessed with this add-on.\",\"type\":\"array\",\"items\":{\"description\":\"A single source type.\",\"type\":\"string\"}},\"templates\":{\"title\":\"templates\",\"description\":\"Map of template name to report ID.\",\"type\":\"object\"},\"shortDescription\":{\"description\":\"Even shorter description used in gallery cards. Only a maximum of 114 characters will be shown on the card.\",\"type\":\"string\"},\"authType\":{\"description\":\"List of AuthTypes supported.\",\"type\":\"array\",\"items\":{\"description\":\"Types of Authorization supported by the add-on.\",\"type\":\"string\",\"enum\":[\"NONE\",\"KEY\",\"USER_PASS\",\"OAUTH2\"]}},\"privacyPolicyUrl\":{\"description\":\"Url for privacy policy information about the add-on.\",\"type\":\"string\",\"format\":\"hostname\"},\"termsOfServiceUrl\":{\"description\":\"Url for terms of service information about the add-on.\",\"type\":\"string\",\"format\":\"hostname\"}},\"required\":[\"name\",\"logoUrl\",\"company\",\"supportUrl\",\"description\"]},\"addOns\":{\"title\":\"add-ons\",\"description\":\"G Suite Add-ons\",\"type\":\"object\",\"properties\":{\"common\":{\"title\":\"common options\",\"description\":\"Common properties between all G Suite add-on types.\",\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The add-on name.\",\"type\":\"string\"},\"logoUrl\":{\"description\":\"The logo URL.\",\"type\":\"string\",\"format\":\"uri\"},\"layoutProperties\":{\"title\":\"layout options\",\"description\":\"Layout properties.\",\"type\":\"object\",\"properties\":{\"primaryColor\":{\"description\":\"The color of toolbar. Defaults to grey (#424242).\",\"type\":\"string\"},\"secondaryColor\":{\"description\":\"The default color of buttons. Defaults to the primary color (if it is set); otherwise defaults to blue (#2196F3).\",\"type\":\"string\"}}},\"homepageTrigger\":{\"title\":\"homepage trigger\",\"description\":\"Homepage trigger data\",\"type\":\"object\",\"properties\":{\"enabled\":{\"description\":\"Whether or not homepage (non-contextual) cards are enabled. Defaults to true.\",\"type\":\"boolean\"},\"runFunctions\":{\"description\":\"The name of the function to run\",\"type\":\"string\"}}},\"universalActions\":{\"description\":\"Universal add-on actions\",\"type\":\"array\",\"items\":{\"title\":\"actions\",\"description\":\"Actions\",\"type\":\"object\",\"properties\":{\"label\":{\"description\":\"The action label.\",\"type\":\"string\"},\"openLink\":{\"description\":\"The link's URL\",\"type\":\"string\",\"format\":\"hostname\"},\"runFunction\":{\"description\":\"Required for each defined universal action if openLink is not present. If provided, the name of the Apps Script function that executes when the user selects this action.\",\"type\":\"string\"}}}},\"openLinkUrlPrefixes\":{\"description\":\"Link prefixes.\",\"type\":\"array\",\"items\":{\"description\":\"A link prefix.\",\"type\":\"string\"}},\"useLocaleFromApp\":{\"description\":\"Use the locale from the host application?\",\"type\":\"boolean\"}},\"required\":[\"logoUrl\",\"name\"]},\"gmail\":{\"title\":\"add-on metadata\",\"description\":\"Gmail add-on metadata.\",\"type\":\"object\",\"properties\":{\"contextualTriggers\":{\"description\":\"Contextual triggers.\",\"type\":\"array\",\"items\":{\"title\":\"contextual trigger\",\"description\":\"A contextual trigger.\",\"type\":\"object\",\"properties\":{\"onTriggerFunction\":{\"description\":\"The name of the Apps Script function that executes when this contextual trigger fires (that is, when a message is opened in Gmail). The function specified here must build and return an array of Card objects.\",\"type\":\"string\"},\"unconditional\":{\"title\":\"unconditional\",\"description\":\"Used to specify that the contextual trigger is fired for all Gmail messages. This is currently the only option, so this should always be an empty object.\",\"type\":\"object\"}}}},\"homepageTrigger\":{\"title\":\"homepage trigger\",\"description\":\"The trigger function specification for creating the add-on homepage in the Gmail host.\",\"type\":\"object\",\"properties\":{\"enabled\":{\"description\":\"Whether or not homepage (non-contextual) cards are enabled in Gmail. Defaults to true.\",\"type\":\"boolean\"},\"runFunction\":{\"description\":\"The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.\",\"type\":\"string\"}}}}},\"calendar\":{\"title\":\"calendar metadata\",\"description\":\"Calendar add-on metadata.\",\"type\":\"object\",\"properties\":{\"homepageTrigger\":{\"title\":\"homepage trigger\",\"description\":\"The trigger function specification for creating the add-on homepage in the Calendar host.\",\"type\":\"object\",\"properties\":{\"enabled\":{\"description\":\"Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.\",\"type\":\"boolean\"},\"runFunction\":{\"description\":\"The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.\",\"type\":\"string\"}}},\"eventOpenTrigger\":{\"title\":\"event\",\"description\":\"When a Calendar event is opened\",\"type\":\"object\",\"properties\":{\"runFunction\":{\"description\":\"Event handler function\",\"type\":\"string\"}}},\"eventUpdateTrigger\":{\"title\":\"event\",\"description\":\"When a Calendar event is updated\",\"type\":\"object\",\"properties\":{\"runFunction\":{\"description\":\"Event handler function\",\"type\":\"string\"}}},\"eventAccess\":{\"description\":\"Handler access to Calendar event\",\"type\":\"string\",\"enum\":[\"METADATA\",\"READ\",\"WRITE\",\"READ_WRITE\"]}}},\"sheets\":{\"title\":\"add-on options\",\"description\":\"Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application.\",\"type\":\"object\",\"properties\":{\"homepageTrigger\":{\"$ref\":\"#/definitions/homepageTrigger\"},\"onFileScopeGrantedTrigger\":{\"title\":\"contextual trigger\",\"type\":\"object\",\"description\":\"A configuration for a contextual trigger that fires when the add-on presents the request file scope dialog.\",\"properties\":{\"runFunction\":{\"type\":\"string\"}}}},\"additionalProperties\":false}}}},\"title\":\"JSON schema for Google Apps Script manifest files\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Google Apps Script manifest files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/appsscript.json","definitions":{"homepageTrigger":{"title":"homepage trigger","type":"object","description":"The Google Workspace add-on manifest configuration for homepage triggers.","properties":{"enabled":{"description":"Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.","type":"boolean"},"runFunction":{"description":"The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.","type":"string"}}}},"properties":{"runtimeVersion":{"description":"Version of the server to use when executing this project.","type":"string","enum":["STABLE","V8","DEPRECATED_ES5"],"default":"STABLE"},"timeZone":{"description":"The script time zone in one of the available ZoneId values such as \"America/Denver\".","type":"string","default":"America/New_York"},"dependencies":{"title":"dependencies","description":"A list of advanced services and libraries.","type":"object","properties":{"enabledAdvancedServices":{"description":"The list of advanced services enabled for use by the script project.","type":"array","items":{"title":"advanced service","description":"A single advanced service.","type":"object","required":["userSymbol","serviceId","version"],"properties":{"userSymbol":{"description":"The identifier used to refer to this service in the code of the Apps Script project.","type":"string","default":"Sheets"},"serviceId":{"description":"The identifier of the service that is shown in the API discovery document (e.g., drive).","type":"string","default":"sheets"},"version":{"description":"The enabled version of the service (e.g., \"v1\").","type":"string","default":"v4"}}}},"libraries":{"description":"The list of libraries used by the script project.","type":"array","items":{"title":"library","description":"A single library.","type":"object","required":["userSymbol","libraryId","version"],"properties":{"userSymbol":{"description":"The label that is used in the script project code to refer to this library.","type":"string","default":"OAuth2"},"libraryId":{"description":"The script ID of the library's script project. You can find a script ID in the library script's URL or in the script editor by selecting **File > Project properties**.","type":"string","default":"1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF","maxLength":57,"minLength":57},"version":{"description":"The version of the library that is used by the script. This is either a version number or stable, meaning the last version created.","type":"string","default":"41"},"developmentMode":{"description":"If true, version is ignored and the script uses the current library project saved code, even if that code has not been saved to a new version.","type":"boolean","default":true}}}}}},"webapp":{"title":"script","description":"The script project's web app configuration. Only used if the project is deployed as a web app.","type":"object","properties":{"access":{"description":"The levels of permission for running the web app.","type":"string","enum":["MYSELF","DOMAIN","ANYONE","ANYONE_ANONYMOUS"],"default":"MYSELF"},"executeAs":{"description":"The identity under which the web app executes.","type":"string","enum":["USER_ACCESSING","USER_DEPLOYING"],"default":"USER_DEPLOYING"}}},"exceptionLogging":{"description":"The location where exceptions are logged.","type":"string","enum":["NONE","STACKDRIVER"]},"oauthScopes":{"description":"The definition of authorization scopes used by the script project.","type":"array","items":{"type":"string","format":"uri"}},"urlFetchWhitelist":{"description":"A list of HTTPS URL prefixes. If present, any URL endpoint fetched must match one of the prefixes in this list. This can help to protect user data.","type":"array","items":{"type":"string","format":"hostname"}},"executionApi":{"title":"api options","description":"The script project's API executable configuration. Only used if the project is deployed for API execution.","type":"object","properties":{"access":{"description":"Determines who has permission to run the script from the API.","type":"string","enum":["MYSELF","DOMAIN","ANYONE","ANYONE_ANONYMOUS"]}}},"sheets":{"title":"sheet manifest","description":"Defines manifest values specific to Sheets.","type":"object","properties":{"macros":{"description":"A list of defined macros and their associated properties.","type":"array","items":{"title":"macros","description":"A defined macros and it's associated properties.","type":"object","properties":{"menuName":{"description":"The name of the macro as it appears in the Google Sheets UI.","type":"string","default":"My Macro"},"functionName":{"description":"The name of the Apps Script function that executes the macro. By default this matches the menuName for functions automatically created, but this is not a requirement.","type":"string","default":"myFunction"},"defaultShortcut":{"description":"Defines the keyboard shortcut that executes the macro. This must be of the form Ctrl+Alt+Shift+Number, where Number is a single-digit. Macros without shortcuts can only be executed from the Tools > Macros menu.","type":"string","default":"Ctrl+Alt+Shift+1"}},"required":["menuName","functionName","defaultShortcut"]}}}},"dataStudio":{"title":"add-on manifest","description":"Data Studio add-on manifest.","type":"object","properties":{"name":{"description":"Display name for add-on.","type":"string"},"logoUrl":{"description":"URL for logo image of add-on.","type":"string","format":"hostname"},"company":{"description":"Company name for the add-on.","type":"string"},"addonUrl":{"type":"string","format":"hostname"},"companyUrl":{"type":"string","format":"hostname"},"supportUrl":{"description":"URL for support information of the add-on.","type":"string","format":"hostname"},"description":{"description":"Short description about the add-on.","type":"string"},"sources":{"description":"List of sources or services that can be accessed with this add-on.","type":"array","items":{"description":"A single source type.","type":"string"}},"templates":{"title":"templates","description":"Map of template name to report ID.","type":"object"},"shortDescription":{"description":"Even shorter description used in gallery cards. Only a maximum of 114 characters will be shown on the card.","type":"string"},"authType":{"description":"List of AuthTypes supported.","type":"array","items":{"description":"Types of Authorization supported by the add-on.","type":"string","enum":["NONE","KEY","USER_PASS","OAUTH2"]}},"privacyPolicyUrl":{"description":"Url for privacy policy information about the add-on.","type":"string","format":"hostname"},"termsOfServiceUrl":{"description":"Url for terms of service information about the add-on.","type":"string","format":"hostname"}},"required":["name","logoUrl","company","supportUrl","description"]},"addOns":{"title":"add-ons","description":"G Suite Add-ons","type":"object","properties":{"common":{"title":"common options","description":"Common properties between all G Suite add-on types.","type":"object","properties":{"name":{"description":"The add-on name.","type":"string"},"logoUrl":{"description":"The logo URL.","type":"string","format":"uri"},"layoutProperties":{"title":"layout options","description":"Layout properties.","type":"object","properties":{"primaryColor":{"description":"The color of toolbar. Defaults to grey (#424242).","type":"string"},"secondaryColor":{"description":"The default color of buttons. Defaults to the primary color (if it is set); otherwise defaults to blue (#2196F3).","type":"string"}}},"homepageTrigger":{"title":"homepage trigger","description":"Homepage trigger data","type":"object","properties":{"enabled":{"description":"Whether or not homepage (non-contextual) cards are enabled. Defaults to true.","type":"boolean"},"runFunctions":{"description":"The name of the function to run","type":"string"}}},"universalActions":{"description":"Universal add-on actions","type":"array","items":{"title":"actions","description":"Actions","type":"object","properties":{"label":{"description":"The action label.","type":"string"},"openLink":{"description":"The link's URL","type":"string","format":"hostname"},"runFunction":{"description":"Required for each defined universal action if openLink is not present. If provided, the name of the Apps Script function that executes when the user selects this action.","type":"string"}}}},"openLinkUrlPrefixes":{"description":"Link prefixes.","type":"array","items":{"description":"A link prefix.","type":"string"}},"useLocaleFromApp":{"description":"Use the locale from the host application?","type":"boolean"}},"required":["logoUrl","name"]},"gmail":{"title":"add-on metadata","description":"Gmail add-on metadata.","type":"object","properties":{"contextualTriggers":{"description":"Contextual triggers.","type":"array","items":{"title":"contextual trigger","description":"A contextual trigger.","type":"object","properties":{"onTriggerFunction":{"description":"The name of the Apps Script function that executes when this contextual trigger fires (that is, when a message is opened in Gmail). The function specified here must build and return an array of Card objects.","type":"string"},"unconditional":{"title":"unconditional","description":"Used to specify that the contextual trigger is fired for all Gmail messages. This is currently the only option, so this should always be an empty object.","type":"object"}}}},"homepageTrigger":{"title":"homepage trigger","description":"The trigger function specification for creating the add-on homepage in the Gmail host.","type":"object","properties":{"enabled":{"description":"Whether or not homepage (non-contextual) cards are enabled in Gmail. Defaults to true.","type":"boolean"},"runFunction":{"description":"The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.","type":"string"}}}}},"calendar":{"title":"calendar metadata","description":"Calendar add-on metadata.","type":"object","properties":{"homepageTrigger":{"title":"homepage trigger","description":"The trigger function specification for creating the add-on homepage in the Calendar host.","type":"object","properties":{"enabled":{"description":"Whether or not homepage (non-contextual) cards are enabled in Calendar. Defaults to true.","type":"boolean"},"runFunction":{"description":"The name of the function to run when this trigger fires. You must implement this function in your add-on project. This function must build and return an array of Card objects.","type":"string"}}},"eventOpenTrigger":{"title":"event","description":"When a Calendar event is opened","type":"object","properties":{"runFunction":{"description":"Event handler function","type":"string"}}},"eventUpdateTrigger":{"title":"event","description":"When a Calendar event is updated","type":"object","properties":{"runFunction":{"description":"Event handler function","type":"string"}}},"eventAccess":{"description":"Handler access to Calendar event","type":"string","enum":["METADATA","READ","WRITE","READ_WRITE"]}}},"sheets":{"title":"add-on options","description":"Configurations for the Google Workspace Add-on's appearance and behavior within the Sheets host application.","type":"object","properties":{"homepageTrigger":{"$ref":"#/definitions/homepageTrigger"},"onFileScopeGrantedTrigger":{"title":"contextual trigger","type":"object","description":"A configuration for a contextual trigger that fires when the add-on presents the request file scope dialog.","properties":{"runFunction":{"type":"string"}}}},"additionalProperties":false}}}},"title":"JSON schema for Google Apps Script manifest files","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Google Apps Script manifest files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Google Apps Script manifest files
|
schema-store
|
schema_store_48
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"allOf\":[{\"$ref\":\"#/definitions/job\"}],\"definitions\":{\"possiblySecretString\":{\"anyOf\":[{\"type\":\"string\",\"description\":\"This value will be used directly (regular string)\"},{\"type\":\"number\",\"description\":\"This value will be treated as a string even though it is a number\"},{\"title\":\"secret string\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"secure\":{\"type\":\"string\",\"description\":\"This should have been encrypted by the same user account to which the project belongs\"}}}]},\"commitFilter\":{\"title\":\"commit filter\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"message\":{\"type\":\"string\",\"format\":\"regex\",\"description\":\"Regex for matching commit message\"},\"author\":{\"description\":\"Commit author's username, name, email or regexp matching one of these.\",\"anyOf\":[{\"type\":\"string\",\"format\":\"regex\"},{\"type\":\"string\"}]},\"files\":{\"type\":\"array\",\"description\":\"Only specific files (glob patterns)\",\"items\":{\"type\":\"string\"}}}},\"command\":{\"title\":\"command\",\"oneOf\":[{\"type\":\"string\",\"description\":\"Run a batch command\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"ps\":{\"type\":\"string\",\"description\":\"Run a PowerShell command\"}}},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"pwsh\":{\"type\":\"string\",\"description\":\"Run a PowerShell Core command\"}}},{\"type\":\"object\",\"description\":\"Run a batch command\",\"additionalProperties\":false,\"properties\":{\"cmd\":{\"type\":\"string\"}}},{\"type\":\"object\",\"description\":\"Run a Bash command\",\"additionalProperties\":false,\"properties\":{\"sh\":{\"type\":\"string\"}}}]},\"envVarHash\":{\"title\":\"environment variable hash\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/possiblySecretString\"}},\"platform\":{\"enum\":[\"x86\",\"x64\",\"ARM\",\"ARM64\",\"Win32\",\"Any CPU\"]},\"configuration\":{\"type\":\"string\"},\"imageName\":{\"enum\":[\"macOS\",\"macOS-Mojave\",\"macos-bigsur\",\"macos-monterey\",\"Previous macOS\",\"Previous macOS-Mojave\",\"Ubuntu\",\"Ubuntu1604\",\"Ubuntu1804\",\"Ubuntu2004\",\"Ubuntu2204\",\"Previous Ubuntu\",\"Previous Ubuntu1604\",\"Previous Ubuntu1804\",\"Previous Ubuntu2004\",\"Visual Studio 2013\",\"Visual Studio 2015\",\"Visual Studio 2017\",\"Visual Studio 2019\",\"Visual Studio 2022\",\"Visual Studio 2017 Preview\",\"Visual Studio 2019 Preview\",\"Previous Visual Studio 2013\",\"Previous Visual Studio 2015\",\"Previous Visual Studio 2017\",\"Previous Visual Studio 2019\",\"Previous Visual Studio 2022\",\"zhaw18\",\"WMF 5\"]},\"image\":{\"description\":\"Build worker image (VM template) -DEV_VERSION\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/imageName\"}},{\"$ref\":\"#/definitions/imageName\"}]},\"jobScalars\":{\"title\":\"job scalars\",\"type\":\"object\",\"properties\":{\"image\":{\"$ref\":\"#/definitions/image\"},\"platform\":{\"description\":\"Build platform, i.e. x86, x64, Any CPU. This setting is optional\",\"oneOf\":[{\"$ref\":\"#/definitions/platform\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/platform\"}}]},\"configuration\":{\"description\":\"Build Configuration, i.e. Debug, Release, etc.\",\"oneOf\":[{\"$ref\":\"#/definitions/configuration\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/configuration\"}}]}},\"allOf\":[{\"not\":{\"required\":[\"skip_tags\"]}},{\"not\":{\"required\":[\"skip_commits\"]}},{\"not\":{\"required\":[\"skip_branch_with_pr\"]}},{\"not\":{\"required\":[\"skip_non_tags\"]}}]},\"job\":{\"title\":\"job\",\"type\":\"object\",\"properties\":{\"version\":{\"description\":\"Version format\",\"type\":\"string\"},\"branches\":{\"title\":\"branch options\",\"type\":\"object\",\"description\":\"Branches to build\",\"additionalProperties\":false,\"properties\":{\"only\":{\"description\":\"Whitelist\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"except\":{\"type\":\"array\",\"description\":\"Blacklist\",\"items\":{\"type\":\"string\"}}}},\"skip_tags\":{\"type\":\"boolean\",\"description\":\"Do not build on tags (GitHub and BitBucket)\"},\"skip_non_tags\":{\"type\":\"boolean\",\"description\":\"Start builds on tags only (GitHub and BitBucket)\"},\"skip_commits\":{\"$ref\":\"#/definitions/commitFilter\",\"description\":\"Skipping commits with particular message or from specific user\"},\"only_commits\":{\"$ref\":\"#/definitions/commitFilter\",\"description\":\"Including commits with particular message or from specific user\"},\"skip_branch_with_pr\":{\"type\":\"boolean\",\"description\":\"Do not build feature branch with open Pull Requests\"},\"max_jobs\":{\"description\":\"Maximum number of concurrent jobs for the project\",\"type\":\"integer\"},\"notifications\":{\"type\":\"array\",\"items\":{\"title\":\"notification\",\"type\":\"object\"}},\"image\":{\"$ref\":\"#/definitions/image\"},\"init\":{\"description\":\"Scripts that are called at very beginning, before repo cloning\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"clone_folder\":{\"type\":\"string\",\"description\":\"Clone directory\"},\"shallow_clone\":{\"type\":\"boolean\",\"description\":\"Fetch repository as zip archive\",\"default\":false},\"clone_depth\":{\"description\":\"Set git clone depth\",\"type\":\"integer\"},\"hosts\":{\"title\":\"host options\",\"type\":\"object\",\"description\":\"Setting up etc\\\\hosts file\",\"additionalProperties\":{\"type\":\"string\",\"anyOf\":[{\"format\":\"ipv4\"},{\"format\":\"ipv6\"}]}},\"environment\":{\"description\":\"Environment variables\",\"anyOf\":[{\"title\":\"environment options\",\"type\":\"object\",\"properties\":{\"global\":{\"$ref\":\"#/definitions/envVarHash\",\"description\":\"variables defined here are no different than those defined at top level of 'environment' node\"},\"matrix\":{\"type\":\"array\",\"description\":\"an array of environment variables, each member of which is one dimension in the build matrix calculation\",\"items\":{\"$ref\":\"#/definitions/envVarHash\"}}}},{\"$ref\":\"#/definitions/envVarHash\"}]},\"matrix\":{\"title\":\"matrix options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"fast_finish\":{\"type\":\"boolean\",\"description\":\"Set this flag to immediately finish build once one of the jobs fails\"},\"allow_failures\":{\"type\":\"array\",\"description\":\"This is how to allow failing jobs in the matrix\",\"items\":{\"$ref\":\"#/definitions/jobScalars\"}},\"exclude\":{\"type\":\"array\",\"description\":\"Exclude configuration from the matrix. Works similarly to 'allow_failures' but build not even being started for excluded combination.\",\"items\":{\"$ref\":\"#/definitions/job\"}}}},\"cache\":{\"type\":\"array\",\"description\":\"Build cache to preserve files/folders between builds\",\"items\":{\"type\":\"string\"}},\"services\":{\"type\":\"array\",\"description\":\"Enable service required for build/tests\",\"items\":{\"enum\":[\"docker\",\"iis\",\"mongodb\",\"msmq\",\"mssql\",\"mssql2008r2sp2\",\"mssql2008r2sp2rs\",\"mssql2012sp1\",\"mssql2012sp1rs\",\"mssql2014\",\"mssql2014rs\",\"mssql2016\",\"mssql2017\",\"mysql\",\"postgresql\",\"postgresql93\",\"postgresql94\",\"postgresql95\",\"postgresql96\",\"postgresql10\",\"postgresql11\",\"postgresql12\",\"postgresql13\"]}},\"install\":{\"description\":\"Scripts that run after cloning repository\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"assembly_info\":{\"title\":\"assembly options\",\"type\":\"object\",\"description\":\"Enable patching of AssemblyInfo.* files\",\"additionalProperties\":false,\"properties\":{\"patch\":{\"type\":\"boolean\"},\"file\":{\"type\":\"string\"},\"assembly_version\":{\"type\":\"string\"},\"assembly_file_version\":{\"type\":\"string\"},\"assembly_informational_version\":{\"type\":\"string\"}}},\"nuget\":{\"title\":\"NuGet options\",\"type\":\"object\",\"description\":\"Automatically register private account and/or project AppVeyor NuGet feeds\",\"properties\":{\"account_feed\":{\"type\":\"boolean\"},\"project_feed\":{\"type\":\"boolean\"},\"disable_publish_on_pr\":{\"type\":\"boolean\",\"description\":\"Disable publishing of .nupkg artifacts to account/project feeds for pull request builds\"}}},\"platform\":{\"description\":\"Build platform, i.e. x86, x64, Any CPU. This setting is optional\",\"oneOf\":[{\"$ref\":\"#/definitions/platform\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/platform\"}}]},\"configuration\":{\"description\":\"Build Configuration, i.e. Debug, Release, etc.\",\"oneOf\":[{\"$ref\":\"#/definitions/configuration\"},{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/configuration\"}}]},\"build\":{\"oneOf\":[{\"type\":\"boolean\",\"enum\":[false]},{\"title\":\"build options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"parallel\":{\"type\":\"boolean\",\"description\":\"Enable MSBuild parallel builds\"},\"project\":{\"type\":\"string\",\"description\":\"Path to Visual Studio solution or project\"},\"publish_wap\":{\"type\":\"boolean\",\"description\":\"Package Web Application Projects (WAP) for Web Deploy\"},\"publish_wap_xcopy\":{\"type\":\"boolean\",\"description\":\"Package Web Application Projects (WAP) for XCopy deployment\"},\"publish_wap_beanstalk\":{\"type\":\"boolean\",\"description\":\"Package Web Applications for AWS Elastic Beanstalk deployment\"},\"publish_wap_octopus\":{\"type\":\"boolean\",\"description\":\"Package Web Applications for Octopus deployment\"},\"publish_azure_webjob\":{\"type\":\"boolean\",\"description\":\"Package Azure WebJobs for Zip Push deployment\"},\"publish_azure\":{\"type\":\"boolean\",\"description\":\"Package Azure Cloud Service projects and push to artifacts\"},\"publish_aspnet_core\":{\"type\":\"boolean\",\"description\":\"Package ASP.NET Core projects\"},\"publish_core_console\":{\"type\":\"boolean\",\"description\":\"Package .NET Core console projects\"},\"publish_nuget\":{\"type\":\"boolean\",\"description\":\"Package projects with .nuspec files and push to artifacts\"},\"publish_nuget_symbols\":{\"type\":\"boolean\",\"description\":\"Generate and publish NuGet symbol packages\"},\"include_nuget_references\":{\"type\":\"boolean\",\"description\":\"Add -IncludeReferencedProjects option while packaging NuGet artifacts\"},\"verbosity\":{\"enum\":[\"quiet\",\"minimal\",\"normal\",\"detailed\"],\"description\":\"MSBuild verbosity level\"}}}]},\"before_build\":{\"description\":\"Scripts to run before build\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"before_package\":{\"description\":\"Scripts to run *after* solution is built and *before* automatic packaging occurs (web apps, NuGet packages, Azure Cloud Services)\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"after_build\":{\"description\":\"Scripts to run after build\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"build_script\":{\"description\":\"To run your custom scripts instead of automatic MSBuild\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"before_test\":{\"description\":\"Scripts to run before tests\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"test\":{\"oneOf\":[{\"type\":\"boolean\",\"enum\":[false],\"description\":\"To disable automatic tests\"},{\"title\":\"test options\",\"description\":\"To run tests again only selected assemblies and/or categories\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"assemblies\":{\"title\":\"assembly options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"only\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"except\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"categories\":{\"oneOf\":[{\"title\":\"category options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"only\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"except\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},{\"description\":\"To run tests from different categories as separate jobs in parallel\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"description\":\"A category common for all jobs\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]}}]}}}]},\"test_script\":{\"description\":\"To run your custom scripts instead of automatic tests\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"after_test\":{\"type\":\"array\",\"description\":\"Scripts to run after tests\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"artifacts\":{\"type\":\"array\",\"items\":{\"title\":\"artifact options\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"type\":{\"enum\":[\"Auto\",\"WebDeployPackage\",\"NuGetPackage\",\"AzureCloudService\",\"AzureCloudServiceConfig\",\"SsdtPackage\",\"Zip\",\"File\"]}},\"required\":[\"path\"]}},\"before_deploy\":{\"type\":\"array\",\"description\":\"Scripts to run before deployment\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"deploy\":{\"oneOf\":[{\"enum\":[\"off\"]},{\"type\":\"array\",\"items\":{\"title\":\"deployment options\",\"type\":\"object\"}}]},\"deploy_script\":{\"description\":\"To run your custom scripts instead of provider deployments\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"after_deploy\":{\"type\":\"array\",\"description\":\"Scripts to run after deployment\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"on_success\":{\"type\":\"array\",\"description\":\"On successful build\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"on_failure\":{\"type\":\"array\",\"description\":\"On build failure\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"on_finish\":{\"type\":\"array\",\"description\":\"After build failure or success\",\"items\":{\"$ref\":\"#/definitions/command\"}}}}},\"id\":\"https://json.schemastore.org/appveyor.json\",\"title\":\"JSON schema for AppVeyor CI configuration files\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for AppVeyor CI configuration files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","allOf":[{"$ref":"#/definitions/job"}],"definitions":{"possiblySecretString":{"anyOf":[{"type":"string","description":"This value will be used directly (regular string)"},{"type":"number","description":"This value will be treated as a string even though it is a number"},{"title":"secret string","type":"object","additionalProperties":false,"properties":{"secure":{"type":"string","description":"This should have been encrypted by the same user account to which the project belongs"}}}]},"commitFilter":{"title":"commit filter","type":"object","additionalProperties":false,"properties":{"message":{"type":"string","format":"regex","description":"Regex for matching commit message"},"author":{"description":"Commit author's username, name, email or regexp matching one of these.","anyOf":[{"type":"string","format":"regex"},{"type":"string"}]},"files":{"type":"array","description":"Only specific files (glob patterns)","items":{"type":"string"}}}},"command":{"title":"command","oneOf":[{"type":"string","description":"Run a batch command"},{"type":"object","additionalProperties":false,"properties":{"ps":{"type":"string","description":"Run a PowerShell command"}}},{"type":"object","additionalProperties":false,"properties":{"pwsh":{"type":"string","description":"Run a PowerShell Core command"}}},{"type":"object","description":"Run a batch command","additionalProperties":false,"properties":{"cmd":{"type":"string"}}},{"type":"object","description":"Run a Bash command","additionalProperties":false,"properties":{"sh":{"type":"string"}}}]},"envVarHash":{"title":"environment variable hash","type":"object","additionalProperties":{"$ref":"#/definitions/possiblySecretString"}},"platform":{"enum":["x86","x64","ARM","ARM64","Win32","Any CPU"]},"configuration":{"type":"string"},"imageName":{"enum":["macOS","macOS-Mojave","macos-bigsur","macos-monterey","Previous macOS","Previous macOS-Mojave","Ubuntu","Ubuntu1604","Ubuntu1804","Ubuntu2004","Ubuntu2204","Previous Ubuntu","Previous Ubuntu1604","Previous Ubuntu1804","Previous Ubuntu2004","Visual Studio 2013","Visual Studio 2015","Visual Studio 2017","Visual Studio 2019","Visual Studio 2022","Visual Studio 2017 Preview","Visual Studio 2019 Preview","Previous Visual Studio 2013","Previous Visual Studio 2015","Previous Visual Studio 2017","Previous Visual Studio 2019","Previous Visual Studio 2022","zhaw18","WMF 5"]},"image":{"description":"Build worker image (VM template) -DEV_VERSION","oneOf":[{"type":"array","items":{"$ref":"#/definitions/imageName"}},{"$ref":"#/definitions/imageName"}]},"jobScalars":{"title":"job scalars","type":"object","properties":{"image":{"$ref":"#/definitions/image"},"platform":{"description":"Build platform, i.e. x86, x64, Any CPU. This setting is optional","oneOf":[{"$ref":"#/definitions/platform"},{"type":"array","items":{"$ref":"#/definitions/platform"}}]},"configuration":{"description":"Build Configuration, i.e. Debug, Release, etc.","oneOf":[{"$ref":"#/definitions/configuration"},{"type":"array","items":{"$ref":"#/definitions/configuration"}}]}},"allOf":[{"not":{"required":["skip_tags"]}},{"not":{"required":["skip_commits"]}},{"not":{"required":["skip_branch_with_pr"]}},{"not":{"required":["skip_non_tags"]}}]},"job":{"title":"job","type":"object","properties":{"version":{"description":"Version format","type":"string"},"branches":{"title":"branch options","type":"object","description":"Branches to build","additionalProperties":false,"properties":{"only":{"description":"Whitelist","type":"array","items":{"type":"string"}},"except":{"type":"array","description":"Blacklist","items":{"type":"string"}}}},"skip_tags":{"type":"boolean","description":"Do not build on tags (GitHub and BitBucket)"},"skip_non_tags":{"type":"boolean","description":"Start builds on tags only (GitHub and BitBucket)"},"skip_commits":{"$ref":"#/definitions/commitFilter","description":"Skipping commits with particular message or from specific user"},"only_commits":{"$ref":"#/definitions/commitFilter","description":"Including commits with particular message or from specific user"},"skip_branch_with_pr":{"type":"boolean","description":"Do not build feature branch with open Pull Requests"},"max_jobs":{"description":"Maximum number of concurrent jobs for the project","type":"integer"},"notifications":{"type":"array","items":{"title":"notification","type":"object"}},"image":{"$ref":"#/definitions/image"},"init":{"description":"Scripts that are called at very beginning, before repo cloning","type":"array","items":{"$ref":"#/definitions/command"}},"clone_folder":{"type":"string","description":"Clone directory"},"shallow_clone":{"type":"boolean","description":"Fetch repository as zip archive","default":false},"clone_depth":{"description":"Set git clone depth","type":"integer"},"hosts":{"title":"host options","type":"object","description":"Setting up etc\\hosts file","additionalProperties":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}]}},"environment":{"description":"Environment variables","anyOf":[{"title":"environment options","type":"object","properties":{"global":{"$ref":"#/definitions/envVarHash","description":"variables defined here are no different than those defined at top level of 'environment' node"},"matrix":{"type":"array","description":"an array of environment variables, each member of which is one dimension in the build matrix calculation","items":{"$ref":"#/definitions/envVarHash"}}}},{"$ref":"#/definitions/envVarHash"}]},"matrix":{"title":"matrix options","type":"object","additionalProperties":false,"properties":{"fast_finish":{"type":"boolean","description":"Set this flag to immediately finish build once one of the jobs fails"},"allow_failures":{"type":"array","description":"This is how to allow failing jobs in the matrix","items":{"$ref":"#/definitions/jobScalars"}},"exclude":{"type":"array","description":"Exclude configuration from the matrix. Works similarly to 'allow_failures' but build not even being started for excluded combination.","items":{"$ref":"#/definitions/job"}}}},"cache":{"type":"array","description":"Build cache to preserve files/folders between builds","items":{"type":"string"}},"services":{"type":"array","description":"Enable service required for build/tests","items":{"enum":["docker","iis","mongodb","msmq","mssql","mssql2008r2sp2","mssql2008r2sp2rs","mssql2012sp1","mssql2012sp1rs","mssql2014","mssql2014rs","mssql2016","mssql2017","mysql","postgresql","postgresql93","postgresql94","postgresql95","postgresql96","postgresql10","postgresql11","postgresql12","postgresql13"]}},"install":{"description":"Scripts that run after cloning repository","type":"array","items":{"$ref":"#/definitions/command"}},"assembly_info":{"title":"assembly options","type":"object","description":"Enable patching of AssemblyInfo.* files","additionalProperties":false,"properties":{"patch":{"type":"boolean"},"file":{"type":"string"},"assembly_version":{"type":"string"},"assembly_file_version":{"type":"string"},"assembly_informational_version":{"type":"string"}}},"nuget":{"title":"NuGet options","type":"object","description":"Automatically register private account and/or project AppVeyor NuGet feeds","properties":{"account_feed":{"type":"boolean"},"project_feed":{"type":"boolean"},"disable_publish_on_pr":{"type":"boolean","description":"Disable publishing of .nupkg artifacts to account/project feeds for pull request builds"}}},"platform":{"description":"Build platform, i.e. x86, x64, Any CPU. This setting is optional","oneOf":[{"$ref":"#/definitions/platform"},{"type":"array","items":{"$ref":"#/definitions/platform"}}]},"configuration":{"description":"Build Configuration, i.e. Debug, Release, etc.","oneOf":[{"$ref":"#/definitions/configuration"},{"type":"array","items":{"$ref":"#/definitions/configuration"}}]},"build":{"oneOf":[{"type":"boolean","enum":[false]},{"title":"build options","type":"object","additionalProperties":false,"properties":{"parallel":{"type":"boolean","description":"Enable MSBuild parallel builds"},"project":{"type":"string","description":"Path to Visual Studio solution or project"},"publish_wap":{"type":"boolean","description":"Package Web Application Projects (WAP) for Web Deploy"},"publish_wap_xcopy":{"type":"boolean","description":"Package Web Application Projects (WAP) for XCopy deployment"},"publish_wap_beanstalk":{"type":"boolean","description":"Package Web Applications for AWS Elastic Beanstalk deployment"},"publish_wap_octopus":{"type":"boolean","description":"Package Web Applications for Octopus deployment"},"publish_azure_webjob":{"type":"boolean","description":"Package Azure WebJobs for Zip Push deployment"},"publish_azure":{"type":"boolean","description":"Package Azure Cloud Service projects and push to artifacts"},"publish_aspnet_core":{"type":"boolean","description":"Package ASP.NET Core projects"},"publish_core_console":{"type":"boolean","description":"Package .NET Core console projects"},"publish_nuget":{"type":"boolean","description":"Package projects with .nuspec files and push to artifacts"},"publish_nuget_symbols":{"type":"boolean","description":"Generate and publish NuGet symbol packages"},"include_nuget_references":{"type":"boolean","description":"Add -IncludeReferencedProjects option while packaging NuGet artifacts"},"verbosity":{"enum":["quiet","minimal","normal","detailed"],"description":"MSBuild verbosity level"}}}]},"before_build":{"description":"Scripts to run before build","type":"array","items":{"$ref":"#/definitions/command"}},"before_package":{"description":"Scripts to run *after* solution is built and *before* automatic packaging occurs (web apps, NuGet packages, Azure Cloud Services)","type":"array","items":{"$ref":"#/definitions/command"}},"after_build":{"description":"Scripts to run after build","type":"array","items":{"$ref":"#/definitions/command"}},"build_script":{"description":"To run your custom scripts instead of automatic MSBuild","type":"array","items":{"$ref":"#/definitions/command"}},"before_test":{"description":"Scripts to run before tests","type":"array","items":{"$ref":"#/definitions/command"}},"test":{"oneOf":[{"type":"boolean","enum":[false],"description":"To disable automatic tests"},{"title":"test options","description":"To run tests again only selected assemblies and/or categories","type":"object","additionalProperties":false,"properties":{"assemblies":{"title":"assembly options","type":"object","additionalProperties":false,"properties":{"only":{"type":"array","items":{"type":"string"}},"except":{"type":"array","items":{"type":"string"}}}},"categories":{"oneOf":[{"title":"category options","type":"object","additionalProperties":false,"properties":{"only":{"type":"array","items":{"type":"string"}},"except":{"type":"array","items":{"type":"string"}}}},{"description":"To run tests from different categories as separate jobs in parallel","type":"array","items":{"oneOf":[{"type":"string","description":"A category common for all jobs"},{"type":"array","items":{"type":"string"}}]}}]}}}]},"test_script":{"description":"To run your custom scripts instead of automatic tests","type":"array","items":{"$ref":"#/definitions/command"}},"after_test":{"type":"array","description":"Scripts to run after tests","items":{"$ref":"#/definitions/command"}},"artifacts":{"type":"array","items":{"title":"artifact options","type":"object","additionalProperties":false,"properties":{"path":{"type":"string"},"name":{"type":"string"},"type":{"enum":["Auto","WebDeployPackage","NuGetPackage","AzureCloudService","AzureCloudServiceConfig","SsdtPackage","Zip","File"]}},"required":["path"]}},"before_deploy":{"type":"array","description":"Scripts to run before deployment","items":{"$ref":"#/definitions/command"}},"deploy":{"oneOf":[{"enum":["off"]},{"type":"array","items":{"title":"deployment options","type":"object"}}]},"deploy_script":{"description":"To run your custom scripts instead of provider deployments","type":"array","items":{"$ref":"#/definitions/command"}},"after_deploy":{"type":"array","description":"Scripts to run after deployment","items":{"$ref":"#/definitions/command"}},"on_success":{"type":"array","description":"On successful build","items":{"$ref":"#/definitions/command"}},"on_failure":{"type":"array","description":"On build failure","items":{"$ref":"#/definitions/command"}},"on_finish":{"type":"array","description":"After build failure or success","items":{"$ref":"#/definitions/command"}}}}},"id":"https://json.schemastore.org/appveyor.json","title":"JSON schema for AppVeyor CI configuration files"}
|
Provide a JSON object that satisfies the schema "JSON schema for AppVeyor CI configuration files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for AppVeyor CI configuration files
|
schema-store
|
schema_store_49
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://github.com/aquaproj/aqua/v2/pkg/controller/generate-registry/raw-config\",\"$ref\":\"#/$defs/RawConfig\",\"$defs\":{\"RawConfig\":{\"properties\":{\"version_filter\":{\"type\":\"string\"},\"version_prefix\":{\"type\":\"string\"},\"all_assets_filter\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"name\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aqua-generate-registry\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://github.com/aquaproj/aqua/v2/pkg/controller/generate-registry/raw-config","$ref":"#/$defs/RawConfig","$defs":{"RawConfig":{"properties":{"version_filter":{"type":"string"},"version_prefix":{"type":"string"},"all_assets_filter":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false,"type":"object","required":["name"]}}}
|
Provide a JSON object that satisfies the schema "aqua-generate-registry". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
aqua-generate-registry
|
schema-store
|
schema_store_50
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://github.com/aquaproj/aqua/v2/pkg/config/aqua/config\",\"$ref\":\"#/$defs/Config\",\"$defs\":{\"Checksum\":{\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"require_checksum\":{\"type\":\"boolean\"},\"supported_envs\":{\"$ref\":\"#/$defs/SupportedEnvs\"}},\"additionalProperties\":false,\"type\":\"object\"},\"CommandAlias\":{\"properties\":{\"command\":{\"type\":\"string\"},\"alias\":{\"type\":\"string\"},\"no_link\":{\"type\":\"boolean\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"command\",\"alias\"]},\"Config\":{\"properties\":{\"packages\":{\"items\":{\"$ref\":\"#/$defs/Package\"},\"type\":\"array\"},\"registries\":{\"$ref\":\"#/$defs/Registries\"},\"checksum\":{\"$ref\":\"#/$defs/Checksum\"},\"import_dir\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\",\"required\":[\"registries\"]},\"Package\":{\"properties\":{\"name\":{\"type\":\"string\"},\"registry\":{\"type\":\"string\",\"description\":\"Registry name\",\"default\":\"standard\",\"examples\":[\"foo\",\"local\"]},\"version\":{\"type\":\"string\"},\"import\":{\"type\":\"string\"},\"tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"description\":{\"type\":\"string\"},\"link\":{\"type\":\"string\"},\"update\":{\"$ref\":\"#/$defs/Update\"},\"go_version_file\":{\"type\":\"string\"},\"version_expr\":{\"type\":\"string\"},\"version_expr_prefix\":{\"type\":\"string\"},\"vars\":{\"type\":\"object\"},\"command_aliases\":{\"items\":{\"$ref\":\"#/$defs/CommandAlias\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"Registries\":{\"items\":{\"properties\":{\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\",\"enum\":[\"standard\",\"local\",\"github_content\"]},\"repo_owner\":{\"type\":\"string\"},\"repo_name\":{\"type\":\"string\"},\"ref\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"private\":{\"type\":\"boolean\"}},\"additionalProperties\":false,\"type\":\"object\"},\"type\":\"array\"},\"SupportedEnvs\":{\"items\":{\"type\":\"string\",\"enum\":[\"all\",\"darwin\",\"linux\",\"windows\",\"amd64\",\"arm64\",\"darwin/amd64\",\"darwin/arm64\",\"linux/amd64\",\"linux/arm64\",\"windows/amd64\",\"windows/arm64\"]},\"type\":\"array\"},\"Update\":{\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"allowed_version\":{\"type\":\"string\"},\"types\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aqua-yaml\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://github.com/aquaproj/aqua/v2/pkg/config/aqua/config","$ref":"#/$defs/Config","$defs":{"Checksum":{"properties":{"enabled":{"type":"boolean"},"require_checksum":{"type":"boolean"},"supported_envs":{"$ref":"#/$defs/SupportedEnvs"}},"additionalProperties":false,"type":"object"},"CommandAlias":{"properties":{"command":{"type":"string"},"alias":{"type":"string"},"no_link":{"type":"boolean"}},"additionalProperties":false,"type":"object","required":["command","alias"]},"Config":{"properties":{"packages":{"items":{"$ref":"#/$defs/Package"},"type":"array"},"registries":{"$ref":"#/$defs/Registries"},"checksum":{"$ref":"#/$defs/Checksum"},"import_dir":{"type":"string"}},"additionalProperties":false,"type":"object","required":["registries"]},"Package":{"properties":{"name":{"type":"string"},"registry":{"type":"string","description":"Registry name","default":"standard","examples":["foo","local"]},"version":{"type":"string"},"import":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"link":{"type":"string"},"update":{"$ref":"#/$defs/Update"},"go_version_file":{"type":"string"},"version_expr":{"type":"string"},"version_expr_prefix":{"type":"string"},"vars":{"type":"object"},"command_aliases":{"items":{"$ref":"#/$defs/CommandAlias"},"type":"array"}},"additionalProperties":false,"type":"object"},"Registries":{"items":{"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["standard","local","github_content"]},"repo_owner":{"type":"string"},"repo_name":{"type":"string"},"ref":{"type":"string"},"path":{"type":"string"},"private":{"type":"boolean"}},"additionalProperties":false,"type":"object"},"type":"array"},"SupportedEnvs":{"items":{"type":"string","enum":["all","darwin","linux","windows","amd64","arm64","darwin/amd64","darwin/arm64","linux/amd64","linux/arm64","windows/amd64","windows/arm64"]},"type":"array"},"Update":{"properties":{"enabled":{"type":"boolean"},"allowed_version":{"type":"string"},"types":{"items":{"type":"string"},"type":"array"}},"additionalProperties":false,"type":"object"}}}
|
Provide a JSON object that satisfies the schema "aqua-yaml". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
aqua-yaml
|
schema-store
|
schema_store_51
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/schema\",\"$id\":\"arb.json\",\"title\":\"Product\",\"description\":\"A product in the catalog\",\"type\":\"object\",\"patternProperties\":{\"^@@x-.+$\":{\"type\":[\"string\",\"number\",\"integer\",\"boolean\"],\"description\":\"A custom global attribute.\"},\"^@(?!@).+$\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"text\",\"image\",\"css\"],\"description\":\"The type of resource. Possible values are \\\"text\\\", \\\"image\\\", or \\\"css\\\". Program should not rely on this attribute in run time. It is mainly for the localization tools.\"},\"context\":{\"type\":\"string\",\"description\":\"The context in which this resource applies. Context is organized in hierarchy, and level separated by \\\":\\\". Tools can use this information to restore the tree structure from ARB's flat layout. When this piece of information is missing, it defaults to global.\"},\"placeholders\":{\"type\":\"object\",\"patternProperties\":{\"^.+$\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"String\"]},\"example\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"}},\"description\":\"A named placeholder of type String.\",\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"int\",\"double\",\"num\"],\"description\":\"The type of the parameter, either String, Object, int, double, num, or DateTime.\"},\"format\":{\"type\":\"string\",\"enum\":[\"compact\",\"compactCurrency\",\"compactSimpleCurrency\",\"compactLong\",\"currency\",\"decimalPattern\",\"decimalPatternDigits\",\"decimalPercentPattern\",\"percentPattern\",\"scientificPattern\",\"simpleCurrency\"],\"description\":\"\"},\"example\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"optionalParameters\":{\"type\":\"object\"}},\"description\":\"A number placeholder.\",\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"DateTime\"],\"description\":\"The type of the parameter, either String, Object, int, double, num, or DateTime.\"},\"format\":{\"type\":\"string\",\"description\":\"The formatters are the ones provided by the DateFormat class in Dart's package:intl.\"},\"isCustomDateFormat\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"true\",\"false\"]},{\"type\":\"boolean\"}]},\"example\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"optionalParameters\":{\"type\":\"object\"}},\"description\":\"A Date placeholder.\",\"additionalProperties\":false,\"anyOf\":[{\"required\":[\"isCustomDateFormat\"],\"properties\":{\"isCustomDateFormat\":{\"oneOf\":[{\"type\":\"string\",\"const\":\"true\"},{\"type\":\"boolean\",\"const\":true}]}}},{\"required\":[\"format\"],\"properties\":{\"format\":{\"type\":\"string\",\"oneOf\":[{\"const\":\"d\",\"examples\":[],\"description\":\"DAY\"},{\"const\":\"E\",\"description\":\"ABBR_WEEKDAY\"},{\"const\":\"EEEE\",\"description\":\"WEEKDAY\"},{\"const\":\"LLL\",\"description\":\"ABBR_STANDALONE_MONTH\"},{\"const\":\"LLLL\",\"description\":\"STANDALONE_MONTH\"},{\"const\":\"M\",\"description\":\"NUM_MONTH\"},{\"const\":\"Md\",\"description\":\"NUM_MONTH_DAY\"},{\"const\":\"MEd\",\"description\":\"NUM_MONTH_WEEKDAY_DAY\"},{\"const\":\"MMM\",\"description\":\"ABBR_MONTH\"},{\"const\":\"MMMd\",\"description\":\"ABBR_MONTH_DAY\"},{\"const\":\"MMMEd\",\"description\":\"ABBR_MONTH_WEEKDAY_DAY\"},{\"const\":\"MMMM\",\"description\":\"MONTH\"},{\"const\":\"MMMMd\",\"description\":\"MONTH_DAY\"},{\"const\":\"MMMMEEEEd\",\"description\":\"MONTH_WEEKDAY_DAY\"},{\"const\":\"QQQ\",\"description\":\"ABBR_QUARTER\"},{\"const\":\"QQQQ\",\"description\":\"QUARTER\"},{\"const\":\"y\",\"description\":\"YEAR\"},{\"const\":\"yM\",\"description\":\"YEAR_NUM_MONTH\"},{\"const\":\"yMd\",\"description\":\"YEAR_NUM_MONTH_DAY\"},{\"const\":\"yMEd\",\"description\":\"YEAR_NUM_MONTH_WEEKDAY_DAY\"},{\"const\":\"yMMM\",\"description\":\"YEAR_ABBR_MONTH\"},{\"const\":\"yMMMd\",\"description\":\"YEAR_ABBR_MONTH_DAY\"},{\"const\":\"yMMMEd\",\"description\":\"YEAR_ABBR_MONTH_WEEKDAY_DAY\"},{\"const\":\"yMMMM\",\"description\":\"YEAR_MONTH\"},{\"const\":\"yMMMMd\",\"description\":\"YEAR_MONTH_DAY\"},{\"const\":\"yMMMMEEEEd\",\"description\":\"YEAR_MONTH_WEEKDAY_DAY\"},{\"const\":\"yQQQ\",\"description\":\"YEAR_ABBR_QUARTER\"},{\"const\":\"yQQQQ\",\"description\":\"YEAR_QUARTER\"},{\"const\":\"H\",\"description\":\"HOUR24\"},{\"const\":\"Hm\",\"description\":\"HOUR24_MINUTE\"},{\"const\":\"Hms\",\"description\":\"HOUR24_MINUTE_SECOND\"},{\"const\":\"j\",\"description\":\"HOUR\"},{\"const\":\"jm\",\"description\":\"HOUR_MINUTE\"},{\"const\":\"jms\",\"description\":\"HOUR_MINUTE_SECOND\"},{\"const\":\"m\",\"description\":\"MINUTE\"},{\"const\":\"ms\",\"description\":\"MINUTE_SECOND\"},{\"const\":\"s\",\"description\":\"SECOND\"}],\"description\":\"The formatters are the ones provided by the DateFormat class in Dart's package:intl.\"}}}]}]}},\"description\":\"A map from placeholder id to placeholder properties, including description and example. Placeholder can be specified using number (as in \\\"{0}\\\") or name (as in \\\"{num}\\\"). Number starts from 0 and the corresponding argument(s) are passed directly as function arguments. Named arguments are provided through an map object that maps each name to its value.\",\"additionalProperties\":false},\"description\":{\"type\":\"string\",\"description\":\"A short paragraph describing the resource and how it is being used by the app, and message that need to be passed to localization process and translators.\"},\"comment\":{\"type\":\"string\",\"description\":\"A comment on this resource. This is not intended to be sent to translators.\"}},\"description\":\"Metadata for a message.\",\"additionalProperties\":false},\"^(?!@@).+$\":{\"type\":\"string\",\"description\":\"The ID of a message\"}},\"properties\":{\"@@locale\":{\"description\":\"The locale for which messages/resources are stored in this file.\",\"type\":\"string\"},\"@@context\":{\"description\":\"It describes (in text) the context in which all these resources apply.\",\"type\":\"string\"},\"@@last_modified\":{\"description\":\"The last modified time of this ARB file/data. It is presented in ISO8601 complete form with hour and minutes. Example like: 2011-09-08T09:42-07:00.\",\"type\":\"string\"},\"@@author\":{\"description\":\"The author of these messages. In the case of localized ARB files it can contain the names/details of the translator.\",\"type\":\"string\"},\"@@comment\":{\"description\":\"A top-level comment for this file. This is not intended to be sent to translators.\",\"type\":\"string\"}},\"required\":[\"@@locale\"],\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Product\". Here are the required top‑level fields: @@locale. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/schema","$id":"arb.json","title":"Product","description":"A product in the catalog","type":"object","patternProperties":{"^@@x-.+$":{"type":["string","number","integer","boolean"],"description":"A custom global attribute."},"^@(?!@).+$":{"type":"object","properties":{"type":{"type":"string","enum":["text","image","css"],"description":"The type of resource. Possible values are \"text\", \"image\", or \"css\". Program should not rely on this attribute in run time. It is mainly for the localization tools."},"context":{"type":"string","description":"The context in which this resource applies. Context is organized in hierarchy, and level separated by \":\". Tools can use this information to restore the tree structure from ARB's flat layout. When this piece of information is missing, it defaults to global."},"placeholders":{"type":"object","patternProperties":{"^.+$":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["String"]},"example":{"type":"string"},"description":{"type":"string"}},"description":"A named placeholder of type String.","additionalProperties":false},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["int","double","num"],"description":"The type of the parameter, either String, Object, int, double, num, or DateTime."},"format":{"type":"string","enum":["compact","compactCurrency","compactSimpleCurrency","compactLong","currency","decimalPattern","decimalPatternDigits","decimalPercentPattern","percentPattern","scientificPattern","simpleCurrency"],"description":""},"example":{"type":"string"},"description":{"type":"string"},"optionalParameters":{"type":"object"}},"description":"A number placeholder.","additionalProperties":false},{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["DateTime"],"description":"The type of the parameter, either String, Object, int, double, num, or DateTime."},"format":{"type":"string","description":"The formatters are the ones provided by the DateFormat class in Dart's package:intl."},"isCustomDateFormat":{"oneOf":[{"type":"string","enum":["true","false"]},{"type":"boolean"}]},"example":{"type":"string"},"description":{"type":"string"},"optionalParameters":{"type":"object"}},"description":"A Date placeholder.","additionalProperties":false,"anyOf":[{"required":["isCustomDateFormat"],"properties":{"isCustomDateFormat":{"oneOf":[{"type":"string","const":"true"},{"type":"boolean","const":true}]}}},{"required":["format"],"properties":{"format":{"type":"string","oneOf":[{"const":"d","examples":[],"description":"DAY"},{"const":"E","description":"ABBR_WEEKDAY"},{"const":"EEEE","description":"WEEKDAY"},{"const":"LLL","description":"ABBR_STANDALONE_MONTH"},{"const":"LLLL","description":"STANDALONE_MONTH"},{"const":"M","description":"NUM_MONTH"},{"const":"Md","description":"NUM_MONTH_DAY"},{"const":"MEd","description":"NUM_MONTH_WEEKDAY_DAY"},{"const":"MMM","description":"ABBR_MONTH"},{"const":"MMMd","description":"ABBR_MONTH_DAY"},{"const":"MMMEd","description":"ABBR_MONTH_WEEKDAY_DAY"},{"const":"MMMM","description":"MONTH"},{"const":"MMMMd","description":"MONTH_DAY"},{"const":"MMMMEEEEd","description":"MONTH_WEEKDAY_DAY"},{"const":"QQQ","description":"ABBR_QUARTER"},{"const":"QQQQ","description":"QUARTER"},{"const":"y","description":"YEAR"},{"const":"yM","description":"YEAR_NUM_MONTH"},{"const":"yMd","description":"YEAR_NUM_MONTH_DAY"},{"const":"yMEd","description":"YEAR_NUM_MONTH_WEEKDAY_DAY"},{"const":"yMMM","description":"YEAR_ABBR_MONTH"},{"const":"yMMMd","description":"YEAR_ABBR_MONTH_DAY"},{"const":"yMMMEd","description":"YEAR_ABBR_MONTH_WEEKDAY_DAY"},{"const":"yMMMM","description":"YEAR_MONTH"},{"const":"yMMMMd","description":"YEAR_MONTH_DAY"},{"const":"yMMMMEEEEd","description":"YEAR_MONTH_WEEKDAY_DAY"},{"const":"yQQQ","description":"YEAR_ABBR_QUARTER"},{"const":"yQQQQ","description":"YEAR_QUARTER"},{"const":"H","description":"HOUR24"},{"const":"Hm","description":"HOUR24_MINUTE"},{"const":"Hms","description":"HOUR24_MINUTE_SECOND"},{"const":"j","description":"HOUR"},{"const":"jm","description":"HOUR_MINUTE"},{"const":"jms","description":"HOUR_MINUTE_SECOND"},{"const":"m","description":"MINUTE"},{"const":"ms","description":"MINUTE_SECOND"},{"const":"s","description":"SECOND"}],"description":"The formatters are the ones provided by the DateFormat class in Dart's package:intl."}}}]}]}},"description":"A map from placeholder id to placeholder properties, including description and example. Placeholder can be specified using number (as in \"{0}\") or name (as in \"{num}\"). Number starts from 0 and the corresponding argument(s) are passed directly as function arguments. Named arguments are provided through an map object that maps each name to its value.","additionalProperties":false},"description":{"type":"string","description":"A short paragraph describing the resource and how it is being used by the app, and message that need to be passed to localization process and translators."},"comment":{"type":"string","description":"A comment on this resource. This is not intended to be sent to translators."}},"description":"Metadata for a message.","additionalProperties":false},"^(?!@@).+$":{"type":"string","description":"The ID of a message"}},"properties":{"@@locale":{"description":"The locale for which messages/resources are stored in this file.","type":"string"},"@@context":{"description":"It describes (in text) the context in which all these resources apply.","type":"string"},"@@last_modified":{"description":"The last modified time of this ARB file/data. It is presented in ISO8601 complete form with hour and minutes. Example like: 2011-09-08T09:42-07:00.","type":"string"},"@@author":{"description":"The author of these messages. In the case of localized ARB files it can contain the names/details of the translator.","type":"string"},"@@comment":{"description":"A top-level comment for this file. This is not intended to be sent to translators.","type":"string"}},"required":["@@locale"],"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "Product". Here are the required top‑level fields: @@locale. Return only the valid JSON object.
|
Product
|
schema-store
|
schema_store_52
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"definitions\":{\"strictName\":{\"type\":\"string\",\"pattern\":\"^[a-z][a-z0-9\\\\-]+$\"},\"looseName\":{\"type\":\"string\",\"pattern\":\"^[a-z][a-zA-Z0-9\\\\-_]+$\"},\"macros\":{\"type\":\"string\",\"pattern\":\"^[a-z][a-zA-Z0-9\\\\-_/.]+$\"},\"region\":{\"type\":\"string\",\"enum\":[\"us-east-1\",\"us-east-2\",\"us-west-1\",\"us-west-2\",\"ca-central-1\",\"eu-west-1\",\"eu-central-1\",\"eu-west-2\",\"eu-west-3\",\"eu-north-1\",\"ap-northeast-1\",\"ap-northeast-2\",\"ap-southeast-1\",\"ap-southeast-2\",\"ap-south-1\",\"sa-east-1\",\"us-gov-west-1\",\"us-gov-east-1\"]},\"table\":{\"type\":\"object\",\"title\":\"DynamoDB table\",\"propertyNames\":{\"pattern\":\"^[a-z][a-z|0-9|\\\\-]+$\"},\"minProperties\":1,\"maxProperties\":1}},\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://arc.codes/schema.json\",\"type\":\"object\",\"title\":\"OpenJS Architect JSON Schema\",\"required\":[\"app\"],\"additionalProperties\":{\"type\":[\"array\",\"object\"],\"items\":{\"type\":[\"string\",\"number\",\"boolean\",\"array\",\"object\"]}},\"properties\":{\"app\":{\"$id\":\"#/properties/app\",\"title\":\"@app\",\"description\":\"Application namespace\",\"type\":[\"string\",\"array\"],\"maxItems\":1,\"items\":{\"$ref\":\"#/definitions/looseName\"}},\"aws\":{\"$id\":\"#/properties/aws\",\"title\":\"@aws\",\"description\":\"AWS specific configuration\",\"type\":[\"array\",\"object\"],\"maxItems\":12,\"uniqueItems\":true,\"items\":{\"type\":[\"array\",\"object\"],\"maxItems\":2,\"items\":[{\"type\":\"string\",\"enum\":[\"apigateway\",\"bucket\",\"concurrency\",\"layer\",\"layers\",\"memory\",\"policy\",\"policies\",\"profile\",\"region\",\"runtime\",\"timeout\"]},{\"type\":[\"string\",\"number\"]}]},\"properties\":{\"apigateway\":{\"type\":\"string\"},\"bucket\":{\"type\":\"string\"},\"concurrency\":{\"type\":\"number\"},\"layer\":{\"type\":[\"string\",\"object\",\"array\"]},\"layers\":{\"type\":[\"string\",\"object\",\"array\"]},\"memory\":{\"type\":\"number\"},\"policy\":{\"type\":[\"string\",\"object\",\"array\"]},\"policies\":{\"type\":[\"string\",\"object\",\"array\"]},\"profile\":{\"type\":\"string\"},\"region\":{\"type\":\"string\"},\"runtime\":{\"type\":\"string\"},\"timeout\":{\"type\":\"number\"}}},\"static\":{\"$id\":\"#/properties/static\",\"title\":\"@static\",\"description\":\"Static asset & S3 configuration\",\"uniqueItems\":true,\"type\":\"array\",\"maxItems\":6,\"items\":{\"type\":[\"array\",\"object\"],\"items\":[{\"type\":\"string\",\"enum\":[\"fingerprint\",\"folder\",\"ignore\",\"prefix\",\"production\",\"prune\",\"spa\",\"staging\"]},{\"type\":[\"string\",\"boolean\",\"array\",\"object\"]}],\"properties\":{\"fingerprint\":{\"type\":[\"boolean\",\"string\"]},\"folder\":{\"type\":\"string\"},\"ignore\":{\"type\":[\"string\",\"object\",\"array\"]},\"prefix\":{\"type\":\"string\"},\"production\":{\"type\":\"string\"},\"prune\":{\"type\":\"boolean\"},\"spa\":{\"type\":\"boolean\"},\"staging\":{\"type\":\"string\"}}}},\"ws\":{\"$id\":\"#/properties/ws\",\"type\":\"array\",\"title\":\"@ws\",\"description\":\"API Gateway WebSocket configuration\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/strictName\"}},\"http\":{\"$id\":\"#/properties/http\",\"title\":\"@http\",\"description\":\"API Gateway configuration\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":[\"array\",\"object\"],\"maxItems\":2,\"maxProperties\":1,\"properties\":{\"any\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"get\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"post\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"put\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"patch\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"delete\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"head\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"},\"options\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"}},\"items\":[{\"type\":\"string\",\"enum\":[\"any\",\"get\",\"post\",\"put\",\"patch\",\"delete\",\"head\",\"options\"]},{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9\\\\/\\\\-:\\\\._\\\\*]+$\"}]}},\"proxy\":{\"$id\":\"#/properties/http\",\"title\":\"@proxy\",\"description\":\"Proxy\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":[\"array\",\"object\"],\"maxItems\":3,\"maxProperties\":1,\"properties\":{\"testing\":{\"type\":\"string\",\"pattern\":\"^https?:\\\\/\\\\/.+$\"},\"staging\":{\"type\":\"string\",\"pattern\":\"^https?:\\\\/\\\\/.+$\"},\"production\":{\"type\":\"string\",\"pattern\":\"^https?:\\\\/\\\\/.+$\"}},\"items\":[{\"type\":\"string\",\"enum\":[\"testing\",\"staging\",\"production\"]},{\"type\":\"string\",\"pattern\":\"^https?:\\\\/\\\\/.+$\"}]}},\"events\":{\"$id\":\"#/properties/events\",\"type\":\"array\",\"title\":\"@events\",\"description\":\"Events configuration\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/strictName\"}},\"queues\":{\"$id\":\"#/properties/queues\",\"type\":\"array\",\"title\":\"@queues\",\"description\":\"Queues configuration\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/strictName\"}},\"macros\":{\"$id\":\"#/properties/macros\",\"type\":\"array\",\"title\":\"@macros\",\"description\":\"Deployment macros configuration\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/macros\"}},\"scheduled\":{\"$id\":\"#/properties/scheduled\",\"type\":[\"array\",\"object\"],\"title\":\"@scheduled\",\"description\":\"Scheduled event configuration\",\"uniqueItems\":true,\"items\":{\"$id\":\"#/properties/scheduled/items\",\"type\":[\"array\",\"object\"],\"title\":\"scheduled handlers\",\"items\":[{\"type\":\"string\",\"pattern\":\"^[a-z][a-z|\\\\-|0-9]+$\"},{\"type\":\"string\",\"pattern\":\"^(rate|cron)\"}]}},\"tables\":{\"$id\":\"#/properties/tables\",\"type\":\"array\",\"title\":\"@tables\",\"description\":\"DynamoDB database tables configuration\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/table\"}},\"indexes\":{\"$id\":\"#/properties/indexes\",\"type\":\"array\",\"title\":\"@indexes\",\"description\":\"DynamoDB global secondary indexes configuration\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/table\"}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"OpenJS Architect JSON Schema\". Here are the required top‑level fields: app. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"definitions":{"strictName":{"type":"string","pattern":"^[a-z][a-z0-9\\-]+$"},"looseName":{"type":"string","pattern":"^[a-z][a-zA-Z0-9\\-_]+$"},"macros":{"type":"string","pattern":"^[a-z][a-zA-Z0-9\\-_/.]+$"},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","ap-northeast-1","ap-northeast-2","ap-southeast-1","ap-southeast-2","ap-south-1","sa-east-1","us-gov-west-1","us-gov-east-1"]},"table":{"type":"object","title":"DynamoDB table","propertyNames":{"pattern":"^[a-z][a-z|0-9|\\-]+$"},"minProperties":1,"maxProperties":1}},"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://arc.codes/schema.json","type":"object","title":"OpenJS Architect JSON Schema","required":["app"],"additionalProperties":{"type":["array","object"],"items":{"type":["string","number","boolean","array","object"]}},"properties":{"app":{"$id":"#/properties/app","title":"@app","description":"Application namespace","type":["string","array"],"maxItems":1,"items":{"$ref":"#/definitions/looseName"}},"aws":{"$id":"#/properties/aws","title":"@aws","description":"AWS specific configuration","type":["array","object"],"maxItems":12,"uniqueItems":true,"items":{"type":["array","object"],"maxItems":2,"items":[{"type":"string","enum":["apigateway","bucket","concurrency","layer","layers","memory","policy","policies","profile","region","runtime","timeout"]},{"type":["string","number"]}]},"properties":{"apigateway":{"type":"string"},"bucket":{"type":"string"},"concurrency":{"type":"number"},"layer":{"type":["string","object","array"]},"layers":{"type":["string","object","array"]},"memory":{"type":"number"},"policy":{"type":["string","object","array"]},"policies":{"type":["string","object","array"]},"profile":{"type":"string"},"region":{"type":"string"},"runtime":{"type":"string"},"timeout":{"type":"number"}}},"static":{"$id":"#/properties/static","title":"@static","description":"Static asset & S3 configuration","uniqueItems":true,"type":"array","maxItems":6,"items":{"type":["array","object"],"items":[{"type":"string","enum":["fingerprint","folder","ignore","prefix","production","prune","spa","staging"]},{"type":["string","boolean","array","object"]}],"properties":{"fingerprint":{"type":["boolean","string"]},"folder":{"type":"string"},"ignore":{"type":["string","object","array"]},"prefix":{"type":"string"},"production":{"type":"string"},"prune":{"type":"boolean"},"spa":{"type":"boolean"},"staging":{"type":"string"}}}},"ws":{"$id":"#/properties/ws","type":"array","title":"@ws","description":"API Gateway WebSocket configuration","uniqueItems":true,"items":{"$ref":"#/definitions/strictName"}},"http":{"$id":"#/properties/http","title":"@http","description":"API Gateway configuration","type":"array","uniqueItems":true,"items":{"type":["array","object"],"maxItems":2,"maxProperties":1,"properties":{"any":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"get":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"post":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"put":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"patch":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"delete":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"head":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"},"options":{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}},"items":[{"type":"string","enum":["any","get","post","put","patch","delete","head","options"]},{"type":"string","pattern":"^[a-zA-Z0-9\\/\\-:\\._\\*]+$"}]}},"proxy":{"$id":"#/properties/http","title":"@proxy","description":"Proxy","type":"array","uniqueItems":true,"items":{"type":["array","object"],"maxItems":3,"maxProperties":1,"properties":{"testing":{"type":"string","pattern":"^https?:\\/\\/.+$"},"staging":{"type":"string","pattern":"^https?:\\/\\/.+$"},"production":{"type":"string","pattern":"^https?:\\/\\/.+$"}},"items":[{"type":"string","enum":["testing","staging","production"]},{"type":"string","pattern":"^https?:\\/\\/.+$"}]}},"events":{"$id":"#/properties/events","type":"array","title":"@events","description":"Events configuration","uniqueItems":true,"items":{"$ref":"#/definitions/strictName"}},"queues":{"$id":"#/properties/queues","type":"array","title":"@queues","description":"Queues configuration","uniqueItems":true,"items":{"$ref":"#/definitions/strictName"}},"macros":{"$id":"#/properties/macros","type":"array","title":"@macros","description":"Deployment macros configuration","uniqueItems":true,"items":{"$ref":"#/definitions/macros"}},"scheduled":{"$id":"#/properties/scheduled","type":["array","object"],"title":"@scheduled","description":"Scheduled event configuration","uniqueItems":true,"items":{"$id":"#/properties/scheduled/items","type":["array","object"],"title":"scheduled handlers","items":[{"type":"string","pattern":"^[a-z][a-z|\\-|0-9]+$"},{"type":"string","pattern":"^(rate|cron)"}]}},"tables":{"$id":"#/properties/tables","type":"array","title":"@tables","description":"DynamoDB database tables configuration","uniqueItems":true,"items":{"$ref":"#/definitions/table"}},"indexes":{"$id":"#/properties/indexes","type":"array","title":"@indexes","description":"DynamoDB global secondary indexes configuration","uniqueItems":true,"items":{"$ref":"#/definitions/table"}}}}
|
Provide a JSON object that satisfies the schema "OpenJS Architect JSON Schema". Here are the required top‑level fields: app. Return only the valid JSON object.
|
OpenJS Architect JSON Schema
|
schema-store
|
schema_store_53
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"properties\":{\"name\":{\"type\":\"string\"},\"policy_assignments\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"policy_definitions\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"policy_set_definitions\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"role_definitions\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"name\"],\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"archetype_definition\". Here are the required top‑level fields: name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","properties":{"name":{"type":"string"},"policy_assignments":{"items":{"type":"string"},"type":"array"},"policy_definitions":{"items":{"type":"string"},"type":"array"},"policy_set_definitions":{"items":{"type":"string"},"type":"array"},"role_definitions":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"}
|
Provide a JSON object that satisfies the schema "archetype_definition". Here are the required top‑level fields: name. Return only the valid JSON object.
|
archetype_definition
|
schema-store
|
schema_store_54
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"properties\":{\"base_archetype\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"policy_assignments_to_add\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"policy_assignments_to_remove\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"policy_definitions_to_add\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"policy_definitions_to_remove\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"policy_set_definitions_to_add\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"policy_set_definitions_to_remove\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"role_definitions_to_add\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"role_definitions_to_remove\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]}},\"required\":[\"base_archetype\",\"name\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"archetype_override\". Here are the required top‑level fields: base_archetype, name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"base_archetype":{"type":"string"},"name":{"type":"string"},"policy_assignments_to_add":{"type":"array","items":[{"type":"string"}]},"policy_assignments_to_remove":{"type":"array","items":[{"type":"string"}]},"policy_definitions_to_add":{"type":"array","items":[{"type":"string"}]},"policy_definitions_to_remove":{"type":"array","items":[{"type":"string"}]},"policy_set_definitions_to_add":{"type":"array","items":[{"type":"string"}]},"policy_set_definitions_to_remove":{"type":"array","items":[{"type":"string"}]},"role_definitions_to_add":{"type":"array","items":[{"type":"string"}]},"role_definitions_to_remove":{"type":"array","items":[{"type":"string"}]}},"required":["base_archetype","name"]}
|
Provide a JSON object that satisfies the schema "archetype_override". Here are the required top‑level fields: base_archetype, name. Return only the valid JSON object.
|
archetype_override
|
schema-store
|
schema_store_55
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$id\":\"https://raw.githubusercontent.com/architect-team/architect-cli/main/src/dependency-manager/schema/architect.schema.json\",\"title\":\"Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml\",\"$schema\":\"http://json-schema.org/draft-07/schema\",\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.\"},\"keywords\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"Additional search terms to be used when the component is indexed so that others can find it more easily.\"},\"author\":{\"type\":\"string\",\"description\":\"The name or handle of the author of the component as a developer contact.\"},\"homepage\":{\"type\":\"string\",\"description\":\"The url that serves as the informational homepage of the component (i.e. a github repo).\"},\"secrets\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/SecretDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec\",\"additionalProperties\":false},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false},\"databases\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false},\"services\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false},\"tasks\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false},\"dependencies\":{\"type\":\"object\",\"patternProperties\":{\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}},{\"$ref\":\"#/definitions/DependencySpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)\",\"additionalProperties\":false},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false},\"artifact_image\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"-\"}},\"type\":\"object\",\"required\":[\"name\"],\"description\":\"The top level object of the `architect.yml`; defines a deployable Architect Component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.\"},\"keywords\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"Additional search terms to be used when the component is indexed so that others can find it more easily.\"},\"author\":{\"type\":\"string\",\"description\":\"The name or handle of the author of the component as a developer contact.\"},\"homepage\":{\"type\":\"string\",\"description\":\"The url that serves as the informational homepage of the component (i.e. a github repo).\"},\"secrets\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/SecretDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec\",\"additionalProperties\":false},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false},\"databases\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false},\"services\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false},\"tasks\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false},\"dependencies\":{\"type\":\"object\",\"patternProperties\":{\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}},{\"$ref\":\"#/definitions/DependencySpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)\",\"additionalProperties\":false},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false},\"artifact_image\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"-\"}},\"type\":\"object\",\"required\":[\"name\"],\"description\":\"The top level object of the `architect.yml`; defines a deployable Architect Component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentspec\"},\"patternProperties\":{}}]}},\"definitions\":{\"DatabaseSpec\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"type\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\",\"enum\":[\"postgres:10\",\"postgres:11\",\"postgres:12\",\"postgres:13\",\"postgres:14\",\"postgres:15\",\"mysql:5\",\"mysql:6\",\"mysql:7\",\"mysql:8\",\"mariadb:10\"]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The type engine and version of database software needed for data storage.\",\"errorMessage\":\"must be of the format <engine>:<version> (e.g. postgres:13)\"},\"connection_string\":{\"anyOf\":[{\"format\":\"uri\",\"type\":\"string\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The connection uri of an existing database to use instead of provisioning a new one\"}},\"type\":\"object\",\"required\":[\"type\"],\"description\":\"Component databases let you quickly spin up a database for your service\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#databasespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"type\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\",\"enum\":[\"postgres:10\",\"postgres:11\",\"postgres:12\",\"postgres:13\",\"postgres:14\",\"postgres:15\",\"mysql:5\",\"mysql:6\",\"mysql:7\",\"mysql:8\",\"mariadb:10\"]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The type engine and version of database software needed for data storage.\",\"errorMessage\":\"must be of the format <engine>:<version> (e.g. postgres:13)\"},\"connection_string\":{\"anyOf\":[{\"format\":\"uri\",\"type\":\"string\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The connection uri of an existing database to use instead of provisioning a new one\"}},\"type\":\"object\",\"required\":[\"type\"],\"description\":\"Component databases let you quickly spin up a database for your service\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#databasespec\"},\"patternProperties\":{}}]}}},\"SecretDefinitionSpec\":{\"properties\":{\"required\":{\"type\":\"boolean\",\"description\":\"Denotes whether the secret is required.\"},\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the secret.\"},\"default\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"object\"},{\"type\":\"string\"},{\"type\":\"null\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Sets a default value for the secret if one is not provided\"}},\"type\":\"object\",\"description\":\"Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#secretdefinitionspec\"}},\"LivenessProbeSpec\":{\"properties\":{\"success_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a health check before the container is considered healthy.\",\"default\":1},\"failure_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a failed health check before the container is considered unhealthy.\",\"default\":3},\"timeout\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s\",\"default\":\"5s\"},\"interval\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s\",\"default\":\"30s\"},\"initial_delay\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Delays the check from running for the specified amount of time\",\"default\":\"0s\"},\"path\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).\"},\"command\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}],\"description\":\"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).\"},\"port\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).\"}},\"type\":\"object\",\"allOf\":[{\"oneOf\":[{\"type\":\"object\",\"required\":[\"command\"]},{\"type\":\"object\",\"required\":[\"path\",\"port\"]}]},{\"not\":{\"type\":\"object\",\"required\":[\"command\",\"port\"]}},{\"not\":{\"type\":\"object\",\"required\":[\"command\",\"path\"]}}],\"description\":\"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#livenessprobespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"success_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a health check before the container is considered healthy.\",\"default\":1},\"failure_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a failed health check before the container is considered unhealthy.\",\"default\":3},\"timeout\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s\",\"default\":\"5s\"},\"interval\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s\",\"default\":\"30s\"},\"initial_delay\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Delays the check from running for the specified amount of time\",\"default\":\"0s\"},\"path\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).\"},\"command\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}],\"description\":\"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).\"},\"port\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).\"}},\"type\":\"object\",\"allOf\":[{\"oneOf\":[{\"type\":\"object\",\"required\":[\"command\"]},{\"type\":\"object\",\"required\":[\"path\",\"port\"]}]},{\"not\":{\"type\":\"object\",\"required\":[\"command\",\"port\"]}},{\"not\":{\"type\":\"object\",\"required\":[\"command\",\"path\"]}}],\"description\":\"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#livenessprobespec\"},\"patternProperties\":{}}]}}},\"VolumeSpec\":{\"properties\":{\"mount_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Directory at which the volume will be mounted inside the container.\"},\"host_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).\"},\"key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#volumes\"}},\"description\":{\"type\":\"string\",\"description\":\"Human-readable description of volume\"},\"readonly\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the volume as readonly.\",\"default\":false}},\"type\":\"object\",\"not\":{\"type\":\"object\",\"required\":[\"host_path\",\"key\"]},\"errorMessage\":{\"not\":\"Only one of host_path, key is allowed, or none should exist\"},\"description\":\"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#volumespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"mount_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Directory at which the volume will be mounted inside the container.\"},\"host_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).\"},\"key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#volumes\"}},\"description\":{\"type\":\"string\",\"description\":\"Human-readable description of volume\"},\"readonly\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the volume as readonly.\",\"default\":false}},\"type\":\"object\",\"not\":{\"type\":\"object\",\"required\":[\"host_path\",\"key\"]},\"errorMessage\":{\"not\":\"Only one of host_path, key is allowed, or none should exist\"},\"description\":\"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#volumespec\"},\"patternProperties\":{}}]}}},\"BuildSpec\":{\"properties\":{\"context\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the directory containing the source code relative to the `architect.yml` file.\"},\"buildpack\":{\"type\":\"boolean\",\"description\":\"Option to use buildpack to build an image.\"},\"args\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false},\"dockerfile\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the Dockerfile relative to the `build.context`\",\"default\":\"Dockerfile\"},\"target\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The stage to build in the Dockerfile\"}},\"type\":\"object\",\"description\":\"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.\",\"not\":{\"type\":\"object\",\"required\":[\"buildpack\",\"dockerfile\"]},\"errorMessage\":{\"not\":\"Only one of buildpack, dockerfile is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#buildspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"context\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the directory containing the source code relative to the `architect.yml` file.\"},\"buildpack\":{\"type\":\"boolean\",\"description\":\"Option to use buildpack to build an image.\"},\"args\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false},\"dockerfile\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the Dockerfile relative to the `build.context`\",\"default\":\"Dockerfile\"},\"target\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The stage to build in the Dockerfile\"}},\"type\":\"object\",\"description\":\"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.\",\"not\":{\"type\":\"object\",\"required\":[\"buildpack\",\"dockerfile\"]},\"errorMessage\":{\"not\":\"Only one of buildpack, dockerfile is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#buildspec\"},\"patternProperties\":{}}]}}},\"IngressTlsSpec\":{\"properties\":{\"crt\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate.\"},\"key\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate key.\"},\"ca\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate ca.\"}},\"type\":\"object\",\"required\":[\"crt\",\"key\"],\"description\":\"Configuration for custom certificate.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingresstlsspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"crt\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate.\"},\"key\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate key.\"},\"ca\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate ca.\"}},\"type\":\"object\",\"required\":[\"crt\",\"key\"],\"description\":\"Configuration for custom certificate.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingresstlsspec\"},\"patternProperties\":{}}]}}},\"IngressSpec\":{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Marks the interface as an ingress.\"},\"subdomain\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^([A-Za-z0-9](?:[A-Za-z0-9\\\\-]{0,61}[A-Za-z0-9])|[^\\\\W\\\\D\\\\s\\\\t\\\\n\\\\r\\\\/]+|[\\\\@\\\\*]?)$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.\",\"errorMessage\":\"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between.\"},\"tls\":{\"$ref\":\"#/definitions/IngressTlsSpec\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface used for path based routing\"},\"ip_whitelist\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cidrv4\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*secrets\\\\.[\\\\w-]+\\\\s*}}\"}]}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}|(?:\\\\d{1,3}\\\\.){3}\\\\d{1,3}(?:\\\\/\\\\d\\\\d?)?,?\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24\"}}],\"description\":\"IP addresses that are allowed to access the interface\"},\"private\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the ingress as private behind Architect authentication\"}},\"type\":\"object\",\"description\":\"An ingress exposes an interface to external network traffic through an architect-deployed gateway.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingressspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Marks the interface as an ingress.\"},\"subdomain\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^([A-Za-z0-9](?:[A-Za-z0-9\\\\-]{0,61}[A-Za-z0-9])|[^\\\\W\\\\D\\\\s\\\\t\\\\n\\\\r\\\\/]+|[\\\\@\\\\*]?)$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.\",\"errorMessage\":\"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between.\"},\"tls\":{\"$ref\":\"#/definitions/IngressTlsSpec\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface used for path based routing\"},\"ip_whitelist\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cidrv4\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*secrets\\\\.[\\\\w-]+\\\\s*}}\"}]}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}|(?:\\\\d{1,3}\\\\.){3}\\\\d{1,3}(?:\\\\/\\\\d\\\\d?)?,?\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24\"}}],\"description\":\"IP addresses that are allowed to access the interface\"},\"private\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the ingress as private behind Architect authentication\"}},\"type\":\"object\",\"description\":\"An ingress exposes an interface to external network traffic through an architect-deployed gateway.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingressspec\"},\"patternProperties\":{}}]}}},\"ScalingMetricsSpec\":{\"properties\":{\"cpu\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}}},\"type\":\"object\",\"anyOf\":[{\"type\":\"object\",\"required\":[\"cpu\"]},{\"type\":\"object\",\"required\":[\"memory\"]}],\"description\":\"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingmetricsspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"cpu\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}}},\"type\":\"object\",\"anyOf\":[{\"type\":\"object\",\"required\":[\"cpu\"]},{\"type\":\"object\",\"required\":[\"memory\"]}],\"description\":\"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingmetricsspec\"},\"patternProperties\":{}}]}}},\"ScalingSpec\":{\"properties\":{\"min_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target minimum number of service replicas.\"},\"max_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target maximum number of service replicas.\"},\"metrics\":{\"$ref\":\"#/definitions/ScalingMetricsSpec\"}},\"type\":\"object\",\"required\":[\"min_replicas\",\"max_replicas\",\"metrics\"],\"description\":\"Configuration that dictates the scaling behavior of a service.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"min_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target minimum number of service replicas.\"},\"max_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target maximum number of service replicas.\"},\"metrics\":{\"$ref\":\"#/definitions/ScalingMetricsSpec\"}},\"type\":\"object\",\"required\":[\"min_replicas\",\"max_replicas\",\"metrics\"],\"description\":\"Configuration that dictates the scaling behavior of a service.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingspec\"},\"patternProperties\":{}}]}}},\"KubernetesDeploySpec\":{\"properties\":{\"deployment\":{}},\"type\":\"object\",\"required\":[\"deployment\"],\"description\":\"Configuration that dictates the kubernetes deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"deployment\":{}},\"type\":\"object\",\"required\":[\"deployment\"],\"description\":\"Configuration that dictates the kubernetes deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec\"},\"patternProperties\":{}}]}}},\"DeploySpec\":{\"properties\":{\"kubernetes\":{\"$ref\":\"#/definitions/KubernetesDeploySpec\"}},\"type\":\"object\",\"required\":[\"kubernetes\"],\"description\":\"Configuration that dictates the deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#deployspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"kubernetes\":{\"$ref\":\"#/definitions/KubernetesDeploySpec\"}},\"type\":\"object\",\"required\":[\"kubernetes\"],\"description\":\"Configuration that dictates the deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#deployspec\"},\"patternProperties\":{}}]}}},\"ServiceInterfaceSpec\":{\"properties\":{\"description\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A human-readable description of the interface.\"},\"host\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Port on which the service is listening for traffic.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Protocol that the interface responds to\",\"default\":\"http\"},\"username\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth username required to access the interface\"},\"password\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth password required to access the interface\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.\"},\"sticky\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"boolean\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Denotes that if this interface is made external, the gateway should use sticky sessions\",\"default\":false},\"ingress\":{\"$ref\":\"#/definitions/IngressSpec\"}},\"type\":\"object\",\"required\":[\"port\"],\"oneOf\":[{\"type\":\"object\",\"required\":[\"port\"]},{\"type\":\"object\",\"required\":[\"url\"]}],\"description\":\"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#serviceinterfacespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"description\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A human-readable description of the interface.\"},\"host\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Port on which the service is listening for traffic.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Protocol that the interface responds to\",\"default\":\"http\"},\"username\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth username required to access the interface\"},\"password\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth password required to access the interface\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.\"},\"sticky\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"boolean\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Denotes that if this interface is made external, the gateway should use sticky sessions\",\"default\":false},\"ingress\":{\"$ref\":\"#/definitions/IngressSpec\"}},\"type\":\"object\",\"required\":[\"port\"],\"oneOf\":[{\"type\":\"object\",\"required\":[\"port\"]},{\"type\":\"object\",\"required\":[\"url\"]}],\"description\":\"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#serviceinterfacespec\"},\"patternProperties\":{}}]}}},\"ServiceSpec\":{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Determines if the service should be running.\",\"default\":true},\"debug\":{\"$ref\":\"#/definitions/_DebugServiceSpec\"},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false},\"liveness_probe\":{\"$ref\":\"#/definitions/LivenessProbeSpec\"},\"volumes\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeSpec\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeSpec\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false},\"replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.\"},\"scaling\":{\"$ref\":\"#/definitions/ScalingSpec\"},\"deploy\":{\"$ref\":\"#/definitions/DeploySpec\"},\"termination_grace_period\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"default\":\"30s\",\"description\":\"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/BuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#servicespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Determines if the service should be running.\",\"default\":true},\"debug\":{\"$ref\":\"#/definitions/_DebugServiceSpec\"},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false},\"liveness_probe\":{\"$ref\":\"#/definitions/LivenessProbeSpec\"},\"volumes\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeSpec\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/VolumeSpec\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false},\"replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.\"},\"scaling\":{\"$ref\":\"#/definitions/ScalingSpec\"},\"deploy\":{\"$ref\":\"#/definitions/DeploySpec\"},\"termination_grace_period\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"default\":\"30s\",\"description\":\"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/BuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#servicespec\"},\"patternProperties\":{}}]}}},\"TaskSpec\":{\"properties\":{\"debug\":{\"$ref\":\"#/definitions/_DebugTaskSpec\"},\"schedule\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cron\",\"errorMessage\":{\"format\":\"must be a valid cron expression\"}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/BuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#taskspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"debug\":{\"$ref\":\"#/definitions/_DebugTaskSpec\"},\"schedule\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cron\",\"errorMessage\":{\"format\":\"must be a valid cron expression\"}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/BuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#taskspec\"},\"patternProperties\":{}}]}}},\"DependencySpec\":{\"properties\":{\"tag\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\",\"deprecated\":true},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"type\":\"object\",\"description\":\"An empty object that optionally supports specifying a tag for backwards compatibility.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#dependencyspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"tag\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\",\"deprecated\":true},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"type\":\"object\",\"description\":\"An empty object that optionally supports specifying a tag for backwards compatibility.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#dependencyspec\"},\"patternProperties\":{}}]}}},\"ComponentInterfaceSpec\":{\"properties\":{\"ingress\":{\"$ref\":\"#/definitions/IngressSpec\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.\"},\"host\":{\"type\":\"string\",\"description\":\"The host that the component interface should forward to.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The port that the component interface should forward to.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The protocol by which the component interface can be connected to.\"},\"username\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth username by which a component interface can be connected to.\"},\"password\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth password by which a component interface can be connected to.\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url that the component interface should forward to.\"},\"sticky\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.\"}},\"type\":\"object\",\"required\":[\"url\"],\"description\":\"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentinterfacespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"ingress\":{\"$ref\":\"#/definitions/IngressSpec\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.\"},\"host\":{\"type\":\"string\",\"description\":\"The host that the component interface should forward to.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The port that the component interface should forward to.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The protocol by which the component interface can be connected to.\"},\"username\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth username by which a component interface can be connected to.\"},\"password\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth password by which a component interface can be connected to.\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url that the component interface should forward to.\"},\"sticky\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.\"}},\"type\":\"object\",\"required\":[\"url\"],\"description\":\"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentinterfacespec\"},\"patternProperties\":{}}]}}},\"OutputDefinitionSpec\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the output field.\"},\"value\":{\"description\":\"Value of the output to be passed to upstream consumers\"}},\"type\":\"object\",\"required\":[\"value\"],\"description\":\"Components can define output fields that can be used to share configuration with consuming components.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#outputdefinitionspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the output field.\"},\"value\":{\"description\":\"Value of the output to be passed to upstream consumers\"}},\"type\":\"object\",\"required\":[\"value\"],\"description\":\"Components can define output fields that can be used to share configuration with consuming components.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#outputdefinitionspec\"},\"patternProperties\":{}}]}}},\"ComponentSpec\":{\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.\"},\"keywords\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"Additional search terms to be used when the component is indexed so that others can find it more easily.\"},\"author\":{\"type\":\"string\",\"description\":\"The name or handle of the author of the component as a developer contact.\"},\"homepage\":{\"type\":\"string\",\"description\":\"The url that serves as the informational homepage of the component (i.e. a github repo).\"},\"secrets\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/SecretDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec\",\"additionalProperties\":false},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false},\"databases\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false},\"services\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false},\"tasks\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false},\"dependencies\":{\"type\":\"object\",\"patternProperties\":{\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}},{\"$ref\":\"#/definitions/DependencySpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)\",\"additionalProperties\":false},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false},\"artifact_image\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"-\"}},\"type\":\"object\",\"required\":[\"name\"],\"description\":\"The top level object of the `architect.yml`; defines a deployable Architect Component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.\"},\"keywords\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"Additional search terms to be used when the component is indexed so that others can find it more easily.\"},\"author\":{\"type\":\"string\",\"description\":\"The name or handle of the author of the component as a developer contact.\"},\"homepage\":{\"type\":\"string\",\"description\":\"The url that serves as the informational homepage of the component (i.e. a github repo).\"},\"secrets\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/SecretDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec\",\"additionalProperties\":false},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/OutputDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false},\"databases\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/DatabaseSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false},\"services\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/ServiceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false},\"tasks\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/TaskSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false},\"dependencies\":{\"type\":\"object\",\"patternProperties\":{\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}},{\"$ref\":\"#/definitions/DependencySpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)\",\"additionalProperties\":false},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/ComponentInterfaceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false},\"artifact_image\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"-\"}},\"type\":\"object\",\"required\":[\"name\"],\"description\":\"The top level object of the `architect.yml`; defines a deployable Architect Component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentspec\"},\"patternProperties\":{}}]}}},\"_DebugDatabaseSpec\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"type\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\",\"enum\":[\"postgres:10\",\"postgres:11\",\"postgres:12\",\"postgres:13\",\"postgres:14\",\"postgres:15\",\"mysql:5\",\"mysql:6\",\"mysql:7\",\"mysql:8\",\"mariadb:10\"]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The type engine and version of database software needed for data storage.\",\"errorMessage\":\"must be of the format <engine>:<version> (e.g. postgres:13)\"},\"connection_string\":{\"anyOf\":[{\"format\":\"uri\",\"type\":\"string\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The connection uri of an existing database to use instead of provisioning a new one\"}},\"type\":\"object\",\"description\":\"Component databases let you quickly spin up a database for your service\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#databasespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"type\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\",\"enum\":[\"postgres:10\",\"postgres:11\",\"postgres:12\",\"postgres:13\",\"postgres:14\",\"postgres:15\",\"mysql:5\",\"mysql:6\",\"mysql:7\",\"mysql:8\",\"mariadb:10\"]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The type engine and version of database software needed for data storage.\",\"errorMessage\":\"must be of the format <engine>:<version> (e.g. postgres:13)\"},\"connection_string\":{\"anyOf\":[{\"format\":\"uri\",\"type\":\"string\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The connection uri of an existing database to use instead of provisioning a new one\"}},\"type\":\"object\",\"description\":\"Component databases let you quickly spin up a database for your service\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#databasespec\"},\"patternProperties\":{}}]}}},\"_DebugSecretDefinitionSpec\":{\"properties\":{\"required\":{\"type\":\"boolean\",\"description\":\"Denotes whether the secret is required.\"},\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the secret.\"},\"default\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"object\"},{\"type\":\"string\"},{\"type\":\"null\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Sets a default value for the secret if one is not provided\"}},\"type\":\"object\",\"description\":\"Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#secretdefinitionspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"required\":{\"type\":\"boolean\",\"description\":\"Denotes whether the secret is required.\"},\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the secret.\"},\"default\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"object\"},{\"type\":\"string\"},{\"type\":\"null\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Sets a default value for the secret if one is not provided\"}},\"type\":\"object\",\"description\":\"Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#secretdefinitionspec\"},\"patternProperties\":{}}]}}},\"_DebugLivenessProbeSpec\":{\"properties\":{\"success_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a health check before the container is considered healthy.\",\"default\":1},\"failure_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a failed health check before the container is considered unhealthy.\",\"default\":3},\"timeout\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s\",\"default\":\"5s\"},\"interval\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s\",\"default\":\"30s\"},\"initial_delay\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Delays the check from running for the specified amount of time\",\"default\":\"0s\"},\"path\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).\"},\"command\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}],\"description\":\"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).\"},\"port\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).\"}},\"type\":\"object\",\"description\":\"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#livenessprobespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"success_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a health check before the container is considered healthy.\",\"default\":1},\"failure_threshold\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The number of times to retry a failed health check before the container is considered unhealthy.\",\"default\":3},\"timeout\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s\",\"default\":\"5s\"},\"interval\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s\",\"default\":\"30s\"},\"initial_delay\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Delays the check from running for the specified amount of time\",\"default\":\"0s\"},\"path\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set).\"},\"command\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}],\"description\":\"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set).\"},\"port\":{\"deprecated\":true,\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set).\"}},\"type\":\"object\",\"description\":\"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#livenessprobespec\"},\"patternProperties\":{}}]}}},\"_DebugVolumeSpec\":{\"properties\":{\"mount_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Directory at which the volume will be mounted inside the container.\"},\"host_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).\"},\"key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#volumes\"}},\"description\":{\"type\":\"string\",\"description\":\"Human-readable description of volume\"},\"readonly\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the volume as readonly.\",\"default\":false}},\"type\":\"object\",\"not\":{\"type\":\"object\",\"required\":[\"host_path\",\"key\"]},\"errorMessage\":{\"not\":\"Only one of host_path, key is allowed, or none should exist\"},\"description\":\"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#volumespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"mount_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Directory at which the volume will be mounted inside the container.\"},\"host_path\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set).\"},\"key\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#volumes\"}},\"description\":{\"type\":\"string\",\"description\":\"Human-readable description of volume\"},\"readonly\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the volume as readonly.\",\"default\":false}},\"type\":\"object\",\"not\":{\"type\":\"object\",\"required\":[\"host_path\",\"key\"]},\"errorMessage\":{\"not\":\"Only one of host_path, key is allowed, or none should exist\"},\"description\":\"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#volumespec\"},\"patternProperties\":{}}]}}},\"_DebugBuildSpec\":{\"properties\":{\"context\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the directory containing the source code relative to the `architect.yml` file.\"},\"buildpack\":{\"type\":\"boolean\",\"description\":\"Option to use buildpack to build an image.\"},\"args\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false},\"dockerfile\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the Dockerfile relative to the `build.context`\",\"default\":\"Dockerfile\"},\"target\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The stage to build in the Dockerfile\"}},\"type\":\"object\",\"description\":\"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.\",\"not\":{\"type\":\"object\",\"required\":[\"buildpack\",\"dockerfile\"]},\"errorMessage\":{\"not\":\"Only one of buildpack, dockerfile is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#buildspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"context\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the directory containing the source code relative to the `architect.yml` file.\"},\"buildpack\":{\"type\":\"boolean\",\"description\":\"Option to use buildpack to build an image.\"},\"args\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"Build args to be passed into `docker build`.\",\"additionalProperties\":false},\"dockerfile\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path to the Dockerfile relative to the `build.context`\",\"default\":\"Dockerfile\"},\"target\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The stage to build in the Dockerfile\"}},\"type\":\"object\",\"description\":\"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.\",\"not\":{\"type\":\"object\",\"required\":[\"buildpack\",\"dockerfile\"]},\"errorMessage\":{\"not\":\"Only one of buildpack, dockerfile is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#buildspec\"},\"patternProperties\":{}}]}}},\"_DebugIngressTlsSpec\":{\"properties\":{\"crt\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate.\"},\"key\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate key.\"},\"ca\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate ca.\"}},\"type\":\"object\",\"description\":\"Configuration for custom certificate.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingresstlsspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"crt\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate.\"},\"key\":{\"type\":\"string\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate key.\"},\"ca\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Custom certificate ca.\"}},\"type\":\"object\",\"description\":\"Configuration for custom certificate.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingresstlsspec\"},\"patternProperties\":{}}]}}},\"_DebugIngressSpec\":{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Marks the interface as an ingress.\"},\"subdomain\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^([A-Za-z0-9](?:[A-Za-z0-9\\\\-]{0,61}[A-Za-z0-9])|[^\\\\W\\\\D\\\\s\\\\t\\\\n\\\\r\\\\/]+|[\\\\@\\\\*]?)$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.\",\"errorMessage\":\"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between.\"},\"tls\":{\"$ref\":\"#/definitions/_DebugIngressTlsSpec\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface used for path based routing\"},\"ip_whitelist\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cidrv4\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*secrets\\\\.[\\\\w-]+\\\\s*}}\"}]}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}|(?:\\\\d{1,3}\\\\.){3}\\\\d{1,3}(?:\\\\/\\\\d\\\\d?)?,?\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24\"}}],\"description\":\"IP addresses that are allowed to access the interface\"},\"private\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the ingress as private behind Architect authentication\"}},\"type\":\"object\",\"description\":\"An ingress exposes an interface to external network traffic through an architect-deployed gateway.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingressspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Marks the interface as an ingress.\"},\"subdomain\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^([A-Za-z0-9](?:[A-Za-z0-9\\\\-]{0,61}[A-Za-z0-9])|[^\\\\W\\\\D\\\\s\\\\t\\\\n\\\\r\\\\/]+|[\\\\@\\\\*]?)$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.\",\"errorMessage\":\"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between.\"},\"tls\":{\"$ref\":\"#/definitions/_DebugIngressTlsSpec\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface used for path based routing\"},\"ip_whitelist\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cidrv4\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*secrets\\\\.[\\\\w-]+\\\\s*}}\"}]}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}|(?:\\\\d{1,3}\\\\.){3}\\\\d{1,3}(?:\\\\/\\\\d\\\\d?)?,?\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24\"}}],\"description\":\"IP addresses that are allowed to access the interface\"},\"private\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Marks the ingress as private behind Architect authentication\"}},\"type\":\"object\",\"description\":\"An ingress exposes an interface to external network traffic through an architect-deployed gateway.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#ingressspec\"},\"patternProperties\":{}}]}}},\"_DebugScalingMetricsSpec\":{\"properties\":{\"cpu\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}}},\"type\":\"object\",\"description\":\"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingmetricsspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"cpu\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0,\"maximum\":100},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory usage required to trigger scaling.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}}},\"type\":\"object\",\"description\":\"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingmetricsspec\"},\"patternProperties\":{}}]}}},\"_DebugScalingSpec\":{\"properties\":{\"min_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target minimum number of service replicas.\"},\"max_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target maximum number of service replicas.\"},\"metrics\":{\"$ref\":\"#/definitions/_DebugScalingMetricsSpec\"}},\"type\":\"object\",\"description\":\"Configuration that dictates the scaling behavior of a service.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"min_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target minimum number of service replicas.\"},\"max_replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The target maximum number of service replicas.\"},\"metrics\":{\"$ref\":\"#/definitions/_DebugScalingMetricsSpec\"}},\"type\":\"object\",\"description\":\"Configuration that dictates the scaling behavior of a service.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#scalingspec\"},\"patternProperties\":{}}]}}},\"_DebugKubernetesDeploySpec\":{\"properties\":{\"deployment\":{}},\"type\":\"object\",\"description\":\"Configuration that dictates the kubernetes deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"deployment\":{}},\"type\":\"object\",\"description\":\"Configuration that dictates the kubernetes deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec\"},\"patternProperties\":{}}]}}},\"_DebugDeploySpec\":{\"properties\":{\"kubernetes\":{\"$ref\":\"#/definitions/_DebugKubernetesDeploySpec\"}},\"type\":\"object\",\"description\":\"Configuration that dictates the deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#deployspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"kubernetes\":{\"$ref\":\"#/definitions/_DebugKubernetesDeploySpec\"}},\"type\":\"object\",\"description\":\"Configuration that dictates the deploy overrides.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#deployspec\"},\"patternProperties\":{}}]}}},\"_DebugServiceInterfaceSpec\":{\"properties\":{\"description\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A human-readable description of the interface.\"},\"host\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Port on which the service is listening for traffic.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Protocol that the interface responds to\",\"default\":\"http\"},\"username\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth username required to access the interface\"},\"password\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth password required to access the interface\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.\"},\"sticky\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"boolean\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Denotes that if this interface is made external, the gateway should use sticky sessions\",\"default\":false},\"ingress\":{\"$ref\":\"#/definitions/_DebugIngressSpec\"}},\"type\":\"object\",\"description\":\"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#serviceinterfacespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"description\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A human-readable description of the interface.\"},\"host\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Port on which the service is listening for traffic.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Protocol that the interface responds to\",\"default\":\"http\"},\"username\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth username required to access the interface\"},\"password\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"null\"},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A Basic Auth password required to access the interface\"},\"path\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^\\\\/.*$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The path of the interface\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url.\"},\"sticky\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"boolean\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"Denotes that if this interface is made external, the gateway should use sticky sessions\",\"default\":false},\"ingress\":{\"$ref\":\"#/definitions/_DebugIngressSpec\"}},\"type\":\"object\",\"description\":\"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#serviceinterfacespec\"},\"patternProperties\":{}}]}}},\"_DebugServiceSpec\":{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Determines if the service should be running.\",\"default\":true},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false},\"liveness_probe\":{\"$ref\":\"#/definitions/_DebugLivenessProbeSpec\"},\"volumes\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugVolumeSpec\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugVolumeSpec\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false},\"replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.\"},\"scaling\":{\"$ref\":\"#/definitions/_DebugScalingSpec\"},\"deploy\":{\"$ref\":\"#/definitions/_DebugDeploySpec\"},\"termination_grace_period\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"default\":\"30s\",\"description\":\"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/_DebugBuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#servicespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"enabled\":{\"type\":\"boolean\",\"description\":\"Determines if the service should be running.\",\"default\":true},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceInterfaceSpec\"},{\"type\":\"number\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.\",\"additionalProperties\":false},\"liveness_probe\":{\"$ref\":\"#/definitions/_DebugLivenessProbeSpec\"},\"volumes\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugVolumeSpec\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugVolumeSpec\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.\",\"additionalProperties\":false},\"replicas\":{\"anyOf\":[{\"type\":\"integer\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field.\"},\"scaling\":{\"$ref\":\"#/definitions/_DebugScalingSpec\"},\"deploy\":{\"$ref\":\"#/definitions/_DebugDeploySpec\"},\"termination_grace_period\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"default\":\"30s\",\"description\":\"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/_DebugBuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#servicespec\"},\"patternProperties\":{}}]}}},\"_DebugTaskSpec\":{\"properties\":{\"schedule\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cron\",\"errorMessage\":{\"format\":\"must be a valid cron expression\"}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/_DebugBuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#taskspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"schedule\":{\"anyOf\":[{\"type\":\"string\",\"format\":\"cron\",\"errorMessage\":{\"format\":\"must be a valid cron expression\"}},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI.\"},\"description\":{\"type\":\"string\",\"description\":\"Human readable description\"},\"image\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)\"},\"command\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command.\"},\"entrypoint\":{\"anyOf\":[{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\"}]},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint.\"},\"language\":{\"type\":\"string\",\"description\":\"The dominant programming language used; this is for informational purposes only.\"},\"environment\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_]+$\":{\"anyOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"null\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of key-value pairs or secret definitions that describes environment variables and their values.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#local-configuration\"},\"additionalProperties\":false},\"build\":{\"$ref\":\"#/definitions/_DebugBuildSpec\"},\"cpu\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The cpu required to run a service or a task\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"memory\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The memory required to run a service or a task.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#cpu--memory\"}},\"depends_on\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks.\"},\"labels\":{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false}]}},\"description\":\"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.\",\"externalDocs\":{\"url\":\"https://docs.architect.io/components/services/#labels\"},\"additionalProperties\":false},\"reserved_name\":{\"type\":\"string\",\"pattern\":\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"A specific service name which will override the service name specified in the component.\"}},\"type\":\"object\",\"description\":\"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"not\":{\"type\":\"object\",\"required\":[\"build\",\"image\"]},\"errorMessage\":{\"not\":\"Only one of build, image is allowed, or none should exist\"},\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#taskspec\"},\"patternProperties\":{}}]}}},\"_DebugDependencySpec\":{\"properties\":{\"tag\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\",\"deprecated\":true},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"type\":\"object\",\"description\":\"An empty object that optionally supports specifying a tag for backwards compatibility.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#dependencyspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"tag\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\",\"deprecated\":true},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}]}},\"type\":\"object\",\"description\":\"An empty object that optionally supports specifying a tag for backwards compatibility.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#dependencyspec\"},\"patternProperties\":{}}]}}},\"_DebugComponentInterfaceSpec\":{\"properties\":{\"ingress\":{\"$ref\":\"#/definitions/_DebugIngressSpec\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.\"},\"host\":{\"type\":\"string\",\"description\":\"The host that the component interface should forward to.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The port that the component interface should forward to.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The protocol by which the component interface can be connected to.\"},\"username\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth username by which a component interface can be connected to.\"},\"password\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth password by which a component interface can be connected to.\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url that the component interface should forward to.\"},\"sticky\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.\"}},\"type\":\"object\",\"description\":\"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentinterfacespec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"ingress\":{\"$ref\":\"#/definitions/_DebugIngressSpec\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for.\"},\"host\":{\"type\":\"string\",\"description\":\"The host that the component interface should forward to.\"},\"port\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The port that the component interface should forward to.\"},\"protocol\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The protocol by which the component interface can be connected to.\"},\"username\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth username by which a component interface can be connected to.\"},\"password\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The Basic Auth password by which a component interface can be connected to.\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"The url that the component interface should forward to.\"},\"sticky\":{\"anyOf\":[{\"type\":\"boolean\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}}],\"description\":\"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running.\"}},\"type\":\"object\",\"description\":\"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentinterfacespec\"},\"patternProperties\":{}}]}}},\"_DebugOutputDefinitionSpec\":{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the output field.\"},\"value\":{\"description\":\"Value of the output to be passed to upstream consumers\"}},\"type\":\"object\",\"description\":\"Components can define output fields that can be used to share configuration with consuming components.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#outputdefinitionspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"description\":{\"type\":\"string\",\"description\":\"A human-friendly description of the output field.\"},\"value\":{\"description\":\"Value of the output to be passed to upstream consumers\"}},\"type\":\"object\",\"description\":\"Components can define output fields that can be used to share configuration with consuming components.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#outputdefinitionspec\"},\"patternProperties\":{}}]}}},\"_DebugComponentSpec\":{\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.\"},\"keywords\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"Additional search terms to be used when the component is indexed so that others can find it more easily.\"},\"author\":{\"type\":\"string\",\"description\":\"The name or handle of the author of the component as a developer contact.\"},\"homepage\":{\"type\":\"string\",\"description\":\"The url that serves as the informational homepage of the component (i.e. a github repo).\"},\"secrets\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/_DebugSecretDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec\",\"additionalProperties\":false},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/_DebugOutputDefinitionSpec\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/_DebugOutputDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false},\"databases\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugDatabaseSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugDatabaseSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false},\"services\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false},\"tasks\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugTaskSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugTaskSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false},\"dependencies\":{\"type\":\"object\",\"patternProperties\":{\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}},{\"$ref\":\"#/definitions/_DebugDependencySpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)\",\"additionalProperties\":false},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/_DebugComponentInterfaceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/_DebugComponentInterfaceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false},\"artifact_image\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"-\"}},\"type\":\"object\",\"description\":\"The top level object of the `architect.yml`; defines a deployable Architect Component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentspec\"},\"patternProperties\":{\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"properties\":{\"name\":{\"type\":\"string\",\"pattern\":\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\",\"errorMessage\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\",\"description\":\"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":{\"type\":\"string\",\"description\":\"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for.\"},\"keywords\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"}]},\"description\":\"Additional search terms to be used when the component is indexed so that others can find it more easily.\"},\"author\":{\"type\":\"string\",\"description\":\"The name or handle of the author of the component as a developer contact.\"},\"homepage\":{\"type\":\"string\",\"description\":\"The url that serves as the informational homepage of the component (i.e. a github repo).\"},\"secrets\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/_DebugSecretDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec\",\"additionalProperties\":false},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/_DebugOutputDefinitionSpec\"},{\"type\":\"null\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/_DebugOutputDefinitionSpec\"},{\"type\":\"null\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between.\"},\"description\":\"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.\",\"additionalProperties\":false},\"databases\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugDatabaseSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugDatabaseSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A database represents a stateful service powered by one of several supported database engines.\",\"additionalProperties\":false},\"services\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugServiceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.\",\"additionalProperties\":false},\"tasks\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugTaskSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"$ref\":\"#/definitions/_DebugTaskSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.\",\"additionalProperties\":false},\"dependencies\":{\"type\":\"object\",\"patternProperties\":{\"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\\\w][\\\\w\\\\.-]{0,127}))?$\":{\"anyOf\":[{\"type\":\"string\",\"pattern\":\"^[\\\\w][\\\\w\\\\.-]{0,127}$\"},{\"type\":\"string\",\"pattern\":\"\\\\${{\\\\s*(.*?)\\\\s*}}\",\"errorMessage\":{\"pattern\":\"must be an interpolation ref ex. $__arc__{{ secrets.example }}\"}},{\"$ref\":\"#/definitions/_DebugDependencySpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)\",\"additionalProperties\":false},\"interfaces\":{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/_DebugComponentInterfaceSpec\"}]},\"^\\\\${{\\\\s*if(.*?)\\\\s*}}$\":{\"anyOf\":[{\"type\":\"object\",\"patternProperties\":{\"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$\":{\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/_DebugComponentInterfaceSpec\"}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false}]}},\"errorMessage\":{\"additionalProperties\":\"must contain only lower alphanumeric and single hyphens in the middle; max length 32\"},\"description\":\"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.\",\"deprecated\":true,\"additionalProperties\":false},\"artifact_image\":{\"type\":\"string\",\"deprecated\":true,\"description\":\"-\"}},\"type\":\"object\",\"description\":\"The top level object of the `architect.yml`; defines a deployable Architect Component.\",\"additionalProperties\":false,\"externalDocs\":{\"url\":\"https://docs.architect.io/reference/architect-yml#componentspec\"},\"patternProperties\":{}}]}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml\". Here are the required top‑level fields: name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$id":"https://raw.githubusercontent.com/architect-team/architect-cli/main/src/dependency-manager/schema/architect.schema.json","title":"Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml","$schema":"http://json-schema.org/draft-07/schema","properties":{"name":{"type":"string","pattern":"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for."},"keywords":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"Additional search terms to be used when the component is indexed so that others can find it more easily."},"author":{"type":"string","description":"The name or handle of the author of the component as a developer contact."},"homepage":{"type":"string","description":"The url that serves as the informational homepage of the component (i.e. a github repo)."},"secrets":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/SecretDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec","additionalProperties":false},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false},"databases":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false},"services":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false},"tasks":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false},"dependencies":{"type":"object","patternProperties":{"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}},{"$ref":"#/definitions/DependencySpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)","additionalProperties":false},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false},"artifact_image":{"type":"string","deprecated":true,"description":"-"}},"type":"object","required":["name"],"description":"The top level object of the `architect.yml`; defines a deployable Architect Component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"name":{"type":"string","pattern":"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for."},"keywords":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"Additional search terms to be used when the component is indexed so that others can find it more easily."},"author":{"type":"string","description":"The name or handle of the author of the component as a developer contact."},"homepage":{"type":"string","description":"The url that serves as the informational homepage of the component (i.e. a github repo)."},"secrets":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/SecretDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec","additionalProperties":false},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false},"databases":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false},"services":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false},"tasks":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false},"dependencies":{"type":"object","patternProperties":{"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}},{"$ref":"#/definitions/DependencySpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)","additionalProperties":false},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false},"artifact_image":{"type":"string","deprecated":true,"description":"-"}},"type":"object","required":["name"],"description":"The top level object of the `architect.yml`; defines a deployable Architect Component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentspec"},"patternProperties":{}}]}},"definitions":{"DatabaseSpec":{"properties":{"description":{"type":"string","description":"Human readable description"},"type":{"type":"string","anyOf":[{"type":"string","enum":["postgres:10","postgres:11","postgres:12","postgres:13","postgres:14","postgres:15","mysql:5","mysql:6","mysql:7","mysql:8","mariadb:10"]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The type engine and version of database software needed for data storage.","errorMessage":"must be of the format <engine>:<version> (e.g. postgres:13)"},"connection_string":{"anyOf":[{"format":"uri","type":"string"},{"type":"null"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The connection uri of an existing database to use instead of provisioning a new one"}},"type":"object","required":["type"],"description":"Component databases let you quickly spin up a database for your service","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#databasespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"description":{"type":"string","description":"Human readable description"},"type":{"type":"string","anyOf":[{"type":"string","enum":["postgres:10","postgres:11","postgres:12","postgres:13","postgres:14","postgres:15","mysql:5","mysql:6","mysql:7","mysql:8","mariadb:10"]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The type engine and version of database software needed for data storage.","errorMessage":"must be of the format <engine>:<version> (e.g. postgres:13)"},"connection_string":{"anyOf":[{"format":"uri","type":"string"},{"type":"null"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The connection uri of an existing database to use instead of provisioning a new one"}},"type":"object","required":["type"],"description":"Component databases let you quickly spin up a database for your service","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#databasespec"},"patternProperties":{}}]}}},"SecretDefinitionSpec":{"properties":{"required":{"type":"boolean","description":"Denotes whether the secret is required."},"description":{"type":"string","description":"A human-friendly description of the secret."},"default":{"anyOf":[{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"number"},{"type":"object"},{"type":"string"},{"type":"null"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Sets a default value for the secret if one is not provided"}},"type":"object","description":"Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#secretdefinitionspec"}},"LivenessProbeSpec":{"properties":{"success_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a health check before the container is considered healthy.","default":1},"failure_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a failed health check before the container is considered unhealthy.","default":3},"timeout":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s","default":"5s"},"interval":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s","default":"30s"},"initial_delay":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Delays the check from running for the specified amount of time","default":"0s"},"path":{"deprecated":true,"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)."},"command":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)."},"port":{"deprecated":true,"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)."}},"type":"object","allOf":[{"oneOf":[{"type":"object","required":["command"]},{"type":"object","required":["path","port"]}]},{"not":{"type":"object","required":["command","port"]}},{"not":{"type":"object","required":["command","path"]}}],"description":"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#livenessprobespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"success_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a health check before the container is considered healthy.","default":1},"failure_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a failed health check before the container is considered unhealthy.","default":3},"timeout":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s","default":"5s"},"interval":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s","default":"30s"},"initial_delay":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Delays the check from running for the specified amount of time","default":"0s"},"path":{"deprecated":true,"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)."},"command":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)."},"port":{"deprecated":true,"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)."}},"type":"object","allOf":[{"oneOf":[{"type":"object","required":["command"]},{"type":"object","required":["path","port"]}]},{"not":{"type":"object","required":["command","port"]}},{"not":{"type":"object","required":["command","path"]}}],"description":"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#livenessprobespec"},"patternProperties":{}}]}}},"VolumeSpec":{"properties":{"mount_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Directory at which the volume will be mounted inside the container."},"host_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)."},"key":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).","externalDocs":{"url":"https://docs.architect.io/components/services/#volumes"}},"description":{"type":"string","description":"Human-readable description of volume"},"readonly":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the volume as readonly.","default":false}},"type":"object","not":{"type":"object","required":["host_path","key"]},"errorMessage":{"not":"Only one of host_path, key is allowed, or none should exist"},"description":"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#volumespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"mount_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Directory at which the volume will be mounted inside the container."},"host_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)."},"key":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).","externalDocs":{"url":"https://docs.architect.io/components/services/#volumes"}},"description":{"type":"string","description":"Human-readable description of volume"},"readonly":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the volume as readonly.","default":false}},"type":"object","not":{"type":"object","required":["host_path","key"]},"errorMessage":{"not":"Only one of host_path, key is allowed, or none should exist"},"description":"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#volumespec"},"patternProperties":{}}]}}},"BuildSpec":{"properties":{"context":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the directory containing the source code relative to the `architect.yml` file."},"buildpack":{"type":"boolean","description":"Option to use buildpack to build an image."},"args":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false},"dockerfile":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the Dockerfile relative to the `build.context`","default":"Dockerfile"},"target":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The stage to build in the Dockerfile"}},"type":"object","description":"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.","not":{"type":"object","required":["buildpack","dockerfile"]},"errorMessage":{"not":"Only one of buildpack, dockerfile is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#buildspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"context":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the directory containing the source code relative to the `architect.yml` file."},"buildpack":{"type":"boolean","description":"Option to use buildpack to build an image."},"args":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false},"dockerfile":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the Dockerfile relative to the `build.context`","default":"Dockerfile"},"target":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The stage to build in the Dockerfile"}},"type":"object","description":"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.","not":{"type":"object","required":["buildpack","dockerfile"]},"errorMessage":{"not":"Only one of buildpack, dockerfile is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#buildspec"},"patternProperties":{}}]}}},"IngressTlsSpec":{"properties":{"crt":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate."},"key":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate key."},"ca":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate ca."}},"type":"object","required":["crt","key"],"description":"Configuration for custom certificate.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingresstlsspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"crt":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate."},"key":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate key."},"ca":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate ca."}},"type":"object","required":["crt","key"],"description":"Configuration for custom certificate.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingresstlsspec"},"patternProperties":{}}]}}},"IngressSpec":{"properties":{"enabled":{"type":"boolean","description":"Marks the interface as an ingress."},"subdomain":{"anyOf":[{"type":"string","pattern":"^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.","errorMessage":"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between."},"tls":{"$ref":"#/definitions/IngressTlsSpec"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface used for path based routing"},"ip_whitelist":{"anyOf":[{"type":"array","items":{"anyOf":[{"type":"string","format":"cidrv4"},{"type":"string","pattern":"\\${{\\s*secrets\\.[\\w-]+\\s*}}"}]}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24"}}],"description":"IP addresses that are allowed to access the interface"},"private":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the ingress as private behind Architect authentication"}},"type":"object","description":"An ingress exposes an interface to external network traffic through an architect-deployed gateway.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingressspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"enabled":{"type":"boolean","description":"Marks the interface as an ingress."},"subdomain":{"anyOf":[{"type":"string","pattern":"^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.","errorMessage":"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between."},"tls":{"$ref":"#/definitions/IngressTlsSpec"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface used for path based routing"},"ip_whitelist":{"anyOf":[{"type":"array","items":{"anyOf":[{"type":"string","format":"cidrv4"},{"type":"string","pattern":"\\${{\\s*secrets\\.[\\w-]+\\s*}}"}]}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24"}}],"description":"IP addresses that are allowed to access the interface"},"private":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the ingress as private behind Architect authentication"}},"type":"object","description":"An ingress exposes an interface to external network traffic through an architect-deployed gateway.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingressspec"},"patternProperties":{}}]}}},"ScalingMetricsSpec":{"properties":{"cpu":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}}},"type":"object","anyOf":[{"type":"object","required":["cpu"]},{"type":"object","required":["memory"]}],"description":"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingmetricsspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"cpu":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}}},"type":"object","anyOf":[{"type":"object","required":["cpu"]},{"type":"object","required":["memory"]}],"description":"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingmetricsspec"},"patternProperties":{}}]}}},"ScalingSpec":{"properties":{"min_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target minimum number of service replicas."},"max_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target maximum number of service replicas."},"metrics":{"$ref":"#/definitions/ScalingMetricsSpec"}},"type":"object","required":["min_replicas","max_replicas","metrics"],"description":"Configuration that dictates the scaling behavior of a service.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"min_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target minimum number of service replicas."},"max_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target maximum number of service replicas."},"metrics":{"$ref":"#/definitions/ScalingMetricsSpec"}},"type":"object","required":["min_replicas","max_replicas","metrics"],"description":"Configuration that dictates the scaling behavior of a service.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingspec"},"patternProperties":{}}]}}},"KubernetesDeploySpec":{"properties":{"deployment":{}},"type":"object","required":["deployment"],"description":"Configuration that dictates the kubernetes deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"deployment":{}},"type":"object","required":["deployment"],"description":"Configuration that dictates the kubernetes deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec"},"patternProperties":{}}]}}},"DeploySpec":{"properties":{"kubernetes":{"$ref":"#/definitions/KubernetesDeploySpec"}},"type":"object","required":["kubernetes"],"description":"Configuration that dictates the deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#deployspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"kubernetes":{"$ref":"#/definitions/KubernetesDeploySpec"}},"type":"object","required":["kubernetes"],"description":"Configuration that dictates the deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#deployspec"},"patternProperties":{}}]}}},"ServiceInterfaceSpec":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A human-readable description of the interface."},"host":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Port on which the service is listening for traffic."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Protocol that the interface responds to","default":"http"},"username":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth username required to access the interface"},"password":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth password required to access the interface"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface"},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url."},"sticky":{"anyOf":[{"anyOf":[{"type":"boolean"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Denotes that if this interface is made external, the gateway should use sticky sessions","default":false},"ingress":{"$ref":"#/definitions/IngressSpec"}},"type":"object","required":["port"],"oneOf":[{"type":"object","required":["port"]},{"type":"object","required":["url"]}],"description":"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#serviceinterfacespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A human-readable description of the interface."},"host":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Port on which the service is listening for traffic."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Protocol that the interface responds to","default":"http"},"username":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth username required to access the interface"},"password":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth password required to access the interface"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface"},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url."},"sticky":{"anyOf":[{"anyOf":[{"type":"boolean"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Denotes that if this interface is made external, the gateway should use sticky sessions","default":false},"ingress":{"$ref":"#/definitions/IngressSpec"}},"type":"object","required":["port"],"oneOf":[{"type":"object","required":["port"]},{"type":"object","required":["url"]}],"description":"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#serviceinterfacespec"},"patternProperties":{}}]}}},"ServiceSpec":{"properties":{"enabled":{"type":"boolean","description":"Determines if the service should be running.","default":true},"debug":{"$ref":"#/definitions/_DebugServiceSpec"},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/ServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/ServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false},"liveness_probe":{"$ref":"#/definitions/LivenessProbeSpec"},"volumes":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/VolumeSpec"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/VolumeSpec"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false},"replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field."},"scaling":{"$ref":"#/definitions/ScalingSpec"},"deploy":{"$ref":"#/definitions/DeploySpec"},"termination_grace_period":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"default":"30s","description":"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/BuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#servicespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"enabled":{"type":"boolean","description":"Determines if the service should be running.","default":true},"debug":{"$ref":"#/definitions/_DebugServiceSpec"},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/ServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/ServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false},"liveness_probe":{"$ref":"#/definitions/LivenessProbeSpec"},"volumes":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/VolumeSpec"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/VolumeSpec"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false},"replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field."},"scaling":{"$ref":"#/definitions/ScalingSpec"},"deploy":{"$ref":"#/definitions/DeploySpec"},"termination_grace_period":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"default":"30s","description":"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/BuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#servicespec"},"patternProperties":{}}]}}},"TaskSpec":{"properties":{"debug":{"$ref":"#/definitions/_DebugTaskSpec"},"schedule":{"anyOf":[{"type":"string","format":"cron","errorMessage":{"format":"must be a valid cron expression"}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/BuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#taskspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"debug":{"$ref":"#/definitions/_DebugTaskSpec"},"schedule":{"anyOf":[{"type":"string","format":"cron","errorMessage":{"format":"must be a valid cron expression"}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/BuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#taskspec"},"patternProperties":{}}]}}},"DependencySpec":{"properties":{"tag":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$","deprecated":true},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"type":"object","description":"An empty object that optionally supports specifying a tag for backwards compatibility.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#dependencyspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"tag":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$","deprecated":true},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"type":"object","description":"An empty object that optionally supports specifying a tag for backwards compatibility.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#dependencyspec"},"patternProperties":{}}]}}},"ComponentInterfaceSpec":{"properties":{"ingress":{"$ref":"#/definitions/IngressSpec"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for."},"host":{"type":"string","description":"The host that the component interface should forward to."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The port that the component interface should forward to."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The protocol by which the component interface can be connected to."},"username":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth username by which a component interface can be connected to."},"password":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth password by which a component interface can be connected to."},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url that the component interface should forward to."},"sticky":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running."}},"type":"object","required":["url"],"description":"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentinterfacespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"ingress":{"$ref":"#/definitions/IngressSpec"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for."},"host":{"type":"string","description":"The host that the component interface should forward to."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The port that the component interface should forward to."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The protocol by which the component interface can be connected to."},"username":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth username by which a component interface can be connected to."},"password":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth password by which a component interface can be connected to."},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url that the component interface should forward to."},"sticky":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running."}},"type":"object","required":["url"],"description":"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentinterfacespec"},"patternProperties":{}}]}}},"OutputDefinitionSpec":{"properties":{"description":{"type":"string","description":"A human-friendly description of the output field."},"value":{"description":"Value of the output to be passed to upstream consumers"}},"type":"object","required":["value"],"description":"Components can define output fields that can be used to share configuration with consuming components.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#outputdefinitionspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"description":{"type":"string","description":"A human-friendly description of the output field."},"value":{"description":"Value of the output to be passed to upstream consumers"}},"type":"object","required":["value"],"description":"Components can define output fields that can be used to share configuration with consuming components.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#outputdefinitionspec"},"patternProperties":{}}]}}},"ComponentSpec":{"properties":{"name":{"type":"string","pattern":"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for."},"keywords":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"Additional search terms to be used when the component is indexed so that others can find it more easily."},"author":{"type":"string","description":"The name or handle of the author of the component as a developer contact."},"homepage":{"type":"string","description":"The url that serves as the informational homepage of the component (i.e. a github repo)."},"secrets":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/SecretDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec","additionalProperties":false},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false},"databases":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false},"services":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false},"tasks":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false},"dependencies":{"type":"object","patternProperties":{"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}},{"$ref":"#/definitions/DependencySpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)","additionalProperties":false},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false},"artifact_image":{"type":"string","deprecated":true,"description":"-"}},"type":"object","required":["name"],"description":"The top level object of the `architect.yml`; defines a deployable Architect Component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"name":{"type":"string","pattern":"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for."},"keywords":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"Additional search terms to be used when the component is indexed so that others can find it more easily."},"author":{"type":"string","description":"The name or handle of the author of the component as a developer contact."},"homepage":{"type":"string","description":"The url that serves as the informational homepage of the component (i.e. a github repo)."},"secrets":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/SecretDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec","additionalProperties":false},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/OutputDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false},"databases":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/DatabaseSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false},"services":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/ServiceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false},"tasks":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/TaskSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false},"dependencies":{"type":"object","patternProperties":{"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}},{"$ref":"#/definitions/DependencySpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)","additionalProperties":false},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/ComponentInterfaceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false},"artifact_image":{"type":"string","deprecated":true,"description":"-"}},"type":"object","required":["name"],"description":"The top level object of the `architect.yml`; defines a deployable Architect Component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentspec"},"patternProperties":{}}]}}},"_DebugDatabaseSpec":{"properties":{"description":{"type":"string","description":"Human readable description"},"type":{"type":"string","anyOf":[{"type":"string","enum":["postgres:10","postgres:11","postgres:12","postgres:13","postgres:14","postgres:15","mysql:5","mysql:6","mysql:7","mysql:8","mariadb:10"]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The type engine and version of database software needed for data storage.","errorMessage":"must be of the format <engine>:<version> (e.g. postgres:13)"},"connection_string":{"anyOf":[{"format":"uri","type":"string"},{"type":"null"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The connection uri of an existing database to use instead of provisioning a new one"}},"type":"object","description":"Component databases let you quickly spin up a database for your service","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#databasespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"description":{"type":"string","description":"Human readable description"},"type":{"type":"string","anyOf":[{"type":"string","enum":["postgres:10","postgres:11","postgres:12","postgres:13","postgres:14","postgres:15","mysql:5","mysql:6","mysql:7","mysql:8","mariadb:10"]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The type engine and version of database software needed for data storage.","errorMessage":"must be of the format <engine>:<version> (e.g. postgres:13)"},"connection_string":{"anyOf":[{"format":"uri","type":"string"},{"type":"null"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The connection uri of an existing database to use instead of provisioning a new one"}},"type":"object","description":"Component databases let you quickly spin up a database for your service","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#databasespec"},"patternProperties":{}}]}}},"_DebugSecretDefinitionSpec":{"properties":{"required":{"type":"boolean","description":"Denotes whether the secret is required."},"description":{"type":"string","description":"A human-friendly description of the secret."},"default":{"anyOf":[{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"number"},{"type":"object"},{"type":"string"},{"type":"null"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Sets a default value for the secret if one is not provided"}},"type":"object","description":"Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#secretdefinitionspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"required":{"type":"boolean","description":"Denotes whether the secret is required."},"description":{"type":"string","description":"A human-friendly description of the secret."},"default":{"anyOf":[{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"number"},{"type":"object"},{"type":"string"},{"type":"null"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Sets a default value for the secret if one is not provided"}},"type":"object","description":"Components can define configurable secrets that can be used to enrich the contained services with environment-specific information (i.e. environment variables).","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#secretdefinitionspec"},"patternProperties":{}}]}}},"_DebugLivenessProbeSpec":{"properties":{"success_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a health check before the container is considered healthy.","default":1},"failure_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a failed health check before the container is considered unhealthy.","default":3},"timeout":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s","default":"5s"},"interval":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s","default":"30s"},"initial_delay":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Delays the check from running for the specified amount of time","default":"0s"},"path":{"deprecated":true,"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)."},"command":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)."},"port":{"deprecated":true,"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)."}},"type":"object","description":"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#livenessprobespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"success_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a health check before the container is considered healthy.","default":1},"failure_threshold":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The number of times to retry a failed health check before the container is considered unhealthy.","default":3},"timeout":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period to wait for a health check to succeed before it is considered a failure. You may specify any value between: 2s and 60s","default":"5s"},"interval":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The time period in seconds between each health check execution. You may specify any value between: 5s and 300s","default":"30s"},"initial_delay":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Delays the check from running for the specified amount of time","default":"0s"},"path":{"deprecated":true,"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Path for the http check executable. Path should be absolute (e.g. /health). If `path` is set, `port` also must be set. This field is disjunctive with `command` (only one of `path` or `command` can be set)."},"command":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"description":"Command that runs the http check. This field is disjunctive with `path` and `port` (only one of `command` or `path`/`port` can be set)."},"port":{"deprecated":true,"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"[Deprecated: use `command` instead.] Port that the http check will run against. If `port` is set, `path` also must be set. This field is disjunctive with `command` (only one of `port` or `command` can be set)."}},"type":"object","description":"Configuration for service health checks. Architect uses health checks are used for load balancing and rolling updates.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#livenessprobespec"},"patternProperties":{}}]}}},"_DebugVolumeSpec":{"properties":{"mount_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Directory at which the volume will be mounted inside the container."},"host_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)."},"key":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).","externalDocs":{"url":"https://docs.architect.io/components/services/#volumes"}},"description":{"type":"string","description":"Human-readable description of volume"},"readonly":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the volume as readonly.","default":false}},"type":"object","not":{"type":"object","required":["host_path","key"]},"errorMessage":{"not":"Only one of host_path, key is allowed, or none should exist"},"description":"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#volumespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"mount_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Directory at which the volume will be mounted inside the container."},"host_path":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A directory on the host machine to sync with the mount_path on the docker image. This field is only relevant inside the debug block for local deployments. This field is disjunctive with `key` (only one of `host_path` or `key` can be set)."},"key":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A reference to the underlying volume on the deployment cluster of choice. The `docker-compose` volume name, the name of the Kubernetes PersistentVolumeClaim, or the EFS ID of an AWS volume. This field is disjunctive with `host_path` (only one of `key` or `host_path` can be set).","externalDocs":{"url":"https://docs.architect.io/components/services/#volumes"}},"description":{"type":"string","description":"Human-readable description of volume"},"readonly":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the volume as readonly.","default":false}},"type":"object","not":{"type":"object","required":["host_path","key"]},"errorMessage":{"not":"Only one of host_path, key is allowed, or none should exist"},"description":"Architect can mount volumes onto your services and tasks to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#volumespec"},"patternProperties":{}}]}}},"_DebugBuildSpec":{"properties":{"context":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the directory containing the source code relative to the `architect.yml` file."},"buildpack":{"type":"boolean","description":"Option to use buildpack to build an image."},"args":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false},"dockerfile":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the Dockerfile relative to the `build.context`","default":"Dockerfile"},"target":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The stage to build in the Dockerfile"}},"type":"object","description":"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.","not":{"type":"object","required":["buildpack","dockerfile"]},"errorMessage":{"not":"Only one of buildpack, dockerfile is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#buildspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"context":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the directory containing the source code relative to the `architect.yml` file."},"buildpack":{"type":"boolean","description":"Option to use buildpack to build an image."},"args":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"string"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"Build args to be passed into `docker build`.","additionalProperties":false},"dockerfile":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path to the Dockerfile relative to the `build.context`","default":"Dockerfile"},"target":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The stage to build in the Dockerfile"}},"type":"object","description":"An object containing the details necessary for Architect to build the service via Docker. Whenever a service that specifies a build field is registered with Architect, the CLI will trigger a docker build and replace the build field with a resolvable image.","not":{"type":"object","required":["buildpack","dockerfile"]},"errorMessage":{"not":"Only one of buildpack, dockerfile is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#buildspec"},"patternProperties":{}}]}}},"_DebugIngressTlsSpec":{"properties":{"crt":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate."},"key":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate key."},"ca":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate ca."}},"type":"object","description":"Configuration for custom certificate.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingresstlsspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"crt":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate."},"key":{"type":"string","anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate key."},"ca":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Custom certificate ca."}},"type":"object","description":"Configuration for custom certificate.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingresstlsspec"},"patternProperties":{}}]}}},"_DebugIngressSpec":{"properties":{"enabled":{"type":"boolean","description":"Marks the interface as an ingress."},"subdomain":{"anyOf":[{"type":"string","pattern":"^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.","errorMessage":"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between."},"tls":{"$ref":"#/definitions/_DebugIngressTlsSpec"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface used for path based routing"},"ip_whitelist":{"anyOf":[{"type":"array","items":{"anyOf":[{"type":"string","format":"cidrv4"},{"type":"string","pattern":"\\${{\\s*secrets\\.[\\w-]+\\s*}}"}]}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24"}}],"description":"IP addresses that are allowed to access the interface"},"private":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the ingress as private behind Architect authentication"}},"type":"object","description":"An ingress exposes an interface to external network traffic through an architect-deployed gateway.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingressspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"enabled":{"type":"boolean","description":"Marks the interface as an ingress."},"subdomain":{"anyOf":[{"type":"string","pattern":"^([A-Za-z0-9](?:[A-Za-z0-9\\-]{0,61}[A-Za-z0-9])|[^\\W\\D\\s\\t\\n\\r\\/]+|[\\@\\*]?)$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The subdomain that will be used if the interface is exposed externally. Use `subdomain: @` to target the base domain.","errorMessage":"must contain alphanumeric characters ([a-z0-9A-Z]), could contain dashes (-) and alphanumerics between."},"tls":{"$ref":"#/definitions/_DebugIngressTlsSpec"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface used for path based routing"},"ip_whitelist":{"anyOf":[{"type":"array","items":{"anyOf":[{"type":"string","format":"cidrv4"},{"type":"string","pattern":"\\${{\\s*secrets\\.[\\w-]+\\s*}}"}]}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}|(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/\\d\\d?)?,?","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}, or a comma-delimited list of cidr/ip addresses ex 8.8.8.8,8.8.4.4/24"}}],"description":"IP addresses that are allowed to access the interface"},"private":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Marks the ingress as private behind Architect authentication"}},"type":"object","description":"An ingress exposes an interface to external network traffic through an architect-deployed gateway.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#ingressspec"},"patternProperties":{}}]}}},"_DebugScalingMetricsSpec":{"properties":{"cpu":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}}},"type":"object","description":"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingmetricsspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"cpu":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"integer","minimum":0,"maximum":100},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory usage required to trigger scaling.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}}},"type":"object","description":"Scaling metrics define the upper bound of resource consumption before spinning up an additional replica.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingmetricsspec"},"patternProperties":{}}]}}},"_DebugScalingSpec":{"properties":{"min_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target minimum number of service replicas."},"max_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target maximum number of service replicas."},"metrics":{"$ref":"#/definitions/_DebugScalingMetricsSpec"}},"type":"object","description":"Configuration that dictates the scaling behavior of a service.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"min_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target minimum number of service replicas."},"max_replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The target maximum number of service replicas."},"metrics":{"$ref":"#/definitions/_DebugScalingMetricsSpec"}},"type":"object","description":"Configuration that dictates the scaling behavior of a service.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#scalingspec"},"patternProperties":{}}]}}},"_DebugKubernetesDeploySpec":{"properties":{"deployment":{}},"type":"object","description":"Configuration that dictates the kubernetes deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"deployment":{}},"type":"object","description":"Configuration that dictates the kubernetes deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#kubernetesdeployspec"},"patternProperties":{}}]}}},"_DebugDeploySpec":{"properties":{"kubernetes":{"$ref":"#/definitions/_DebugKubernetesDeploySpec"}},"type":"object","description":"Configuration that dictates the deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#deployspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"kubernetes":{"$ref":"#/definitions/_DebugKubernetesDeploySpec"}},"type":"object","description":"Configuration that dictates the deploy overrides.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#deployspec"},"patternProperties":{}}]}}},"_DebugServiceInterfaceSpec":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A human-readable description of the interface."},"host":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Port on which the service is listening for traffic."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Protocol that the interface responds to","default":"http"},"username":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth username required to access the interface"},"password":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth password required to access the interface"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface"},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url."},"sticky":{"anyOf":[{"anyOf":[{"type":"boolean"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Denotes that if this interface is made external, the gateway should use sticky sessions","default":false},"ingress":{"$ref":"#/definitions/_DebugIngressSpec"}},"type":"object","description":"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#serviceinterfacespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A human-readable description of the interface."},"host":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The host address of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given host."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Port on which the service is listening for traffic."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Protocol that the interface responds to","default":"http"},"username":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth username required to access the interface"},"password":{"anyOf":[{"anyOf":[{"type":"null"},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A Basic Auth password required to access the interface"},"path":{"anyOf":[{"type":"string","pattern":"^\\/.*$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The path of the interface"},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url of an existing service to use instead of provisioning a new one. Setting this field effectively overrides any deployment of this service and directs all traffic to the given url."},"sticky":{"anyOf":[{"anyOf":[{"type":"boolean"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"Denotes that if this interface is made external, the gateway should use sticky sessions","default":false},"ingress":{"$ref":"#/definitions/_DebugIngressSpec"}},"type":"object","description":"A service interface exposes service functionality over the network to other services within the same component. If you would like to expose services on the network to external components, see the ComponentInterfaceSpec","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#serviceinterfacespec"},"patternProperties":{}}]}}},"_DebugServiceSpec":{"properties":{"enabled":{"type":"boolean","description":"Determines if the service should be running.","default":true},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/_DebugServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/_DebugServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false},"liveness_probe":{"$ref":"#/definitions/_DebugLivenessProbeSpec"},"volumes":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugVolumeSpec"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugVolumeSpec"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false},"replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field."},"scaling":{"$ref":"#/definitions/_DebugScalingSpec"},"deploy":{"$ref":"#/definitions/_DebugDeploySpec"},"termination_grace_period":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"default":"30s","description":"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/_DebugBuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#servicespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"enabled":{"type":"boolean","description":"Determines if the service should be running.","default":true},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/_DebugServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"anyOf":[{"$ref":"#/definitions/_DebugServiceInterfaceSpec"},{"type":"number"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named interfaces to expose service functionality over the network to other services within the same component. A `string` or `number` represents the TCP port that the service is listening on. For more detailed configuration, specify a full `ServiceInterfaceSpec` object.","additionalProperties":false},"liveness_probe":{"$ref":"#/definitions/_DebugLivenessProbeSpec"},"volumes":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugVolumeSpec"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugVolumeSpec"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named volumes to be mounted at deploy-time. Take advantage of volumes to store data that should be shared between running containers or that should persist beyond the lifetime of a container.","additionalProperties":false},"replicas":{"anyOf":[{"type":"integer","minimum":0},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A static number of replicas of a service to be deployed. For scaling configuration, see `scaling` field."},"scaling":{"$ref":"#/definitions/_DebugScalingSpec"},"deploy":{"$ref":"#/definitions/_DebugDeploySpec"},"termination_grace_period":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"default":"30s","description":"A period of time between a service being passed a SIGINT and a SIGTERM when it's scheduled to be replaced or terminated. Only used for remote deployments."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/_DebugBuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A runtimes (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#servicespec"},"patternProperties":{}}]}}},"_DebugTaskSpec":{"properties":{"schedule":{"anyOf":[{"type":"string","format":"cron","errorMessage":{"format":"must be a valid cron expression"}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/_DebugBuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#taskspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"schedule":{"anyOf":[{"type":"string","format":"cron","errorMessage":{"format":"must be a valid cron expression"}},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"A cron expression by which this task will be scheduled. Leave blank to deploy a task that never runs unless triggered from the CLI."},"description":{"type":"string","description":"Human readable description"},"image":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker image that serves as the unit of runtime. This field is disjunctive with `build` (only one of `image` or `build` can be set)"},"command":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker startup command. Use this if you need to override or parameterize or parameterize the docker image command."},"entrypoint":{"anyOf":[{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The docker entrypoint for the container. Use this if you need to override or parameterize the docker image entrypoint."},"language":{"type":"string","description":"The dominant programming language used; this is for informational purposes only."},"environment":{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_]+$":{"anyOf":[{"type":"array"},{"type":"boolean"},{"type":"null"},{"type":"number"},{"type":"string"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of key-value pairs or secret definitions that describes environment variables and their values.","externalDocs":{"url":"https://docs.architect.io/components/services/#local-configuration"},"additionalProperties":false},"build":{"$ref":"#/definitions/_DebugBuildSpec"},"cpu":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The cpu required to run a service or a task","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"memory":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The memory required to run a service or a task.","externalDocs":{"url":"https://docs.architect.io/components/services/#cpu--memory"}},"depends_on":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"An array of service names for those services in the component that are pre-requisites to deploy. Used at deploy-time to build a deploy order across services and tasks."},"labels":{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?=(.{1,63}/)?.{1,63}$)((([a-z0-9][-a-z0-9_.]*)?[a-z0-9])?/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$":{"anyOf":[{"type":"string","pattern":"^(?=.{1,63})(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false}]}},"description":"A simple key-value annotation store; useful to organize, categorize, scope, and select services and tasks.","externalDocs":{"url":"https://docs.architect.io/components/services/#labels"},"additionalProperties":false},"reserved_name":{"type":"string","pattern":"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"A specific service name which will override the service name specified in the component."}},"type":"object","description":"A Task represents a recurring and/or exiting runtime (e.g. crons, schedulers, triggered jobs). Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","not":{"type":"object","required":["build","image"]},"errorMessage":{"not":"Only one of build, image is allowed, or none should exist"},"additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#taskspec"},"patternProperties":{}}]}}},"_DebugDependencySpec":{"properties":{"tag":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$","deprecated":true},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"type":"object","description":"An empty object that optionally supports specifying a tag for backwards compatibility.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#dependencyspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"tag":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$","deprecated":true},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}]}},"type":"object","description":"An empty object that optionally supports specifying a tag for backwards compatibility.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#dependencyspec"},"patternProperties":{}}]}}},"_DebugComponentInterfaceSpec":{"properties":{"ingress":{"$ref":"#/definitions/_DebugIngressSpec"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for."},"host":{"type":"string","description":"The host that the component interface should forward to."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The port that the component interface should forward to."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The protocol by which the component interface can be connected to."},"username":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth username by which a component interface can be connected to."},"password":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth password by which a component interface can be connected to."},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url that the component interface should forward to."},"sticky":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running."}},"type":"object","description":"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentinterfacespec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"ingress":{"$ref":"#/definitions/_DebugIngressSpec"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the interface so that they know what it should be used for."},"host":{"type":"string","description":"The host that the component interface should forward to."},"port":{"anyOf":[{"type":"number"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The port that the component interface should forward to."},"protocol":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The protocol by which the component interface can be connected to."},"username":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth username by which a component interface can be connected to."},"password":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The Basic Auth password by which a component interface can be connected to."},"url":{"anyOf":[{"type":"string"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"The url that the component interface should forward to."},"sticky":{"anyOf":[{"type":"boolean"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}}],"description":"If this interface is made into an external ingress, sticky=true will denote the gateway should use sticky sessions if more than one replica is running."}},"type":"object","description":"Component Interfaces are the primary means by which components advertise their resolvable addresses to others. Interfaces are the only means by which other components can communicate with your component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentinterfacespec"},"patternProperties":{}}]}}},"_DebugOutputDefinitionSpec":{"properties":{"description":{"type":"string","description":"A human-friendly description of the output field."},"value":{"description":"Value of the output to be passed to upstream consumers"}},"type":"object","description":"Components can define output fields that can be used to share configuration with consuming components.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#outputdefinitionspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"description":{"type":"string","description":"A human-friendly description of the output field."},"value":{"description":"Value of the output to be passed to upstream consumers"}},"type":"object","description":"Components can define output fields that can be used to share configuration with consuming components.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#outputdefinitionspec"},"patternProperties":{}}]}}},"_DebugComponentSpec":{"properties":{"name":{"type":"string","pattern":"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for."},"keywords":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"Additional search terms to be used when the component is indexed so that others can find it more easily."},"author":{"type":"string","description":"The name or handle of the author of the component as a developer contact."},"homepage":{"type":"string","description":"The url that serves as the informational homepage of the component (i.e. a github repo)."},"secrets":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/_DebugSecretDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec","additionalProperties":false},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/_DebugOutputDefinitionSpec"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/_DebugOutputDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false},"databases":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugDatabaseSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugDatabaseSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false},"services":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugServiceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugServiceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false},"tasks":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugTaskSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugTaskSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false},"dependencies":{"type":"object","patternProperties":{"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}},{"$ref":"#/definitions/_DebugDependencySpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)","additionalProperties":false},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/_DebugComponentInterfaceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/_DebugComponentInterfaceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false},"artifact_image":{"type":"string","deprecated":true,"description":"-"}},"type":"object","description":"The top level object of the `architect.yml`; defines a deployable Architect Component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentspec"},"patternProperties":{"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"properties":{"name":{"type":"string","pattern":"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$","errorMessage":"must contain only lower alphanumeric and single hyphens in the middle; max length 32","description":"Globally unique friendly reference to the component. must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":{"type":"string","description":"A human-readable description of the component. This will be rendered when potential consumers view the component so that they know what it should be used for."},"keywords":{"type":"array","items":{"anyOf":[{"type":"string"}]},"description":"Additional search terms to be used when the component is indexed so that others can find it more easily."},"author":{"type":"string","description":"The name or handle of the author of the component as a developer contact."},"homepage":{"type":"string","description":"The url that serves as the informational homepage of the component (i.e. a github repo)."},"secrets":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/_DebugSecretDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable fields for the component. If a component contains properties that differ across environments (i.e. environment variables), you'll want to capture them as secrets. Specifying a primitive value here will set the default secret value. For more detailed configuration, specify a SecretDefinitionSpec","additionalProperties":false},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/_DebugOutputDefinitionSpec"},{"type":"null"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/definitions/_DebugOutputDefinitionSpec"},{"type":"null"}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain alphanumeric character ([a-z0-9A-Z]), could contain dashes (-), underscores (_), and alphanumerics between."},"description":"A map of named, configurable outputs for the component. Outputs allow components to expose configuration details that should be shared with consumers, like API keys or notification topic names.","additionalProperties":false},"databases":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugDatabaseSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugDatabaseSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A database represents a stateful service powered by one of several supported database engines.","additionalProperties":false},"services":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugServiceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugServiceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A Service represents a non-exiting runtime (e.g. daemons, servers, etc.). Each service is independently deployable and scalable. Services are 1:1 with a docker image.","additionalProperties":false},"tasks":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugTaskSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"$ref":"#/definitions/_DebugTaskSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named recurring and/or exiting runtimes (e.g. crons, schedulers, triggered jobs) included with the component. Each task will run on its specified schedule and/or be triggerable via the Architect CLI. Tasks are 1:1 with a docker image.","additionalProperties":false},"dependencies":{"type":"object","patternProperties":{"^(?:(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)\\/)?(?<component_name>(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-))(?:@(?<instance_name>[\\w][\\w\\.-]{0,127}))?$":{"anyOf":[{"type":"string","pattern":"^[\\w][\\w\\.-]{0,127}$"},{"type":"string","pattern":"\\${{\\s*(.*?)\\s*}}","errorMessage":{"pattern":"must be an interpolation ref ex. $__arc__{{ secrets.example }}"}},{"$ref":"#/definitions/_DebugDependencySpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A key-value set of dependencies with an empty value. Reference each dependency by component name (e.g. `cloud: {}`)","additionalProperties":false},"interfaces":{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/_DebugComponentInterfaceSpec"}]},"^\\${{\\s*if(.*?)\\s*}}$":{"anyOf":[{"type":"object","patternProperties":{"^(?!-)(?!.{0,32}--)[a-z0-9-]{1,32}(?<!-)$":{"anyOf":[{"type":"string"},{"$ref":"#/definitions/_DebugComponentInterfaceSpec"}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false}]}},"errorMessage":{"additionalProperties":"must contain only lower alphanumeric and single hyphens in the middle; max length 32"},"description":"A set of named gateways that broker access to the services inside the component. All network traffic within a component is locked down to the component itself, unless included in this interfaces block. An interface represents a front-door to your component, granting access to upstream callers.","deprecated":true,"additionalProperties":false},"artifact_image":{"type":"string","deprecated":true,"description":"-"}},"type":"object","description":"The top level object of the `architect.yml`; defines a deployable Architect Component.","additionalProperties":false,"externalDocs":{"url":"https://docs.architect.io/reference/architect-yml#componentspec"},"patternProperties":{}}]}}}}}
|
Provide a JSON object that satisfies the schema "Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml". Here are the required top‑level fields: name. Return only the valid JSON object.
|
Schema for architect.yml. See: https://docs.architect.io/reference/architect-yml
|
schema-store
|
schema_store_56
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/architectfx.json\",\"title\":\"ArchitectFX Documents Schema\",\"type\":\"object\",\"properties\":{\".controller\":{\"type\":\"string\",\"description\":\"A class which may hold injected fields to handle them\"},\".deps\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"description\":\"Maven coordinates used for third-party libraries that are needed to load the document\"}},\".imports\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"description\":\"Java imports for resolving commonly used classes in the Document\"}},\".config\":{\"type\":\"array\",\"description\":\"A series of generic steps to configure global state or specific objects\",\"items\":{\"$ref\":\"#/definitions/config\"}}},\"patternProperties\":{\"^[A-Za-z_][A-Za-z0-9_]*$\":{\"$ref\":\"#/definitions/entity\"}},\"definitions\":{\"config\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\".field\":{\"type\":\"string\",\"description\":\"Field configurations\"},\".value\":{\"description\":\"Value to be assigned to the field\"}},\"required\":[\".field\",\".value\"],\"additionalProperties\":false},{\"type\":\"object\",\"properties\":{\".method\":{\"type\":\"string\",\"description\":\"Name of the method to be invoked\"},\".args\":{\"type\":\"array\",\"description\":\"Arguments for the method\"},\".varargs\":{\"type\":\"array\",\"description\":\"Specifically to be used for method which use varargs\"},\".transform\":{\"type\":\"boolean\",\"description\":\"Indicates whether the output of the method should be used as input for the next config or as the return type\"}},\"required\":[\".method\"],\"additionalProperties\":false}]},\"entity\":{\"description\":\"Entity or tree node\",\"type\":\"object\",\"properties\":{\".args\":{\"type\":\"array\",\"description\":\"Arguments for the constructor\"},\".varargs\":{\"type\":\"array\",\"description\":\"Specifically to be used for constructors which use varargs\"},\".factory\":{\"type\":\"array\",\"description\":\"Allows building this entity through the factory/builder pattern using configs\",\"items\":{\"$ref\":\"#/definitions/config\"}},\".config\":{\"type\":\"array\",\"description\":\"A series of generic steps to configure global state or specific objects\",\"items\":{\"$ref\":\"#/definitions/config\"}},\"children\":{\"type\":\"array\",\"description\":\"Entities may or may not contain other entities inside them\",\"items\":{\"$ref\":\"#/definitions/entity\"}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"ArchitectFX Documents Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/architectfx.json","title":"ArchitectFX Documents Schema","type":"object","properties":{".controller":{"type":"string","description":"A class which may hold injected fields to handle them"},".deps":{"type":"array","uniqueItems":true,"items":{"type":"string","description":"Maven coordinates used for third-party libraries that are needed to load the document"}},".imports":{"type":"array","uniqueItems":true,"items":{"type":"string","description":"Java imports for resolving commonly used classes in the Document"}},".config":{"type":"array","description":"A series of generic steps to configure global state or specific objects","items":{"$ref":"#/definitions/config"}}},"patternProperties":{"^[A-Za-z_][A-Za-z0-9_]*$":{"$ref":"#/definitions/entity"}},"definitions":{"config":{"oneOf":[{"type":"object","properties":{".field":{"type":"string","description":"Field configurations"},".value":{"description":"Value to be assigned to the field"}},"required":[".field",".value"],"additionalProperties":false},{"type":"object","properties":{".method":{"type":"string","description":"Name of the method to be invoked"},".args":{"type":"array","description":"Arguments for the method"},".varargs":{"type":"array","description":"Specifically to be used for method which use varargs"},".transform":{"type":"boolean","description":"Indicates whether the output of the method should be used as input for the next config or as the return type"}},"required":[".method"],"additionalProperties":false}]},"entity":{"description":"Entity or tree node","type":"object","properties":{".args":{"type":"array","description":"Arguments for the constructor"},".varargs":{"type":"array","description":"Specifically to be used for constructors which use varargs"},".factory":{"type":"array","description":"Allows building this entity through the factory/builder pattern using configs","items":{"$ref":"#/definitions/config"}},".config":{"type":"array","description":"A series of generic steps to configure global state or specific objects","items":{"$ref":"#/definitions/config"}},"children":{"type":"array","description":"Entities may or may not contain other entities inside them","items":{"$ref":"#/definitions/entity"}}}}}}
|
Provide a JSON object that satisfies the schema "ArchitectFX Documents Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
ArchitectFX Documents Schema
|
schema-store
|
schema_store_57
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"properties\":{\"management_groups\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"archetypes\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"display_name\":{\"type\":\"string\"},\"exists\":{\"type\":\"boolean\"},\"id\":{\"type\":\"string\"},\"parent_id\":{\"type\":[\"null\",\"string\"]}},\"required\":[\"archetypes\",\"display_name\",\"exists\",\"id\",\"parent_id\"]}},\"name\":{\"type\":\"string\"}},\"required\":[\"management_groups\",\"name\"]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"architecture_definition\". Here are the required top‑level fields: management_groups, name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"management_groups":{"type":"array","items":{"type":"object","properties":{"archetypes":{"type":"array","items":{"type":"string"}},"display_name":{"type":"string"},"exists":{"type":"boolean"},"id":{"type":"string"},"parent_id":{"type":["null","string"]}},"required":["archetypes","display_name","exists","id","parent_id"]}},"name":{"type":"string"}},"required":["management_groups","name"]}
|
Provide a JSON object that satisfies the schema "architecture_definition". Here are the required top‑level fields: management_groups, name. Return only the valid JSON object.
|
architecture_definition
|
schema-store
|
schema_store_58
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"id\":\"https://json.schemastore.org/artifacthub-repo.json\",\"properties\":{\"repositoryID\":{\"description\":\"An identifier of the Artifact Hub repository where the packages will be published to\",\"type\":\"string\",\"format\":\"uuid\"},\"owners\":{\"description\":\"Repository owners\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"title\":\"owner\",\"description\":\"A repository owner\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"description\":\"A repository owner name\",\"type\":\"string\"},\"email\":{\"description\":\"A repository owner email\",\"type\":\"string\",\"format\":\"email\"}}}},\"ignore\":{\"description\":\"Packages that should not be indexed by Artifact Hub\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"title\":\"package\",\"description\":\"A package\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"name\"],\"properties\":{\"name\":{\"description\":\"A package name\",\"type\":\"string\"},\"version\":{\"description\":\"Regular expression\",\"type\":\"string\"}}}}},\"title\":\"An Artifact Hub config file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"An Artifact Hub config file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"id":"https://json.schemastore.org/artifacthub-repo.json","properties":{"repositoryID":{"description":"An identifier of the Artifact Hub repository where the packages will be published to","type":"string","format":"uuid"},"owners":{"description":"Repository owners","type":"array","uniqueItems":true,"items":{"title":"owner","description":"A repository owner","type":"object","additionalProperties":false,"properties":{"name":{"description":"A repository owner name","type":"string"},"email":{"description":"A repository owner email","type":"string","format":"email"}}}},"ignore":{"description":"Packages that should not be indexed by Artifact Hub","type":"array","uniqueItems":true,"items":{"title":"package","description":"A package","type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"description":"A package name","type":"string"},"version":{"description":"Regular expression","type":"string"}}}}},"title":"An Artifact Hub config file","type":"object"}
|
Provide a JSON object that satisfies the schema "An Artifact Hub config file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
An Artifact Hub config file
|
schema-store
|
schema_store_59
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"dolittle.io/schemas/DotNET.SDK/Artifacts.Configuration/artifacts.json\",\"title\":\"Artifacts Configuration\",\"description\":\"The artifacts configuration\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/artifactsByTypeDefinition\"},\"definitions\":{\"artifactsByTypeDefinition\":{\"description\":\"The artifacts by type definition\",\"type\":\"object\",\"properties\":{\"commands\":{\"description\":\"The command artifacts of a Feature\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/artifactDefinition\"}},\"events\":{\"description\":\"The event artifacts of a Feature\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/artifactDefinition\"}},\"eventSources\":{\"description\":\"The event source artifacts of a Feature\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/artifactDefinition\"}},\"readModels\":{\"description\":\"The read model artifacts of a Feature\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/artifactDefinition\"}},\"queries\":{\"description\":\"The query artifacts of a Feature\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/artifactDefinition\"}}},\"required\":[\"commands\",\"events\",\"eventSources\",\"readModels\",\"queries\"]},\"artifactDefinition\":{\"description\":\"The definition of an artifact\",\"type\":\"object\",\"properties\":{\"generation\":{\"description\":\"The artifact generation\",\"type\":\"number\"},\"type\":{\"description\":\"The CLR Type represented by the artifact \",\"type\":\"string\"}},\"required\":[\"generation\",\"type\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Artifacts Configuration\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"dolittle.io/schemas/DotNET.SDK/Artifacts.Configuration/artifacts.json","title":"Artifacts Configuration","description":"The artifacts configuration","type":"object","additionalProperties":{"$ref":"#/definitions/artifactsByTypeDefinition"},"definitions":{"artifactsByTypeDefinition":{"description":"The artifacts by type definition","type":"object","properties":{"commands":{"description":"The command artifacts of a Feature","type":"object","additionalProperties":{"$ref":"#/definitions/artifactDefinition"}},"events":{"description":"The event artifacts of a Feature","type":"object","additionalProperties":{"$ref":"#/definitions/artifactDefinition"}},"eventSources":{"description":"The event source artifacts of a Feature","type":"object","additionalProperties":{"$ref":"#/definitions/artifactDefinition"}},"readModels":{"description":"The read model artifacts of a Feature","type":"object","additionalProperties":{"$ref":"#/definitions/artifactDefinition"}},"queries":{"description":"The query artifacts of a Feature","type":"object","additionalProperties":{"$ref":"#/definitions/artifactDefinition"}}},"required":["commands","events","eventSources","readModels","queries"]},"artifactDefinition":{"description":"The definition of an artifact","type":"object","properties":{"generation":{"description":"The artifact generation","type":"number"},"type":{"description":"The CLR Type represented by the artifact ","type":"string"}},"required":["generation","type"]}}}
|
Provide a JSON object that satisfies the schema "Artifacts Configuration". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Artifacts Configuration
|
schema-store
|
schema_store_60
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://neotys.com/schemas/as-code/v3\",\"title\":\"JSON Schema for NeoLoad as-code files\",\"fileMatch\":[\"*.nl.yaml\",\"*.neoload.yaml\",\"neoload*.yaml\",\"*.nl.yml\",\"*.neoload.yml\",\"neoload*.yml\",\"*.nl.json\",\"*.neoload.json\",\"neoload*.json\"],\"type\":\"object\",\"additionalProperties\":false,\"minProperties\":1,\"xrequired\":[\"name\",\"because neoload files can be partial\"],\"properties\":{\"$schema\":{\"$ref\":\"#/definitions/common/full_url\"},\"name\":{\"$ref\":\"#/definitions/common/name\"},\"includes\":{\"$id\":\"#root/includes\",\"title\":\"Includes\",\"type\":\"array\",\"minItems\":1,\"additionalProperties\":false,\"items\":{\"$ref\":\"#/definitions/common/text\"}},\"variables\":{\"$id\":\"#root/variables\",\"title\":\"Variables\",\"type\":\"array\",\"additionalItems\":false,\"minItems\":1,\"additionalProperties\":false,\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/variables/constant\"},{\"$ref\":\"#/definitions/variables/file\"},{\"$ref\":\"#/definitions/variables/counter\"},{\"$ref\":\"#/definitions/variables/random_number\"},{\"$ref\":\"#/definitions/variables/javascript\"}]}},\"servers\":{\"$id\":\"#root/servers\",\"title\":\"Servers\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/server\"}},\"sla_profiles\":{\"$id\":\"#root/sla_profiles\",\"title\":\"SLA Profiles\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/sla\"}},\"populations\":{\"$id\":\"#root/populations\",\"title\":\"Populations\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/populations/population\"}},\"scenarios\":{\"$id\":\"#root/scenarios\",\"title\":\"Scenarios\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/scenario\"}},\"user_paths\":{\"$id\":\"#root/user_paths\",\"title\":\"User_paths\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/user_paths/user_path\"}}},\"definitions\":{\"common\":{\"text\":{\"$id\":\"#/definitions/common/text\",\"title\":\"Text\",\"type\":\"string\",\"pattern\":\".*\"},\"positive_number\":{\"$id\":\"#/definitions/common/positive_number\",\"title\":\"Positive Number\",\"type\":\"integer\",\"minimum\":0},\"duration\":{\"$id\":\"#/definitions/common/duration\",\"title\":\"Duration\",\"anyOf\":[{\"$ref\":\"#/definitions/common/time\"},{\"$ref\":\"#/definitions/common/iterations\"}]},\"stop_after_options\":{\"$id\":\"#/definitions/common/stop_after_options\",\"title\":\"variation_policy.stop_after values\",\"anyOf\":[{\"$ref\":\"#/definitions/common/time\"},{\"type\":\"string\",\"enum\":[\"current_iteration\"]}]},\"start_after_options\":{\"$id\":\"#/definitions/common/start_after\",\"title\":\"Start after\",\"anyOf\":[{\"$ref\":\"#/definitions/common/time\"},{\"$ref\":\"#/definitions/common/text\"}]},\"time\":{\"$id\":\"#/definitions/common/time\",\"title\":\"Time\",\"type\":\"string\",\"pattern\":\"^((\\\\d{1,2}[hms]{1}){1,3})+$\"},\"iterations\":{\"$id\":\"#/definitions/common/iterations\",\"title\":\"Iterations\",\"type\":\"string\",\"pattern\":\"^(\\\\d+ iterations)$\"},\"name\":{\"title\":\"Name\",\"type\":\"string\",\"pattern\":\"^.*$\"},\"full_url\":{\"title\":\"Url\",\"type\":\"string\",\"pattern\":\"https?:\\\\/\\\\/(www\\\\.)?[-a-zA-Z0-9@:%._\\\\+~#=]{1,256}\\\\.[a-zA-Z0-9()]{1,6}\\\\b([-a-zA-Z0-9()@:%_\\\\+.~#?&//=]*)\"},\"var_change_policy\":{\"type\":\"string\",\"default\":\"each_iteration\",\"enum\":[\"each_use\",\"each_request\",\"each_page\",\"each_iteration\",\"each_user\"]},\"var_scope\":{\"type\":\"string\",\"default\":\"global\",\"enum\":[\"local\",\"global\",\"unique\"]},\"var_order\":{\"type\":\"string\",\"default\":\"global\",\"enum\":[\"sequential\",\"random\",\"any\"]},\"var_out_of_value\":{\"type\":\"string\",\"default\":\"global\",\"enum\":[\"cycle\",\"stop_test\",\"no_value_code\"]}},\"variables\":{\"generic\":{\"$id\":\"#/definitions/variables/generic\",\"type\":\"object\",\"xrequired\":[\"name\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/name\"},\"descrption\":{\"$ref\":\"#/definitions/common/text\"},\"change_policy\":{\"$ref\":\"#/definitions/common/var_change_policy\"}}},\"constant\":{\"$id\":\"#/definitions/variables/constant\",\"title\":\"Constant\",\"type\":\"object\",\"xrequired\":[\"value\"],\"allOf\":[{\"$ref\":\"#/definitions/variables/generic\"},{\"properties\":{\"value\":{\"$ref\":\"#/definitions/common/text\"}}}],\"x-d7nosupport-additionalProperties\":false},\"file\":{\"$id\":\"#/definitions/variables/file\",\"title\":\"File\",\"type\":\"object\",\"xrequired\":[\"path\"],\"allOf\":[{\"$ref\":\"#/definitions/variables/generic\"},{\"properties\":{\"column_names\":{\"type\":\"array\",\"items\":[{\"type\":\"string\"}]},\"is_first_line_column_names\":{\"type\":\"boolean\",\"default\":false},\"start_from_line\":{\"type\":\"integer\",\"default\":1},\"delimiter\":{\"$ref\":\"#/definitions/common/text\",\"default\":\",\"},\"path\":{\"$ref\":\"#/definitions/common/text\"},\"scope\":{\"$ref\":\"#/definitions/common/var_scope\"},\"order\":{\"$ref\":\"#/definitions/common/var_order\"},\"out_of_value\":{\"$ref\":\"#/definitions/common/var_out_of_value\"}}}],\"x-d7nosupport-additionalProperties\":false},\"counter\":{\"$id\":\"#/definitions/variables/counter\",\"title\":\"Counter\",\"type\":\"object\",\"xrequired\":[\"start\",\"end\",\"increment\"],\"allOf\":[{\"$ref\":\"#/definitions/variables/generic\"},{\"properties\":{\"start\":{\"type\":\"number\"},\"end\":{\"type\":\"number\"},\"increment\":{\"type\":\"number\"},\"scope\":{\"$ref\":\"#/definitions/common/var_scope\"},\"out_of_value\":{\"$ref\":\"#/definitions/common/var_out_of_value\"}}}],\"x-d7nosupport-additionalProperties\":false},\"random_number\":{\"$id\":\"#/definitions/variables/random_number\",\"title\":\"Random Number\",\"type\":\"object\",\"xrequired\":[\"min\",\"max\"],\"allOf\":[{\"$ref\":\"#/definitions/variables/generic\"},{\"properties\":{\"min\":{\"type\":\"number\"},\"max\":{\"type\":\"number\"},\"predictable\":{\"type\":\"boolean\"}}}],\"x-d7nosupport-additionalProperties\":false},\"javascript\":{\"$id\":\"#/definitions/variables/javascript\",\"title\":\"Javascript\",\"type\":\"object\",\"xrequired\":[\"script\"],\"allOf\":[{\"$ref\":\"#/definitions/variables/generic\"},{\"properties\":{\"script\":{\"$ref\":\"#/definitions/common/text\"}}}],\"x-d7nosupport-additionalProperties\":false}},\"server\":{\"$id\":\"#/definitions/server\",\"title\":\"Server\",\"type\":\"object\",\"xrequired\":[\"name\",\"host\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"host\":{\"$ref\":\"#/definitions/common/text\"},\"scheme\":{\"$id\":\"#root/servers/items/scheme\",\"type\":\"string\",\"enum\":[\"http\",\"https\"]},\"port\":{\"type\":\"integer\"},\"basic_authentication\":{\"$ref\":\"#/definitions/authentication/basic\"},\"ntlm_authentication\":{\"$ref\":\"#/definitions/authentication/ntlm\"},\"negotiate_authentication\":{\"$ref\":\"#/definitions/authentication/basic\"}}},\"authentication\":{\"auth-generic\":{\"$id\":\"#/definitions/authentication/auth-generic\",\"type\":\"object\",\"xrequired\":[\"login\",\"password\"],\"properties\":{\"login\":{\"$ref\":\"#/definitions/common/text\"},\"password\":{\"$ref\":\"#/definitions/common/text\"}}},\"auth-generic-domain\":{\"$id\":\"#/definitions/authentication/auth-generic-domain\",\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/definitions/authentication/auth-generic\"},{\"properties\":{\"domain\":{\"$ref\":\"#/definitions/common/text\"}}}]},\"basic\":{\"$id\":\"#/definitions/authentication/basic\",\"title\":\"Basic Authentication\",\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/definitions/authentication/auth-generic\"},{\"properties\":{\"realm\":{\"$ref\":\"#/definitions/common/text\"}}}]},\"ntlm\":{\"$id\":\"#/definitions/authentication/ntlm\",\"title\":\"NTLM Authentication\",\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/definitions/authentication/auth-generic-domain\"}]},\"negotiate\":{\"$id\":\"#/definitions/authentication/negotiate\",\"title\":\"Negotiate Authentication\",\"type\":\"object\",\"allOf\":[{\"$ref\":\"#/definitions/authentication/auth-generic-domain\"}]}},\"sla\":{\"$id\":\"#/definitions/sla\",\"title\":\"SLA Profile\",\"type\":\"object\",\"xrequired\":[\"name\",\"thresholds\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"thresholds\":{\"$id\":\"#/definitions/sla/thresholds\",\"title\":\"Thresholds\",\"type\":\"array\",\"minItems\":1,\"additionalProperties\":false,\"items\":{\"$ref\":\"#/definitions/sla/threshold\"}}},\"threshold\":{\"$id\":\"#/definitions/sla/threshold\",\"title\":\"Threshold\",\"type\":\"string\",\"pattern\":\"^(.*?)\\\\s(warn\\\\s(>=|==|<=|>|<))(?=\\\\s)(.*?)per\\\\s(test|interval)$\"}},\"populations\":{\"population\":{\"$id\":\"#/definitions/population\",\"title\":\"Population\",\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"xcomments\":{\"value\":\"why do we need the substructure 'name' to denote a string list?\"},\"user_paths\":{\"type\":\"array\",\"minItems\":1,\"additionalProperties\":false,\"additionalItems\":false,\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"}}}}}},\"constant_load\":{\"$id\":\"#/definitions/populations/constant_load\",\"title\":\"Constant Load\",\"type\":\"object\",\"required\":[\"users\"],\"properties\":{\"duration\":{\"$ref\":\"#/definitions/common/duration\"},\"start_after\":{\"$ref\":\"#/definitions/common/start_after_options\"},\"stop_after\":{\"$ref\":\"#/definitions/common/stop_after_options\"},\"users\":{\"type\":\"integer\",\"default\":1},\"rampup\":{\"$ref\":\"#/definitions/common/time\"}}},\"rampup_load\":{\"$id\":\"#/definitions/populations/rampup_load\",\"title\":\"Ramp-up Load\",\"type\":\"object\",\"required\":[\"min_users\",\"increment_users\",\"increment_every\"],\"properties\":{\"duration\":{\"$ref\":\"#/definitions/common/duration\"},\"start_after\":{\"$ref\":\"#/definitions/common/start_after_options\"},\"stop_after\":{\"$ref\":\"#/definitions/common/stop_after_options\"},\"min_users\":{\"$ref\":\"#/definitions/common/positive_number\"},\"max_users\":{\"$ref\":\"#/definitions/common/positive_number\"},\"increment_users\":{\"type\":\"integer\",\"default\":1},\"increment_every\":{\"$ref\":\"#/definitions/common/duration\"},\"increment_rampup\":{\"$ref\":\"#/definitions/common/time\"}},\"additionalProperties\":false},\"peaks_load\":{\"$id\":\"#/definitions/populations/peaks_load\",\"title\":\"Peaks Load\",\"type\":\"object\",\"required\":[\"minimum\",\"maximum\",\"start\"],\"properties\":{\"minimum\":{\"$ref\":\"#/definitions/populations/peaks_phase\"},\"maximum\":{\"$ref\":\"#/definitions/populations/peaks_phase\"},\"start\":{\"type\":\"string\",\"enum\":[\"minimum\",\"maximum\"]},\"duration\":{\"$ref\":\"#/definitions/common/duration\"},\"start_after\":{\"$ref\":\"#/definitions/common/start_after_options\"},\"step_rampup\":{\"$ref\":\"#/definitions/common/text\"},\"stop_after\":{\"$ref\":\"#/definitions/common/stop_after_options\"}},\"additionalProperties\":false},\"peaks_phase\":{\"$id\":\"#/definitions/populations/peaks_phase\",\"title\":\"Peak Phase\",\"type\":\"object\",\"required\":[\"users\",\"duration\"],\"properties\":{\"users\":{\"$ref\":\"#/definitions/common/positive_number\"},\"duration\":{\"$ref\":\"#/definitions/common/duration\"}}}},\"scenario\":{\"$id\":\"#/definitions/scenario\",\"title\":\"Scenario\",\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"populations\":{\"$id\":\"#/definitions/scenario/populations\",\"title\":\"Scenario Populations\",\"type\":\"array\",\"minItems\":1,\"additionalItems\":false,\"additionalProperties\":false,\"items\":{\"$id\":\"#/definitions/scenario/populations/items\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"constant_load\":{\"$ref\":\"#/definitions/populations/constant_load\"},\"rampup_load\":{\"$ref\":\"#/definitions/populations/rampup_load\"},\"peaks_load\":{\"$ref\":\"#/definitions/populations/peaks_load\"}}}}}},\"user_paths\":{\"user_path\":{\"$id\":\"#/definitions/user_paths/user_path\",\"title\":\"User Path\",\"type\":\"object\",\"required\":[\"name\",\"actions\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"user_session\":{\"type\":\"string\",\"enum\":[\"reset_on\",\"reset_off\",\"reset_auto\"]},\"init\":{\"$ref\":\"#/definitions/user_paths/container\"},\"actions\":{\"$ref\":\"#/definitions/user_paths/container\"},\"end\":{\"$ref\":\"#/definitions/user_paths/container\"}}},\"container\":{\"$id\":\"#/definitions/user_paths/container\",\"title\":\"Containers\",\"type\":\"object\",\"required\":[\"steps\"],\"properties\":{\"sla_profile\":{\"type\":\"string\"},\"steps\":{\"title\":\"Steps\",\"type\":\"array\",\"minItems\":1,\"items\":{\"type\":\"object\",\"properties\":{\"transaction\":{\"$ref\":\"#/definitions/user_paths/actions/transaction\"},\"request\":{\"$ref\":\"#/definitions/user_paths/actions/request\"},\"delay\":{\"$ref\":\"#/definitions/user_paths/actions/delay\"},\"think_time\":{\"$ref\":\"#/definitions/user_paths/actions/think_time\"},\"javascript\":{\"$ref\":\"#/definitions/user_paths/actions/javascript\"},\"if\":{\"$ref\":\"#/definitions/user_paths/actions/if\"}},\"additionalProperties\":false}}}},\"actions\":{\"transaction\":{\"$id\":\"#/definitions/user_paths/actions/transaction\",\"name\":\"transaction\",\"title\":\"Action: Transaction\",\"type\":\"object\",\"required\":[\"name\",\"steps\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"steps\":{\"title\":\"Steps\",\"type\":\"array\",\"minItems\":1,\"items\":{\"type\":\"object\",\"properties\":{\"transaction\":{\"$ref\":\"#/definitions/user_paths/actions/transaction\"},\"request\":{\"$ref\":\"#/definitions/user_paths/actions/request\"},\"delay\":{\"$ref\":\"#/definitions/user_paths/actions/delay\"},\"think_time\":{\"$ref\":\"#/definitions/user_paths/actions/think_time\"},\"javascript\":{\"$ref\":\"#/definitions/user_paths/actions/javascript\"},\"if\":{\"$ref\":\"#/definitions/user_paths/actions/if\"}},\"additionalProperties\":false}}},\"additionalProperties\":false},\"request\":{\"$id\":\"#/definitions/user_paths/actions/request\",\"title\":\"Action: HTTP/s Request\",\"type\":\"object\",\"required\":[\"url\"],\"properties\":{\"url\":{\"$ref\":\"#/definitions/common/text\"},\"server\":{\"$ref\":\"#/definitions/common/text\"},\"method\":{\"type\":\"string\",\"enum\":[\"GET\",\"POST\",\"HEAD\",\"PUT\",\"DELETE\",\"OPTIONS\",\"TRACE\"]},\"headers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"value\":{\"type\":\"string\"}}}},\"sla_profile\":{\"$ref\":\"#/definitions/common/text\"},\"body\":{\"$ref\":\"#/definitions/common/text\"},\"extractors\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/user_paths/extractor\"}}}},\"delay\":{\"$id\":\"#/definitions/user_paths/actions/delay\",\"title\":\"Action: Delay\",\"type\":\"string\",\"allOf\":[{\"$ref\":\"#/definitions/common/text\"}]},\"think_time\":{\"$id\":\"#/definitions/user_paths/actions/think_time\",\"title\":\"Action: Think Time\",\"type\":\"string\",\"allOf\":[{\"$ref\":\"#/definitions/common/text\"}]},\"javascript\":{\"$id\":\"#/definitions/user_paths/actions/javascript\",\"title\":\"Action: Javascript\",\"type\":\"object\",\"xrequired\":[\"name\",\"script\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"script\":{\"$ref\":\"#/definitions/common/text\"}}},\"if\":{\"$id\":\"#/definitions/user_paths/actions/if\",\"title\":\"Action: If\",\"type\":\"object\",\"xrequired\":[\"conditions\",\"then\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"description\":{\"$ref\":\"#/definitions/common/text\"},\"conditions\":{\"type\":\"array\",\"xcomments\":\"like GWBSR said: 'aint gonna do it', at least not this commit\",\"items\":{\"$ref\":\"#/definitions/common/text\"}},\"match\":{\"type\":\"string\",\"enum\":[\"any\",\"all\"],\"default\":\"any\"},\"then\":{\"$ref\":\"#/definitions/user_paths/container\"},\"else\":{\"$ref\":\"#/definitions/user_paths/container\"}}}},\"extractor\":{\"type\":\"object\",\"xrequired\":[\"name\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/common/text\"},\"from\":{\"type\":\"string\",\"default\":\"body\",\"enum\":[\"header\",\"body\",\"both\"]},\"xpath\":{\"$ref\":\"#/definitions/common/text\"},\"jsonpath\":{\"$ref\":\"#/definitions/common/text\"},\"regexp\":{\"$ref\":\"#/definitions/common/text\"},\"match_number\":{\"type\":\"integer\",\"default\":1},\"template\":{\"$ref\":\"#/definitions/common/text\"},\"decode\":{\"type\":\"string\",\"enum\":[\"html\",\"url\"]},\"extract_once\":{\"type\":\"boolean\",\"default\":false},\"default\":{\"type\":\"string\",\"default\":\"\"},\"throw_assertion_error\":{\"type\":\"boolean\",\"default\":true}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for NeoLoad as-code files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://neotys.com/schemas/as-code/v3","title":"JSON Schema for NeoLoad as-code files","fileMatch":["*.nl.yaml","*.neoload.yaml","neoload*.yaml","*.nl.yml","*.neoload.yml","neoload*.yml","*.nl.json","*.neoload.json","neoload*.json"],"type":"object","additionalProperties":false,"minProperties":1,"xrequired":["name","because neoload files can be partial"],"properties":{"$schema":{"$ref":"#/definitions/common/full_url"},"name":{"$ref":"#/definitions/common/name"},"includes":{"$id":"#root/includes","title":"Includes","type":"array","minItems":1,"additionalProperties":false,"items":{"$ref":"#/definitions/common/text"}},"variables":{"$id":"#root/variables","title":"Variables","type":"array","additionalItems":false,"minItems":1,"additionalProperties":false,"items":{"anyOf":[{"$ref":"#/definitions/variables/constant"},{"$ref":"#/definitions/variables/file"},{"$ref":"#/definitions/variables/counter"},{"$ref":"#/definitions/variables/random_number"},{"$ref":"#/definitions/variables/javascript"}]}},"servers":{"$id":"#root/servers","title":"Servers","type":"array","minItems":1,"items":{"$ref":"#/definitions/server"}},"sla_profiles":{"$id":"#root/sla_profiles","title":"SLA Profiles","type":"array","minItems":1,"items":{"$ref":"#/definitions/sla"}},"populations":{"$id":"#root/populations","title":"Populations","type":"array","minItems":1,"items":{"$ref":"#/definitions/populations/population"}},"scenarios":{"$id":"#root/scenarios","title":"Scenarios","type":"array","minItems":1,"items":{"$ref":"#/definitions/scenario"}},"user_paths":{"$id":"#root/user_paths","title":"User_paths","type":"array","minItems":1,"items":{"$ref":"#/definitions/user_paths/user_path"}}},"definitions":{"common":{"text":{"$id":"#/definitions/common/text","title":"Text","type":"string","pattern":".*"},"positive_number":{"$id":"#/definitions/common/positive_number","title":"Positive Number","type":"integer","minimum":0},"duration":{"$id":"#/definitions/common/duration","title":"Duration","anyOf":[{"$ref":"#/definitions/common/time"},{"$ref":"#/definitions/common/iterations"}]},"stop_after_options":{"$id":"#/definitions/common/stop_after_options","title":"variation_policy.stop_after values","anyOf":[{"$ref":"#/definitions/common/time"},{"type":"string","enum":["current_iteration"]}]},"start_after_options":{"$id":"#/definitions/common/start_after","title":"Start after","anyOf":[{"$ref":"#/definitions/common/time"},{"$ref":"#/definitions/common/text"}]},"time":{"$id":"#/definitions/common/time","title":"Time","type":"string","pattern":"^((\\d{1,2}[hms]{1}){1,3})+$"},"iterations":{"$id":"#/definitions/common/iterations","title":"Iterations","type":"string","pattern":"^(\\d+ iterations)$"},"name":{"title":"Name","type":"string","pattern":"^.*$"},"full_url":{"title":"Url","type":"string","pattern":"https?:\\/\\/(www\\.)?[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,6}\\b([-a-zA-Z0-9()@:%_\\+.~#?&//=]*)"},"var_change_policy":{"type":"string","default":"each_iteration","enum":["each_use","each_request","each_page","each_iteration","each_user"]},"var_scope":{"type":"string","default":"global","enum":["local","global","unique"]},"var_order":{"type":"string","default":"global","enum":["sequential","random","any"]},"var_out_of_value":{"type":"string","default":"global","enum":["cycle","stop_test","no_value_code"]}},"variables":{"generic":{"$id":"#/definitions/variables/generic","type":"object","xrequired":["name"],"properties":{"name":{"$ref":"#/definitions/common/name"},"descrption":{"$ref":"#/definitions/common/text"},"change_policy":{"$ref":"#/definitions/common/var_change_policy"}}},"constant":{"$id":"#/definitions/variables/constant","title":"Constant","type":"object","xrequired":["value"],"allOf":[{"$ref":"#/definitions/variables/generic"},{"properties":{"value":{"$ref":"#/definitions/common/text"}}}],"x-d7nosupport-additionalProperties":false},"file":{"$id":"#/definitions/variables/file","title":"File","type":"object","xrequired":["path"],"allOf":[{"$ref":"#/definitions/variables/generic"},{"properties":{"column_names":{"type":"array","items":[{"type":"string"}]},"is_first_line_column_names":{"type":"boolean","default":false},"start_from_line":{"type":"integer","default":1},"delimiter":{"$ref":"#/definitions/common/text","default":","},"path":{"$ref":"#/definitions/common/text"},"scope":{"$ref":"#/definitions/common/var_scope"},"order":{"$ref":"#/definitions/common/var_order"},"out_of_value":{"$ref":"#/definitions/common/var_out_of_value"}}}],"x-d7nosupport-additionalProperties":false},"counter":{"$id":"#/definitions/variables/counter","title":"Counter","type":"object","xrequired":["start","end","increment"],"allOf":[{"$ref":"#/definitions/variables/generic"},{"properties":{"start":{"type":"number"},"end":{"type":"number"},"increment":{"type":"number"},"scope":{"$ref":"#/definitions/common/var_scope"},"out_of_value":{"$ref":"#/definitions/common/var_out_of_value"}}}],"x-d7nosupport-additionalProperties":false},"random_number":{"$id":"#/definitions/variables/random_number","title":"Random Number","type":"object","xrequired":["min","max"],"allOf":[{"$ref":"#/definitions/variables/generic"},{"properties":{"min":{"type":"number"},"max":{"type":"number"},"predictable":{"type":"boolean"}}}],"x-d7nosupport-additionalProperties":false},"javascript":{"$id":"#/definitions/variables/javascript","title":"Javascript","type":"object","xrequired":["script"],"allOf":[{"$ref":"#/definitions/variables/generic"},{"properties":{"script":{"$ref":"#/definitions/common/text"}}}],"x-d7nosupport-additionalProperties":false}},"server":{"$id":"#/definitions/server","title":"Server","type":"object","xrequired":["name","host"],"additionalProperties":false,"properties":{"name":{"$ref":"#/definitions/common/text"},"host":{"$ref":"#/definitions/common/text"},"scheme":{"$id":"#root/servers/items/scheme","type":"string","enum":["http","https"]},"port":{"type":"integer"},"basic_authentication":{"$ref":"#/definitions/authentication/basic"},"ntlm_authentication":{"$ref":"#/definitions/authentication/ntlm"},"negotiate_authentication":{"$ref":"#/definitions/authentication/basic"}}},"authentication":{"auth-generic":{"$id":"#/definitions/authentication/auth-generic","type":"object","xrequired":["login","password"],"properties":{"login":{"$ref":"#/definitions/common/text"},"password":{"$ref":"#/definitions/common/text"}}},"auth-generic-domain":{"$id":"#/definitions/authentication/auth-generic-domain","type":"object","allOf":[{"$ref":"#/definitions/authentication/auth-generic"},{"properties":{"domain":{"$ref":"#/definitions/common/text"}}}]},"basic":{"$id":"#/definitions/authentication/basic","title":"Basic Authentication","type":"object","allOf":[{"$ref":"#/definitions/authentication/auth-generic"},{"properties":{"realm":{"$ref":"#/definitions/common/text"}}}]},"ntlm":{"$id":"#/definitions/authentication/ntlm","title":"NTLM Authentication","type":"object","allOf":[{"$ref":"#/definitions/authentication/auth-generic-domain"}]},"negotiate":{"$id":"#/definitions/authentication/negotiate","title":"Negotiate Authentication","type":"object","allOf":[{"$ref":"#/definitions/authentication/auth-generic-domain"}]}},"sla":{"$id":"#/definitions/sla","title":"SLA Profile","type":"object","xrequired":["name","thresholds"],"properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"thresholds":{"$id":"#/definitions/sla/thresholds","title":"Thresholds","type":"array","minItems":1,"additionalProperties":false,"items":{"$ref":"#/definitions/sla/threshold"}}},"threshold":{"$id":"#/definitions/sla/threshold","title":"Threshold","type":"string","pattern":"^(.*?)\\s(warn\\s(>=|==|<=|>|<))(?=\\s)(.*?)per\\s(test|interval)$"}},"populations":{"population":{"$id":"#/definitions/population","title":"Population","type":"object","properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"xcomments":{"value":"why do we need the substructure 'name' to denote a string list?"},"user_paths":{"type":"array","minItems":1,"additionalProperties":false,"additionalItems":false,"items":{"type":"object","properties":{"name":{"$ref":"#/definitions/common/text"}}}}}},"constant_load":{"$id":"#/definitions/populations/constant_load","title":"Constant Load","type":"object","required":["users"],"properties":{"duration":{"$ref":"#/definitions/common/duration"},"start_after":{"$ref":"#/definitions/common/start_after_options"},"stop_after":{"$ref":"#/definitions/common/stop_after_options"},"users":{"type":"integer","default":1},"rampup":{"$ref":"#/definitions/common/time"}}},"rampup_load":{"$id":"#/definitions/populations/rampup_load","title":"Ramp-up Load","type":"object","required":["min_users","increment_users","increment_every"],"properties":{"duration":{"$ref":"#/definitions/common/duration"},"start_after":{"$ref":"#/definitions/common/start_after_options"},"stop_after":{"$ref":"#/definitions/common/stop_after_options"},"min_users":{"$ref":"#/definitions/common/positive_number"},"max_users":{"$ref":"#/definitions/common/positive_number"},"increment_users":{"type":"integer","default":1},"increment_every":{"$ref":"#/definitions/common/duration"},"increment_rampup":{"$ref":"#/definitions/common/time"}},"additionalProperties":false},"peaks_load":{"$id":"#/definitions/populations/peaks_load","title":"Peaks Load","type":"object","required":["minimum","maximum","start"],"properties":{"minimum":{"$ref":"#/definitions/populations/peaks_phase"},"maximum":{"$ref":"#/definitions/populations/peaks_phase"},"start":{"type":"string","enum":["minimum","maximum"]},"duration":{"$ref":"#/definitions/common/duration"},"start_after":{"$ref":"#/definitions/common/start_after_options"},"step_rampup":{"$ref":"#/definitions/common/text"},"stop_after":{"$ref":"#/definitions/common/stop_after_options"}},"additionalProperties":false},"peaks_phase":{"$id":"#/definitions/populations/peaks_phase","title":"Peak Phase","type":"object","required":["users","duration"],"properties":{"users":{"$ref":"#/definitions/common/positive_number"},"duration":{"$ref":"#/definitions/common/duration"}}}},"scenario":{"$id":"#/definitions/scenario","title":"Scenario","type":"object","properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"populations":{"$id":"#/definitions/scenario/populations","title":"Scenario Populations","type":"array","minItems":1,"additionalItems":false,"additionalProperties":false,"items":{"$id":"#/definitions/scenario/populations/items","type":"object","required":["name"],"properties":{"name":{"$ref":"#/definitions/common/text"},"constant_load":{"$ref":"#/definitions/populations/constant_load"},"rampup_load":{"$ref":"#/definitions/populations/rampup_load"},"peaks_load":{"$ref":"#/definitions/populations/peaks_load"}}}}}},"user_paths":{"user_path":{"$id":"#/definitions/user_paths/user_path","title":"User Path","type":"object","required":["name","actions"],"properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"user_session":{"type":"string","enum":["reset_on","reset_off","reset_auto"]},"init":{"$ref":"#/definitions/user_paths/container"},"actions":{"$ref":"#/definitions/user_paths/container"},"end":{"$ref":"#/definitions/user_paths/container"}}},"container":{"$id":"#/definitions/user_paths/container","title":"Containers","type":"object","required":["steps"],"properties":{"sla_profile":{"type":"string"},"steps":{"title":"Steps","type":"array","minItems":1,"items":{"type":"object","properties":{"transaction":{"$ref":"#/definitions/user_paths/actions/transaction"},"request":{"$ref":"#/definitions/user_paths/actions/request"},"delay":{"$ref":"#/definitions/user_paths/actions/delay"},"think_time":{"$ref":"#/definitions/user_paths/actions/think_time"},"javascript":{"$ref":"#/definitions/user_paths/actions/javascript"},"if":{"$ref":"#/definitions/user_paths/actions/if"}},"additionalProperties":false}}}},"actions":{"transaction":{"$id":"#/definitions/user_paths/actions/transaction","name":"transaction","title":"Action: Transaction","type":"object","required":["name","steps"],"properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"steps":{"title":"Steps","type":"array","minItems":1,"items":{"type":"object","properties":{"transaction":{"$ref":"#/definitions/user_paths/actions/transaction"},"request":{"$ref":"#/definitions/user_paths/actions/request"},"delay":{"$ref":"#/definitions/user_paths/actions/delay"},"think_time":{"$ref":"#/definitions/user_paths/actions/think_time"},"javascript":{"$ref":"#/definitions/user_paths/actions/javascript"},"if":{"$ref":"#/definitions/user_paths/actions/if"}},"additionalProperties":false}}},"additionalProperties":false},"request":{"$id":"#/definitions/user_paths/actions/request","title":"Action: HTTP/s Request","type":"object","required":["url"],"properties":{"url":{"$ref":"#/definitions/common/text"},"server":{"$ref":"#/definitions/common/text"},"method":{"type":"string","enum":["GET","POST","HEAD","PUT","DELETE","OPTIONS","TRACE"]},"headers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"sla_profile":{"$ref":"#/definitions/common/text"},"body":{"$ref":"#/definitions/common/text"},"extractors":{"type":"array","items":{"$ref":"#/definitions/user_paths/extractor"}}}},"delay":{"$id":"#/definitions/user_paths/actions/delay","title":"Action: Delay","type":"string","allOf":[{"$ref":"#/definitions/common/text"}]},"think_time":{"$id":"#/definitions/user_paths/actions/think_time","title":"Action: Think Time","type":"string","allOf":[{"$ref":"#/definitions/common/text"}]},"javascript":{"$id":"#/definitions/user_paths/actions/javascript","title":"Action: Javascript","type":"object","xrequired":["name","script"],"properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"script":{"$ref":"#/definitions/common/text"}}},"if":{"$id":"#/definitions/user_paths/actions/if","title":"Action: If","type":"object","xrequired":["conditions","then"],"properties":{"name":{"$ref":"#/definitions/common/text"},"description":{"$ref":"#/definitions/common/text"},"conditions":{"type":"array","xcomments":"like GWBSR said: 'aint gonna do it', at least not this commit","items":{"$ref":"#/definitions/common/text"}},"match":{"type":"string","enum":["any","all"],"default":"any"},"then":{"$ref":"#/definitions/user_paths/container"},"else":{"$ref":"#/definitions/user_paths/container"}}}},"extractor":{"type":"object","xrequired":["name"],"properties":{"name":{"$ref":"#/definitions/common/text"},"from":{"type":"string","default":"body","enum":["header","body","both"]},"xpath":{"$ref":"#/definitions/common/text"},"jsonpath":{"$ref":"#/definitions/common/text"},"regexp":{"$ref":"#/definitions/common/text"},"match_number":{"type":"integer","default":1},"template":{"$ref":"#/definitions/common/text"},"decode":{"type":"string","enum":["html","url"]},"extract_once":{"type":"boolean","default":false},"default":{"type":"string","default":""},"throw_assertion_error":{"type":"boolean","default":true}}}}}}
|
Provide a JSON object that satisfies the schema "JSON Schema for NeoLoad as-code files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for NeoLoad as-code files
|
schema-store
|
schema_store_61
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{\"nonEmptyString\":{\"type\":\"string\",\"minLength\":1},\"arrayOfNonEmptyStrings\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/nonEmptyString\"}},\"nonEmptyStringOrArrayOfNonEmptyStrings\":{\"anyOf\":[{\"$ref\":\"#/definitions/nonEmptyString\"},{\"$ref\":\"#/definitions/arrayOfNonEmptyStrings\"}]},\"webAssemblyFeatures\":{\"type\":\"string\",\"enum\":[\"sign-extension\",\"mutable-globals\",\"nontrapping-f2i\",\"bulk-memory\",\"simd\",\"threads\",\"exception-handling\",\"tail-calls\",\"reference-types\",\"multi-value\",\"gc\",\"memory64\"]},\"compilerOptions\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"optimize\":{\"description\":\"Optimizes the module.\",\"type\":\"boolean\"},\"optimizeLevel\":{\"description\":\"How much to focus on optimizing code.\",\"type\":\"number\",\"minimum\":0,\"maximum\":3},\"shrinkLevel\":{\"description\":\"How much to focus on shrinking code size.\",\"type\":\"number\",\"minimum\":0,\"maximum\":2},\"converge\":{\"description\":\"Re-optimizes until no further improvements can be made.\",\"type\":\"boolean\"},\"baseDir\":{\"$ref\":\"#/definitions/nonEmptyString\",\"description\":\"Specifies the base directory of input and output files.\"},\"outFile\":{\"$ref\":\"#/definitions/nonEmptyString\",\"description\":\"Specifies the WebAssembly output file (.wasm).\"},\"textFile\":{\"$ref\":\"#/definitions/nonEmptyString\",\"description\":\"Specifies the WebAssembly text output file (.wat).\"},\"bindings\":{\"description\":\"Specified the bindings to generate.\",\"definitions\":{\"bindings\":{\"enum\":[\"esm\",\"raw\"]}},\"anyOf\":[{\"$ref\":\"#/definitions/compilerOptions/properties/bindings/definitions/bindings\"},{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/compilerOptions/properties/bindings/definitions/bindings\"}}]},\"sourceMap\":{\"description\":\"Enables source map generation. Optionally takes the URL.\",\"anyOf\":[{\"type\":\"boolean\"},{\"$ref\":\"#/definitions/nonEmptyString\"}]},\"runtime\":{\"description\":\"Specifies the runtime variant to include in the program.\",\"anyOf\":[{\"type\":\"string\",\"enum\":[\"incremental\",\"minimal\",\"stub\"]},{\"$ref\":\"#/definitions/nonEmptyString\"}]},\"noUnsafe\":{\"description\":\"Disallows the use of unsafe features in user code.\",\"type\":\"boolean\"},\"debug\":{\"description\":\"Enables debug information in emitted binaries.\",\"type\":\"boolean\"},\"noAssert\":{\"description\":\"Replaces assertions with just their value without trapping.\",\"type\":\"boolean\"},\"noEmit\":{\"description\":\"Performs compilation as usual but does not emit code.\",\"type\":\"boolean\"},\"importMemory\":{\"description\":\"Imports the memory provided as 'env.memory'.\",\"type\":\"boolean\"},\"noExportMemory\":{\"description\":\"Does not export the memory as 'memory'.\",\"type\":\"boolean\"},\"initialMemory\":{\"description\":\"Sets the initial memory size in pages.\",\"type\":\"number\"},\"maximumMemory\":{\"description\":\"Sets the maximum memory size in pages.\",\"type\":\"number\"},\"sharedMemory\":{\"description\":\"Declare memory as shared. Requires maximumMemory.\",\"type\":\"number\"},\"zeroFilledMemory\":{\"description\":\"Assume that imported memory is zero filled. Requires importMemory.\",\"type\":\"boolean\"},\"memoryBase\":{\"description\":\"Sets the start offset of compiler-generated static memory.\",\"type\":\"number\"},\"importTable\":{\"description\":\"Imports the function table provided as 'env.table'.\",\"type\":\"boolean\"},\"exportTable\":{\"description\":\"Exports the function table as 'table'.\",\"type\":\"boolean\"},\"exportStart\":{\"$ref\":\"#/definitions/nonEmptyString\",\"description\":\"Exports the start function instead of calling it implicitly.\"},\"lib\":{\"$ref\":\"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings\",\"description\":\"Adds one or multiple paths to custom library components.\"},\"path\":{\"$ref\":\"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings\",\"description\":\"Adds one or multiple paths to package resolution.\"},\"use\":{\"$ref\":\"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings\",\"description\":\"Aliases a global object under another name.\"},\"trapMode\":{\"description\":\"Sets the trap mode to use.\",\"type\":\"string\",\"enum\":[\"allow\",\"clamp\",\"js\"]},\"runPasses\":{\"$ref\":\"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings\",\"description\":\"Specifies additional Binaryen passes to run.\"},\"noValidate\":{\"description\":\"Skips validating the module using Binaryen.\",\"type\":\"boolean\"},\"enable\":{\"description\":\"Enables WebAssembly features that are disabled by default.\",\"anyOf\":[{\"$ref\":\"#/definitions/webAssemblyFeatures\"},{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/webAssemblyFeatures\"}}]},\"disable\":{\"description\":\"Disables WebAssembly features that are enabled by default.\",\"anyOf\":[{\"$ref\":\"#/definitions/webAssemblyFeatures\"},{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/webAssemblyFeatures\"}}]},\"transform\":{\"$ref\":\"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings\",\"description\":\"Specifies the path to a custom transform to 'require'.\"},\"pedantic\":{\"description\":\"Make yourself sad for no good reason.\",\"type\":\"boolean\"},\"stats\":{\"description\":\"Prints measuring information on I/O and compile times.\",\"type\":\"boolean\"},\"noColors\":{\"description\":\"Disables terminal colors.\",\"type\":\"boolean\"},\"exportRuntime\":{\"description\":\"Exports the runtime helpers (__new, __collect etc.).\",\"type\":\"boolean\"},\"stackSize\":{\"description\":\"Exports the runtime helpers (__new, __collect etc.).\",\"type\":\"number\",\"minimum\":0},\"lowMemoryLimit\":{\"description\":\"Enforces very low (<64k) memory constraints.\",\"type\":\"number\",\"minimum\":0},\"tableBase\":{\"description\":\"Sets the start offset of emitted table elements.\",\"type\":\"number\",\"minimum\":0},\"wasm\":{\"$ref\":\"#/definitions/nonEmptyString\",\"description\":\"Uses the specified Wasm binary of the compiler.\"}}}},\"id\":\"https://json.schemastore.org/asconfig-schema.json\",\"properties\":{\"extends\":{\"$ref\":\"#/definitions/nonEmptyString\"},\"entries\":{\"$ref\":\"#/definitions/arrayOfNonEmptyStrings\"},\"options\":{\"$ref\":\"#/definitions/compilerOptions\"},\"targets\":{\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/compilerOptions\"}}},\"title\":\"JSON schema for asconfig.json\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for asconfig.json\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"nonEmptyString":{"type":"string","minLength":1},"arrayOfNonEmptyStrings":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/nonEmptyString"}},"nonEmptyStringOrArrayOfNonEmptyStrings":{"anyOf":[{"$ref":"#/definitions/nonEmptyString"},{"$ref":"#/definitions/arrayOfNonEmptyStrings"}]},"webAssemblyFeatures":{"type":"string","enum":["sign-extension","mutable-globals","nontrapping-f2i","bulk-memory","simd","threads","exception-handling","tail-calls","reference-types","multi-value","gc","memory64"]},"compilerOptions":{"type":"object","additionalProperties":false,"properties":{"optimize":{"description":"Optimizes the module.","type":"boolean"},"optimizeLevel":{"description":"How much to focus on optimizing code.","type":"number","minimum":0,"maximum":3},"shrinkLevel":{"description":"How much to focus on shrinking code size.","type":"number","minimum":0,"maximum":2},"converge":{"description":"Re-optimizes until no further improvements can be made.","type":"boolean"},"baseDir":{"$ref":"#/definitions/nonEmptyString","description":"Specifies the base directory of input and output files."},"outFile":{"$ref":"#/definitions/nonEmptyString","description":"Specifies the WebAssembly output file (.wasm)."},"textFile":{"$ref":"#/definitions/nonEmptyString","description":"Specifies the WebAssembly text output file (.wat)."},"bindings":{"description":"Specified the bindings to generate.","definitions":{"bindings":{"enum":["esm","raw"]}},"anyOf":[{"$ref":"#/definitions/compilerOptions/properties/bindings/definitions/bindings"},{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/compilerOptions/properties/bindings/definitions/bindings"}}]},"sourceMap":{"description":"Enables source map generation. Optionally takes the URL.","anyOf":[{"type":"boolean"},{"$ref":"#/definitions/nonEmptyString"}]},"runtime":{"description":"Specifies the runtime variant to include in the program.","anyOf":[{"type":"string","enum":["incremental","minimal","stub"]},{"$ref":"#/definitions/nonEmptyString"}]},"noUnsafe":{"description":"Disallows the use of unsafe features in user code.","type":"boolean"},"debug":{"description":"Enables debug information in emitted binaries.","type":"boolean"},"noAssert":{"description":"Replaces assertions with just their value without trapping.","type":"boolean"},"noEmit":{"description":"Performs compilation as usual but does not emit code.","type":"boolean"},"importMemory":{"description":"Imports the memory provided as 'env.memory'.","type":"boolean"},"noExportMemory":{"description":"Does not export the memory as 'memory'.","type":"boolean"},"initialMemory":{"description":"Sets the initial memory size in pages.","type":"number"},"maximumMemory":{"description":"Sets the maximum memory size in pages.","type":"number"},"sharedMemory":{"description":"Declare memory as shared. Requires maximumMemory.","type":"number"},"zeroFilledMemory":{"description":"Assume that imported memory is zero filled. Requires importMemory.","type":"boolean"},"memoryBase":{"description":"Sets the start offset of compiler-generated static memory.","type":"number"},"importTable":{"description":"Imports the function table provided as 'env.table'.","type":"boolean"},"exportTable":{"description":"Exports the function table as 'table'.","type":"boolean"},"exportStart":{"$ref":"#/definitions/nonEmptyString","description":"Exports the start function instead of calling it implicitly."},"lib":{"$ref":"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings","description":"Adds one or multiple paths to custom library components."},"path":{"$ref":"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings","description":"Adds one or multiple paths to package resolution."},"use":{"$ref":"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings","description":"Aliases a global object under another name."},"trapMode":{"description":"Sets the trap mode to use.","type":"string","enum":["allow","clamp","js"]},"runPasses":{"$ref":"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings","description":"Specifies additional Binaryen passes to run."},"noValidate":{"description":"Skips validating the module using Binaryen.","type":"boolean"},"enable":{"description":"Enables WebAssembly features that are disabled by default.","anyOf":[{"$ref":"#/definitions/webAssemblyFeatures"},{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/webAssemblyFeatures"}}]},"disable":{"description":"Disables WebAssembly features that are enabled by default.","anyOf":[{"$ref":"#/definitions/webAssemblyFeatures"},{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/webAssemblyFeatures"}}]},"transform":{"$ref":"#/definitions/nonEmptyStringOrArrayOfNonEmptyStrings","description":"Specifies the path to a custom transform to 'require'."},"pedantic":{"description":"Make yourself sad for no good reason.","type":"boolean"},"stats":{"description":"Prints measuring information on I/O and compile times.","type":"boolean"},"noColors":{"description":"Disables terminal colors.","type":"boolean"},"exportRuntime":{"description":"Exports the runtime helpers (__new, __collect etc.).","type":"boolean"},"stackSize":{"description":"Exports the runtime helpers (__new, __collect etc.).","type":"number","minimum":0},"lowMemoryLimit":{"description":"Enforces very low (<64k) memory constraints.","type":"number","minimum":0},"tableBase":{"description":"Sets the start offset of emitted table elements.","type":"number","minimum":0},"wasm":{"$ref":"#/definitions/nonEmptyString","description":"Uses the specified Wasm binary of the compiler."}}}},"id":"https://json.schemastore.org/asconfig-schema.json","properties":{"extends":{"$ref":"#/definitions/nonEmptyString"},"entries":{"$ref":"#/definitions/arrayOfNonEmptyStrings"},"options":{"$ref":"#/definitions/compilerOptions"},"targets":{"type":"object","additionalProperties":{"$ref":"#/definitions/compilerOptions"}}},"title":"JSON schema for asconfig.json","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for asconfig.json". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for asconfig.json
|
schema-store
|
schema_store_62
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"title\":\"RootConfig\",\"type\":\"object\",\"properties\":{\"default_config\":{\"anyOf\":[{\"$ref\":\"#/definitions/Config\"},{\"type\":\"null\"}]},\"project\":{\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/ProjectConfig\"}}},\"definitions\":{\"Arch\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"x86\",\"x86-64\",\"arm\",\"arm64\",\"riscv\",\"z80\",\"6502\",\"power-isa\",\"AVR\",\"mips\"]},{\"description\":\"enables both `Arch::X86` and `Arch::X86_64`\",\"type\":\"string\",\"enum\":[\"x86/x86-64\"]}]},\"Assembler\":{\"type\":\"string\",\"enum\":[\"avr\",\"ca65\",\"fasm\",\"gas\",\"go\",\"mars\",\"masm\",\"nasm\"]},\"Config\":{\"type\":\"object\",\"required\":[\"assembler\",\"instruction_set\"],\"properties\":{\"assembler\":{\"$ref\":\"#/definitions/Assembler\"},\"instruction_set\":{\"$ref\":\"#/definitions/Arch\"},\"opts\":{\"anyOf\":[{\"$ref\":\"#/definitions/ConfigOptions\"},{\"type\":\"null\"}]},\"version\":{\"type\":[\"string\",\"null\"]}}},\"ConfigOptions\":{\"type\":\"object\",\"properties\":{\"compile_flags_txt\":{\"type\":[\"array\",\"null\"],\"items\":{\"type\":\"string\"}},\"compiler\":{\"type\":[\"string\",\"null\"]},\"default_diagnostics\":{\"type\":[\"boolean\",\"null\"]},\"diagnostics\":{\"type\":[\"boolean\",\"null\"]}}},\"ProjectConfig\":{\"type\":\"object\",\"required\":[\"assembler\",\"instruction_set\",\"path\"],\"properties\":{\"assembler\":{\"$ref\":\"#/definitions/Assembler\"},\"instruction_set\":{\"$ref\":\"#/definitions/Arch\"},\"opts\":{\"anyOf\":[{\"$ref\":\"#/definitions/ConfigOptions\"},{\"type\":\"null\"}]},\"path\":{\"type\":\"string\"},\"version\":{\"type\":[\"string\",\"null\"]}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"RootConfig\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","title":"RootConfig","type":"object","properties":{"default_config":{"anyOf":[{"$ref":"#/definitions/Config"},{"type":"null"}]},"project":{"type":["array","null"],"items":{"$ref":"#/definitions/ProjectConfig"}}},"definitions":{"Arch":{"oneOf":[{"type":"string","enum":["x86","x86-64","arm","arm64","riscv","z80","6502","power-isa","AVR","mips"]},{"description":"enables both `Arch::X86` and `Arch::X86_64`","type":"string","enum":["x86/x86-64"]}]},"Assembler":{"type":"string","enum":["avr","ca65","fasm","gas","go","mars","masm","nasm"]},"Config":{"type":"object","required":["assembler","instruction_set"],"properties":{"assembler":{"$ref":"#/definitions/Assembler"},"instruction_set":{"$ref":"#/definitions/Arch"},"opts":{"anyOf":[{"$ref":"#/definitions/ConfigOptions"},{"type":"null"}]},"version":{"type":["string","null"]}}},"ConfigOptions":{"type":"object","properties":{"compile_flags_txt":{"type":["array","null"],"items":{"type":"string"}},"compiler":{"type":["string","null"]},"default_diagnostics":{"type":["boolean","null"]},"diagnostics":{"type":["boolean","null"]}}},"ProjectConfig":{"type":"object","required":["assembler","instruction_set","path"],"properties":{"assembler":{"$ref":"#/definitions/Assembler"},"instruction_set":{"$ref":"#/definitions/Arch"},"opts":{"anyOf":[{"$ref":"#/definitions/ConfigOptions"},{"type":"null"}]},"path":{"type":"string"},"version":{"type":["string","null"]}}}}}
|
Provide a JSON object that satisfies the schema "RootConfig". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
RootConfig
|
schema-store
|
schema_store_63
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/asmdef.json\",\"anyOf\":[{\"properties\":{\"includePlatforms\":{\"minItems\":1},\"excludePlatforms\":{\"maxItems\":0}}},{\"properties\":{\"includePlatforms\":{\"maxItems\":0},\"excludePlatforms\":{\"minItems\":1}}},{\"properties\":{\"includePlatforms\":{\"maxItems\":0},\"excludePlatforms\":{\"maxItems\":0}}}],\"definitions\":{\"platformValues\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"enum\":[\"Android\",\"Editor\",\"iOS\",\"LinuxStandalone32\",\"LinuxStandalone64\",\"LinuxStandaloneUniversal\",\"Lumin\",\"macOSStandalone\",\"Nintendo3DS\",\"PS4\",\"PSVita\",\"Stadia\",\"Switch\",\"tvOS\",\"WSA\",\"WebGL\",\"WindowsStandalone32\",\"WindowsStandalone64\",\"XboxOne\"]}}},\"description\":\"Defines an assembly in the Unity compilation pipeline\",\"properties\":{\"name\":{\"description\":\"The name of the assembly being defined\",\"type\":\"string\",\"minLength\":1},\"rootNamespace\":{\"description\":\"The root namespace of the assembly. Requires Unity 2020.2\",\"type\":\"string\"},\"references\":{\"description\":\"A list of assembly names or assembly asset GUIDs to reference\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"minLength\":1},\"uniqueItems\":true},\"includePlatforms\":{\"$ref\":\"#/definitions/platformValues\",\"description\":\"Platforms to target\"},\"excludePlatforms\":{\"$ref\":\"#/definitions/platformValues\",\"description\":\"Platforms that are explicitly not targeted\"},\"allowUnsafeCode\":{\"description\":\"Allow unsafe code\",\"type\":\"boolean\",\"default\":false},\"autoReferenced\":{\"description\":\"When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)\",\"type\":\"boolean\",\"default\":true},\"noEngineReferences\":{\"description\":\"When true, no references to UnityEngine or UnityEditor will be added to this assembly project\",\"type\":\"boolean\",\"default\":false},\"overrideReferences\":{\"description\":\"When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced\",\"type\":\"boolean\",\"default\":\"false\"},\"precompiledReferences\":{\"description\":\"A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true\",\"type\":\"array\",\"uniqueItems\":true},\"defineConstraints\":{\"description\":\"A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)\",\"type\":\"array\",\"uniqueItems\":true},\"optionalUnityReferences\":{\"description\":\"Additional optional Unity features to reference\",\"type\":\"array\",\"items\":{\"enum\":[\"TestAssemblies\"]},\"uniqueItems\":true},\"versionDefines\":{\"description\":\"A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The package or module that will provide the version to be checked in the expression\",\"type\":\"string\"},\"expression\":{\"description\":\"The semantic version range of the chosen package or module\",\"type\":\"string\"},\"define\":{\"description\":\"The name of the define that is added to the project file when expression evaluates to true\",\"type\":\"string\"}},\"required\":[\"name\",\"expression\",\"define\"]}}},\"required\":[\"name\"],\"title\":\"Unity Assembly Definition\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Unity Assembly Definition\". Here are the required top‑level fields: name. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/asmdef.json","anyOf":[{"properties":{"includePlatforms":{"minItems":1},"excludePlatforms":{"maxItems":0}}},{"properties":{"includePlatforms":{"maxItems":0},"excludePlatforms":{"minItems":1}}},{"properties":{"includePlatforms":{"maxItems":0},"excludePlatforms":{"maxItems":0}}}],"definitions":{"platformValues":{"type":"array","uniqueItems":true,"items":{"enum":["Android","Editor","iOS","LinuxStandalone32","LinuxStandalone64","LinuxStandaloneUniversal","Lumin","macOSStandalone","Nintendo3DS","PS4","PSVita","Stadia","Switch","tvOS","WSA","WebGL","WindowsStandalone32","WindowsStandalone64","XboxOne"]}}},"description":"Defines an assembly in the Unity compilation pipeline","properties":{"name":{"description":"The name of the assembly being defined","type":"string","minLength":1},"rootNamespace":{"description":"The root namespace of the assembly. Requires Unity 2020.2","type":"string"},"references":{"description":"A list of assembly names or assembly asset GUIDs to reference","type":"array","items":{"type":"string","minLength":1},"uniqueItems":true},"includePlatforms":{"$ref":"#/definitions/platformValues","description":"Platforms to target"},"excludePlatforms":{"$ref":"#/definitions/platformValues","description":"Platforms that are explicitly not targeted"},"allowUnsafeCode":{"description":"Allow unsafe code","type":"boolean","default":false},"autoReferenced":{"description":"When true, this assembly definition is automatically referenced by predefined assemblies (Assembly-CSharp, Assembly-CSharp-firstpass, etc.)","type":"boolean","default":true},"noEngineReferences":{"description":"When true, no references to UnityEngine or UnityEditor will be added to this assembly project","type":"boolean","default":false},"overrideReferences":{"description":"When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced","type":"boolean","default":"false"},"precompiledReferences":{"description":"A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true","type":"array","uniqueItems":true},"defineConstraints":{"description":"A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)","type":"array","uniqueItems":true},"optionalUnityReferences":{"description":"Additional optional Unity features to reference","type":"array","items":{"enum":["TestAssemblies"]},"uniqueItems":true},"versionDefines":{"description":"A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"The package or module that will provide the version to be checked in the expression","type":"string"},"expression":{"description":"The semantic version range of the chosen package or module","type":"string"},"define":{"description":"The name of the define that is added to the project file when expression evaluates to true","type":"string"}},"required":["name","expression","define"]}}},"required":["name"],"title":"Unity Assembly Definition","type":"object"}
|
Provide a JSON object that satisfies the schema "Unity Assembly Definition". Here are the required top‑level fields: name. Return only the valid JSON object.
|
Unity Assembly Definition
|
schema-store
|
schema_store_64
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/aspire-8.0.json\",\"type\":\"object\",\"description\":\"Defines the .NET Aspire 8.0 deployment manifest JSON schema.\",\"required\":[\"resources\"],\"properties\":{\"resources\":{\"type\":\"object\",\"description\":\"Contains the set of resources deployable as part of this manifest. Each property is a distinct resource.\",\"additionalProperties\":{\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\"}},\"oneOf\":[{\"type\":\"object\",\"description\":\"A resource that represents a Dockerfile that will be built into a container during deployment.\",\"required\":[\"type\",\"path\",\"context\"],\"properties\":{\"type\":{\"const\":\"dockerfile.v0\"},\"path\":{\"type\":\"string\",\"description\":\"The file path to the Dockerfile to be built into a container image.\"},\"context\":{\"type\":\"string\",\"description\":\"A directory path used as the context for building the Dockerfile into a container image.\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"bindings\":{\"$ref\":\"#/definitions/bindings\"},\"buildArgs\":{\"$ref\":\"#/definitions/buildArgs\"}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"A generic container resource.\",\"required\":[\"type\",\"image\"],\"properties\":{\"type\":{\"const\":\"container.v0\"},\"image\":{\"type\":\"string\",\"description\":\"A string representing the container image to be used.\"},\"entrypoint\":{\"type\":\"string\",\"description\":\"The entrypoint to use for the container image when executed.\"},\"args\":{\"$ref\":\"#/definitions/args\"},\"connectionString\":{\"$ref\":\"#/definitions/connectionString\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"bindings\":{\"$ref\":\"#/definitions/bindings\"},\"bindMounts\":{\"$ref\":\"#/definitions/bindMounts\"},\"volumes\":{\"$ref\":\"#/definitions/volumes\"},\"build\":false},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"A generic container resource.\",\"oneOf\":[{\"required\":[\"type\",\"build\"]},{\"required\":[\"type\",\"image\"]}],\"properties\":{\"type\":{\"const\":\"container.v1\"},\"image\":{\"type\":\"string\",\"description\":\"A string representing the container image to be used.\"},\"entrypoint\":{\"type\":\"string\",\"description\":\"The entrypoint to use for the container image when executed.\"},\"deployment\":{\"oneOf\":[{\"$ref\":\"#/definitions/resource.azure.bicep.v0\"},{\"$ref\":\"#/definitions/resource.azure.bicep.v1\"}]},\"args\":{\"$ref\":\"#/definitions/args\"},\"build\":{\"$ref\":\"#/definitions/build\"},\"connectionString\":{\"$ref\":\"#/definitions/connectionString\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"bindings\":{\"$ref\":\"#/definitions/bindings\"},\"bindMounts\":{\"$ref\":\"#/definitions/bindMounts\"},\"volumes\":{\"$ref\":\"#/definitions/volumes\"}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"Represents a .NET project resource.\",\"required\":[\"type\",\"path\"],\"properties\":{\"type\":{\"const\":\"project.v0\"},\"path\":{\"type\":\"string\",\"description\":\"The path to the project file. Relative paths are interpreted as being relative to the location of the manifest file.\"},\"args\":{\"$ref\":\"#/definitions/args\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"bindings\":{\"$ref\":\"#/definitions/bindings\"}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"Represents a .NET project resource.\",\"required\":[\"type\",\"path\"],\"properties\":{\"type\":{\"const\":\"project.v1\"},\"path\":{\"type\":\"string\",\"description\":\"The path to the project file. Relative paths are interpreted as being relative to the location of the manifest file.\"},\"deployment\":{\"oneOf\":[{\"$ref\":\"#/definitions/resource.azure.bicep.v0\"},{\"$ref\":\"#/definitions/resource.azure.bicep.v1\"}]},\"args\":{\"$ref\":\"#/definitions/args\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"bindings\":{\"$ref\":\"#/definitions/bindings\"}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"Represents an executable resource.\",\"required\":[\"type\",\"command\",\"workingDirectory\"],\"properties\":{\"type\":{\"const\":\"executable.v0\"},\"workingDirectory\":{\"type\":\"string\",\"description\":\"The path to the working directory. Should be interpreted as being relative to the AppHost directory.\"},\"command\":{\"type\":\"string\",\"description\":\"The path to the command. Should be interpreted as being relative to the AppHost directory.\"},\"args\":{\"$ref\":\"#/definitions/args\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"bindings\":{\"$ref\":\"#/definitions/bindings\"}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"connectionString\"],\"description\":\"Represents a value resource. Typically used to perform string concatenation (e.g. for connection strings).\",\"properties\":{\"type\":{\"const\":\"value.v0\"},\"connectionString\":{\"$ref\":\"#/definitions/connectionString\"}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"Represents a parameter resource. Parameter resources are used to represent external configuration values that should be provided at deployment time.\",\"required\":[\"value\",\"inputs\"],\"properties\":{\"type\":{\"const\":\"parameter.v0\"},\"value\":{\"$ref\":\"#/definitions/value\"},\"connectionString\":{\"$ref\":\"#/definitions/connectionString\"},\"inputs\":{\"type\":\"object\",\"description\":\"Defines a set of input values which need to be either generated or prompted by the deployment tool. This is typically used for environment specific configuration values or secrets.\",\"additionalProperties\":{\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of the value to be prompted or generated. Currently only 'string'' is supported.\",\"enum\":[\"string\"]},\"secret\":{\"type\":\"boolean\",\"description\":\"Flag indicating whether the value should be treated as a secret. Deployment tools should note this value to take appropriate precautions when prompting, storing, and transmitting this value.\"},\"default\":{\"type\":\"object\",\"oneOf\":[{\"required\":[\"generate\"],\"properties\":{\"generate\":{\"type\":\"object\",\"required\":[\"minLength\"],\"properties\":{\"minLength\":{\"type\":\"number\",\"description\":\"The minimum length of the generated value.\"},\"lower\":{\"type\":\"boolean\",\"description\":\"Indicates whether lower case characters are allowed in the generated value.\"},\"upper\":{\"type\":\"boolean\",\"description\":\"Indicates whether upper case characters are allowed in the generated value.\"},\"numeric\":{\"type\":\"boolean\",\"description\":\"Indicates whether numeric characters are allowed in the generated value.\"},\"special\":{\"type\":\"boolean\",\"description\":\"Indicates whether special characters are allowed in the generated value.\"},\"minLower\":{\"type\":\"number\",\"description\":\"Specifies the minimum number of lower case characters that must appear in the generated value.\"},\"minUpper\":{\"type\":\"number\",\"description\":\"Specifies the minimum number of upper case characters that must appear in the generated value.\"},\"minNumeric\":{\"type\":\"number\",\"description\":\"Specifies the minimum number of numeric characters that must appear in the generated value.\"},\"minSpecial\":{\"type\":\"number\",\"description\":\"Specifies the minimum number of special characters that must appear in the generated value.\"}}},\"additionalProperties\":false}},{\"required\":[\"value\"],\"properties\":{\"value\":{\"type\":\"string\",\"description\":\"The default value to use if the parameter is not provided at deployment time.\"}}}]}},\"additionalProperties\":false}}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"Represents a Dapr resource in the manifest.\",\"required\":[\"dapr\"],\"properties\":{\"type\":{\"const\":\"dapr.v0\"},\"dapr\":{\"type\":\"object\",\"description\":\"Dapr specific configuration.\",\"required\":[\"application\",\"appId\",\"components\"],\"properties\":{\"application\":{\"type\":\"string\"},\"appId\":{\"type\":\"string\"},\"components\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"additionalProperties\":false}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"daprComponent\"],\"properties\":{\"type\":{\"const\":\"dapr.component.v0\"},\"daprComponent\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"additionalProperties\":false},{\"$ref\":\"#/definitions/resource.azure.bicep.v0\"},{\"$ref\":\"#/definitions/resource.azure.bicep.v1\"},{\"type\":\"object\",\"required\":[\"type\",\"stack-name\"],\"properties\":{\"type\":{\"const\":\"aws.cloudformation.stack.v0\"},\"stack-name\":{\"type\":\"string\"},\"references\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"target-resource\":{\"type\":\"string\"}},\"additionalProperties\":false}}},\"additionalProperties\":false},{\"type\":\"object\",\"required\":[\"type\",\"stack-name\",\"template-path\"],\"properties\":{\"type\":{\"const\":\"aws.cloudformation.template.v0\"},\"stack-name\":{\"type\":\"string\"},\"template-path\":{\"type\":\"string\"},\"references\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"target-resource\":{\"type\":\"string\"}},\"additionalProperties\":false}}},\"additionalProperties\":false},{\"type\":\"object\",\"description\":\"Represents extensions. Any object with a 'type' field that is not captured above will pass.\",\"required\":[\"type\"],\"not\":{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"parameter.v0\",\"container.v0\",\"container.v1\",\"dockerfile.v0\",\"project.v0\",\"project.v1\",\"value.v0\",\"executable.v0\",\"azure.bicep.v0\",\"azure.bicep.v1\",\"aws.cloudformation.template.v0\",\"aws.cloudformation.stack.v0\",\"dapr.component.v0\",\"dapr.v0\"]}}},\"properties\":{\"type\":{\"type\":\"string\"}}}]}}},\"definitions\":{\"resource.azure.bicep.v0\":{\"type\":\"object\",\"description\":\"Represents a resource that is deployed using Azure Bicep.\",\"required\":[\"path\"],\"properties\":{\"type\":{\"const\":\"azure.bicep.v0\"},\"path\":{\"type\":\"string\",\"description\":\"Path to the Bicep file to be used for deployment.\"},\"connectionString\":{\"$ref\":\"#/definitions/connectionString\"},\"params\":{\"type\":\"object\",\"description\":\"A list of parameters which are passed to Azure deployment.\",\"additionalProperties\":{\"oneOf\":[{\"type\":\"array\"},{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"object\"},{\"type\":\"string\"}]}}},\"additionalProperties\":false},\"resource.azure.bicep.v1\":{\"allOf\":[{\"$ref\":\"#/definitions/resource.azure.bicep.v0\"},{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"azure.bicep.v1\"},\"scope\":{\"type\":\"object\",\"properties\":{\"resourceGroup\":{\"type\":\"string\",\"description\":\"The name of the resource group to deploy the resource to.\"}}}}}]},\"connectionString\":{\"type\":\"string\",\"description\":\"A connection string that can be used to connect to this resource.\"},\"value\":{\"type\":\"string\",\"description\":\"A value that can be referenced via an expression in the manifest\"},\"args\":{\"type\":\"array\",\"description\":\"List of arguments to used when launched.\",\"items\":{\"type\":\"string\"}},\"build\":{\"type\":\"object\",\"description\":\"An object that captures properties that control the building of a container image.\",\"required\":[\"context\",\"dockerfile\"],\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"The path to the context directory for the container build. Can be relative of absolute. If relative it is relative to the location of the manifest file.\"},\"dockerfile\":{\"type\":\"string\",\"description\":\"The path to the Dockerfile. Can be relative or absolute. If relative it is relative to the manifest file.\"},\"args\":{\"type\":\"object\",\"description\":\"A list of build arguments which are used during container build.\",\"additionalProperties\":{\"type\":\"string\"}},\"secrets\":{\"type\":\"object\",\"description\":\"A list of build arguments which are used during container build.\",\"additionalProperties\":{\"type\":\"object\",\"required\":[\"type\"],\"oneOf\":[{\"required\":[\"type\",\"value\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"env\"},\"value\":{\"type\":\"string\",\"description\":\"If provided use as the value for the environment variable when docker build is run.\"}}},{\"required\":[\"type\",\"source\"],\"properties\":{\"type\":{\"type\":\"string\",\"const\":\"file\"},\"source\":{\"type\":\"string\",\"description\":\"Path to secret file. If relative, the path is relative to the manifest file.\"}}}]}}},\"additionalProperties\":false},\"buildArgs\":{\"type\":\"object\",\"description\":\"A list of build arguments which are used during container build (for dockerfile.v0 resource type).\",\"additionalProperties\":{\"type\":\"string\"}},\"bindings\":{\"type\":\"object\",\"description\":\"A list of port bindings for the resource when it is deployed.\",\"additionalProperties\":{\"type\":\"object\",\"required\":[\"scheme\",\"protocol\",\"transport\"],\"properties\":{\"scheme\":{\"type\":\"string\",\"description\":\"The scheme used in URIs for this binding.\",\"enum\":[\"http\",\"https\",\"tcp\",\"udp\"]},\"protocol\":{\"type\":\"string\",\"description\":\"The protocol used for this binding (only 'tcp' or 'udp' are valid).\",\"enum\":[\"tcp\",\"udp\"]},\"transport\":{\"type\":\"string\",\"description\":\"Additional information describing the transport (e.g. HTTP/2).\",\"enum\":[\"http\",\"http2\",\"tcp\"]},\"external\":{\"type\":\"boolean\",\"description\":\"A flag indicating whether this binding is exposed externally when deployed.\"},\"targetPort\":{\"type\":\"number\",\"description\":\"The port that the workload (e.g. container) is listening on.\"},\"port\":{\"type\":\"number\",\"description\":\"The port that the workload (e.g. container) is exposed as to other resources and externally.\"}},\"additionalProperties\":false}},\"env\":{\"type\":\"object\",\"description\":\"A list of environment variables which are inserted into the resource at runtime.\",\"additionalProperties\":{\"type\":\"string\"}},\"volumes\":{\"type\":\"array\",\"description\":\"A list of volumes associated with this resource when deployed.\",\"items\":{\"type\":\"object\",\"required\":[\"name\",\"target\",\"readOnly\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of the volume.\"},\"target\":{\"type\":\"string\",\"description\":\"The target within the container where the volume is mounted.\"},\"readOnly\":{\"type\":\"boolean\",\"description\":\"Flag indicating whether the mount is read-only.\"}},\"additionalProperties\":false}},\"bindMounts\":{\"type\":\"array\",\"description\":\"A list of bind mounts associated with this resource when deployed.\",\"items\":{\"type\":\"object\",\"required\":[\"source\",\"target\",\"readOnly\"],\"properties\":{\"source\":{\"type\":\"string\",\"description\":\"The source path on the host which is mounted into the container.\"},\"target\":{\"type\":\"string\",\"description\":\"The target within the container where the volume is mounted.\"},\"readOnly\":{\"type\":\"boolean\",\"description\":\"Flag indicating whether the mount is read-only.\"}},\"additionalProperties\":false}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aspire-8.0\". Here are the required top‑level fields: resources. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/aspire-8.0.json","type":"object","description":"Defines the .NET Aspire 8.0 deployment manifest JSON schema.","required":["resources"],"properties":{"resources":{"type":"object","description":"Contains the set of resources deployable as part of this manifest. Each property is a distinct resource.","additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string"}},"oneOf":[{"type":"object","description":"A resource that represents a Dockerfile that will be built into a container during deployment.","required":["type","path","context"],"properties":{"type":{"const":"dockerfile.v0"},"path":{"type":"string","description":"The file path to the Dockerfile to be built into a container image."},"context":{"type":"string","description":"A directory path used as the context for building the Dockerfile into a container image."},"env":{"$ref":"#/definitions/env"},"bindings":{"$ref":"#/definitions/bindings"},"buildArgs":{"$ref":"#/definitions/buildArgs"}},"additionalProperties":false},{"type":"object","description":"A generic container resource.","required":["type","image"],"properties":{"type":{"const":"container.v0"},"image":{"type":"string","description":"A string representing the container image to be used."},"entrypoint":{"type":"string","description":"The entrypoint to use for the container image when executed."},"args":{"$ref":"#/definitions/args"},"connectionString":{"$ref":"#/definitions/connectionString"},"env":{"$ref":"#/definitions/env"},"bindings":{"$ref":"#/definitions/bindings"},"bindMounts":{"$ref":"#/definitions/bindMounts"},"volumes":{"$ref":"#/definitions/volumes"},"build":false},"additionalProperties":false},{"type":"object","description":"A generic container resource.","oneOf":[{"required":["type","build"]},{"required":["type","image"]}],"properties":{"type":{"const":"container.v1"},"image":{"type":"string","description":"A string representing the container image to be used."},"entrypoint":{"type":"string","description":"The entrypoint to use for the container image when executed."},"deployment":{"oneOf":[{"$ref":"#/definitions/resource.azure.bicep.v0"},{"$ref":"#/definitions/resource.azure.bicep.v1"}]},"args":{"$ref":"#/definitions/args"},"build":{"$ref":"#/definitions/build"},"connectionString":{"$ref":"#/definitions/connectionString"},"env":{"$ref":"#/definitions/env"},"bindings":{"$ref":"#/definitions/bindings"},"bindMounts":{"$ref":"#/definitions/bindMounts"},"volumes":{"$ref":"#/definitions/volumes"}},"additionalProperties":false},{"type":"object","description":"Represents a .NET project resource.","required":["type","path"],"properties":{"type":{"const":"project.v0"},"path":{"type":"string","description":"The path to the project file. Relative paths are interpreted as being relative to the location of the manifest file."},"args":{"$ref":"#/definitions/args"},"env":{"$ref":"#/definitions/env"},"bindings":{"$ref":"#/definitions/bindings"}},"additionalProperties":false},{"type":"object","description":"Represents a .NET project resource.","required":["type","path"],"properties":{"type":{"const":"project.v1"},"path":{"type":"string","description":"The path to the project file. Relative paths are interpreted as being relative to the location of the manifest file."},"deployment":{"oneOf":[{"$ref":"#/definitions/resource.azure.bicep.v0"},{"$ref":"#/definitions/resource.azure.bicep.v1"}]},"args":{"$ref":"#/definitions/args"},"env":{"$ref":"#/definitions/env"},"bindings":{"$ref":"#/definitions/bindings"}},"additionalProperties":false},{"type":"object","description":"Represents an executable resource.","required":["type","command","workingDirectory"],"properties":{"type":{"const":"executable.v0"},"workingDirectory":{"type":"string","description":"The path to the working directory. Should be interpreted as being relative to the AppHost directory."},"command":{"type":"string","description":"The path to the command. Should be interpreted as being relative to the AppHost directory."},"args":{"$ref":"#/definitions/args"},"env":{"$ref":"#/definitions/env"},"bindings":{"$ref":"#/definitions/bindings"}},"additionalProperties":false},{"type":"object","required":["connectionString"],"description":"Represents a value resource. Typically used to perform string concatenation (e.g. for connection strings).","properties":{"type":{"const":"value.v0"},"connectionString":{"$ref":"#/definitions/connectionString"}},"additionalProperties":false},{"type":"object","description":"Represents a parameter resource. Parameter resources are used to represent external configuration values that should be provided at deployment time.","required":["value","inputs"],"properties":{"type":{"const":"parameter.v0"},"value":{"$ref":"#/definitions/value"},"connectionString":{"$ref":"#/definitions/connectionString"},"inputs":{"type":"object","description":"Defines a set of input values which need to be either generated or prompted by the deployment tool. This is typically used for environment specific configuration values or secrets.","additionalProperties":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the value to be prompted or generated. Currently only 'string'' is supported.","enum":["string"]},"secret":{"type":"boolean","description":"Flag indicating whether the value should be treated as a secret. Deployment tools should note this value to take appropriate precautions when prompting, storing, and transmitting this value."},"default":{"type":"object","oneOf":[{"required":["generate"],"properties":{"generate":{"type":"object","required":["minLength"],"properties":{"minLength":{"type":"number","description":"The minimum length of the generated value."},"lower":{"type":"boolean","description":"Indicates whether lower case characters are allowed in the generated value."},"upper":{"type":"boolean","description":"Indicates whether upper case characters are allowed in the generated value."},"numeric":{"type":"boolean","description":"Indicates whether numeric characters are allowed in the generated value."},"special":{"type":"boolean","description":"Indicates whether special characters are allowed in the generated value."},"minLower":{"type":"number","description":"Specifies the minimum number of lower case characters that must appear in the generated value."},"minUpper":{"type":"number","description":"Specifies the minimum number of upper case characters that must appear in the generated value."},"minNumeric":{"type":"number","description":"Specifies the minimum number of numeric characters that must appear in the generated value."},"minSpecial":{"type":"number","description":"Specifies the minimum number of special characters that must appear in the generated value."}}},"additionalProperties":false}},{"required":["value"],"properties":{"value":{"type":"string","description":"The default value to use if the parameter is not provided at deployment time."}}}]}},"additionalProperties":false}}},"additionalProperties":false},{"type":"object","description":"Represents a Dapr resource in the manifest.","required":["dapr"],"properties":{"type":{"const":"dapr.v0"},"dapr":{"type":"object","description":"Dapr specific configuration.","required":["application","appId","components"],"properties":{"application":{"type":"string"},"appId":{"type":"string"},"components":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},{"type":"object","required":["daprComponent"],"properties":{"type":{"const":"dapr.component.v0"},"daprComponent":{"type":"object","properties":{"type":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},{"$ref":"#/definitions/resource.azure.bicep.v0"},{"$ref":"#/definitions/resource.azure.bicep.v1"},{"type":"object","required":["type","stack-name"],"properties":{"type":{"const":"aws.cloudformation.stack.v0"},"stack-name":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"target-resource":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},{"type":"object","required":["type","stack-name","template-path"],"properties":{"type":{"const":"aws.cloudformation.template.v0"},"stack-name":{"type":"string"},"template-path":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"target-resource":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false},{"type":"object","description":"Represents extensions. Any object with a 'type' field that is not captured above will pass.","required":["type"],"not":{"properties":{"type":{"type":"string","enum":["parameter.v0","container.v0","container.v1","dockerfile.v0","project.v0","project.v1","value.v0","executable.v0","azure.bicep.v0","azure.bicep.v1","aws.cloudformation.template.v0","aws.cloudformation.stack.v0","dapr.component.v0","dapr.v0"]}}},"properties":{"type":{"type":"string"}}}]}}},"definitions":{"resource.azure.bicep.v0":{"type":"object","description":"Represents a resource that is deployed using Azure Bicep.","required":["path"],"properties":{"type":{"const":"azure.bicep.v0"},"path":{"type":"string","description":"Path to the Bicep file to be used for deployment."},"connectionString":{"$ref":"#/definitions/connectionString"},"params":{"type":"object","description":"A list of parameters which are passed to Azure deployment.","additionalProperties":{"oneOf":[{"type":"array"},{"type":"boolean"},{"type":"number"},{"type":"object"},{"type":"string"}]}}},"additionalProperties":false},"resource.azure.bicep.v1":{"allOf":[{"$ref":"#/definitions/resource.azure.bicep.v0"},{"type":"object","properties":{"type":{"const":"azure.bicep.v1"},"scope":{"type":"object","properties":{"resourceGroup":{"type":"string","description":"The name of the resource group to deploy the resource to."}}}}}]},"connectionString":{"type":"string","description":"A connection string that can be used to connect to this resource."},"value":{"type":"string","description":"A value that can be referenced via an expression in the manifest"},"args":{"type":"array","description":"List of arguments to used when launched.","items":{"type":"string"}},"build":{"type":"object","description":"An object that captures properties that control the building of a container image.","required":["context","dockerfile"],"properties":{"context":{"type":"string","description":"The path to the context directory for the container build. Can be relative of absolute. If relative it is relative to the location of the manifest file."},"dockerfile":{"type":"string","description":"The path to the Dockerfile. Can be relative or absolute. If relative it is relative to the manifest file."},"args":{"type":"object","description":"A list of build arguments which are used during container build.","additionalProperties":{"type":"string"}},"secrets":{"type":"object","description":"A list of build arguments which are used during container build.","additionalProperties":{"type":"object","required":["type"],"oneOf":[{"required":["type","value"],"properties":{"type":{"type":"string","const":"env"},"value":{"type":"string","description":"If provided use as the value for the environment variable when docker build is run."}}},{"required":["type","source"],"properties":{"type":{"type":"string","const":"file"},"source":{"type":"string","description":"Path to secret file. If relative, the path is relative to the manifest file."}}}]}}},"additionalProperties":false},"buildArgs":{"type":"object","description":"A list of build arguments which are used during container build (for dockerfile.v0 resource type).","additionalProperties":{"type":"string"}},"bindings":{"type":"object","description":"A list of port bindings for the resource when it is deployed.","additionalProperties":{"type":"object","required":["scheme","protocol","transport"],"properties":{"scheme":{"type":"string","description":"The scheme used in URIs for this binding.","enum":["http","https","tcp","udp"]},"protocol":{"type":"string","description":"The protocol used for this binding (only 'tcp' or 'udp' are valid).","enum":["tcp","udp"]},"transport":{"type":"string","description":"Additional information describing the transport (e.g. HTTP/2).","enum":["http","http2","tcp"]},"external":{"type":"boolean","description":"A flag indicating whether this binding is exposed externally when deployed."},"targetPort":{"type":"number","description":"The port that the workload (e.g. container) is listening on."},"port":{"type":"number","description":"The port that the workload (e.g. container) is exposed as to other resources and externally."}},"additionalProperties":false}},"env":{"type":"object","description":"A list of environment variables which are inserted into the resource at runtime.","additionalProperties":{"type":"string"}},"volumes":{"type":"array","description":"A list of volumes associated with this resource when deployed.","items":{"type":"object","required":["name","target","readOnly"],"properties":{"name":{"type":"string","description":"The name of the volume."},"target":{"type":"string","description":"The target within the container where the volume is mounted."},"readOnly":{"type":"boolean","description":"Flag indicating whether the mount is read-only."}},"additionalProperties":false}},"bindMounts":{"type":"array","description":"A list of bind mounts associated with this resource when deployed.","items":{"type":"object","required":["source","target","readOnly"],"properties":{"source":{"type":"string","description":"The source path on the host which is mounted into the container."},"target":{"type":"string","description":"The target within the container where the volume is mounted."},"readOnly":{"type":"boolean","description":"Flag indicating whether the mount is read-only."}},"additionalProperties":false}}}}
|
Provide a JSON object that satisfies the schema "aspire-8.0". Here are the required top‑level fields: resources. Return only the valid JSON object.
|
aspire-8.0
|
schema-store
|
schema_store_65
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/assetlinks.json\",\"$defs\":{\"android_app\":{\"description\":\"The target asset belong to an android application\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"namespace\",\"package_name\",\"sha256_cert_fingerprints\"],\"properties\":{\"namespace\":{\"description\":\"Must be android_app for Android apps\",\"type\":\"string\",\"const\":\"android_app\"},\"package_name\":{\"description\":\"Android application's package name\",\"type\":\"string\",\"pattern\":\"^([A-Za-z]{1}[A-Za-z\\\\d_]*\\\\.)+[A-Za-z][A-Za-z\\\\d_]*$\"},\"sha256_cert_fingerprints\":{\"description\":\"SHA256s from keystore\",\"type\":\"array\",\"uniqueItems\":true,\"minItems\":1,\"items\":{\"type\":\"string\",\"pattern\":\"^(?:[A-F0-9]{2}:){31}[A-F0-9]{2}$\"}}}},\"web\":{\"description\":\"The target asset belong to a web application\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"namespace\",\"site\"],\"properties\":{\"namespace\":{\"description\":\"Must be web for websites\",\"type\":\"string\",\"const\":\"web\"},\"site\":{\"description\":\"Website's uri that following the format http[s]://<hostname>[:<port>]\",\"type\":\"string\"}}},\"relation\":{\"description\":\"Describe the relation being declared about the target\",\"type\":\"array\",\"minItems\":1,\"items\":{\"oneOf\":[{\"const\":\"delegate_permission/common.handle_all_urls\",\"description\":\"Grants the target permission to handle all URLs that the source can handle\"},{\"const\":\"delegate_permission/common.get_login_creds\",\"description\":\"Grants the target permission to retrieve sign-in credentials stored for the source\"}]}}},\"title\":\"Google Digital Assetlinks\",\"description\":\"Google Digital Assetlinks Schema\",\"type\":\"array\",\"items\":{\"title\":\"Statement list\",\"description\":\"Website or app statements as JSON objects\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"relation\":{\"$ref\":\"#/$defs/relation\"},\"target\":{\"description\":\"The target asset to whom this statement applies\",\"type\":\"object\",\"oneOf\":[{\"$ref\":\"#/$defs/android_app\"},{\"$ref\":\"#/$defs/web\"}]}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Google Digital Assetlinks\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/assetlinks.json","$defs":{"android_app":{"description":"The target asset belong to an android application","type":"object","additionalProperties":false,"required":["namespace","package_name","sha256_cert_fingerprints"],"properties":{"namespace":{"description":"Must be android_app for Android apps","type":"string","const":"android_app"},"package_name":{"description":"Android application's package name","type":"string","pattern":"^([A-Za-z]{1}[A-Za-z\\d_]*\\.)+[A-Za-z][A-Za-z\\d_]*$"},"sha256_cert_fingerprints":{"description":"SHA256s from keystore","type":"array","uniqueItems":true,"minItems":1,"items":{"type":"string","pattern":"^(?:[A-F0-9]{2}:){31}[A-F0-9]{2}$"}}}},"web":{"description":"The target asset belong to a web application","type":"object","additionalProperties":false,"required":["namespace","site"],"properties":{"namespace":{"description":"Must be web for websites","type":"string","const":"web"},"site":{"description":"Website's uri that following the format http[s]://<hostname>[:<port>]","type":"string"}}},"relation":{"description":"Describe the relation being declared about the target","type":"array","minItems":1,"items":{"oneOf":[{"const":"delegate_permission/common.handle_all_urls","description":"Grants the target permission to handle all URLs that the source can handle"},{"const":"delegate_permission/common.get_login_creds","description":"Grants the target permission to retrieve sign-in credentials stored for the source"}]}}},"title":"Google Digital Assetlinks","description":"Google Digital Assetlinks Schema","type":"array","items":{"title":"Statement list","description":"Website or app statements as JSON objects","type":"object","additionalProperties":false,"properties":{"relation":{"$ref":"#/$defs/relation"},"target":{"description":"The target asset to whom this statement applies","type":"object","oneOf":[{"$ref":"#/$defs/android_app"},{"$ref":"#/$defs/web"}]}}}}
|
Provide a JSON object that satisfies the schema "Google Digital Assetlinks". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Google Digital Assetlinks
|
schema-store
|
schema_store_66
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://json.schemastore.org/atmos-manifest.json\",\"title\":\"JSON Schema for Atmos Stack Manifest files. Version 1.0. https://atmos.tools\",\"type\":\"object\",\"properties\":{\"import\":{\"$ref\":\"#/definitions/import\"},\"terraform\":{\"$ref\":\"#/definitions/terraform\"},\"helmfile\":{\"$ref\":\"#/definitions/helmfile\"},\"vars\":{\"$ref\":\"#/definitions/vars\"},\"hooks\":{\"$ref\":\"#/definitions/hooks\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/settings\"},\"components\":{\"$ref\":\"#/definitions/components\"},\"overrides\":{\"$ref\":\"#/definitions/overrides\"},\"workflows\":{\"$ref\":\"#/definitions/workflows\"}},\"additionalProperties\":true,\"oneOf\":[{\"required\":[\"workflows\"]},{\"anyOf\":[{\"additionalProperties\":true,\"not\":{\"required\":[\"workflows\"]}},{\"required\":[\"import\"]},{\"required\":[\"terraform\"]},{\"required\":[\"helmfile\"]},{\"required\":[\"vars\"]},{\"required\":[\"hooks\"]},{\"required\":[\"env\"]},{\"required\":[\"settings\"]},{\"required\":[\"components\"]},{\"required\":[\"overrides\"]}]}],\"definitions\":{\"import\":{\"title\":\"import\",\"description\":\"Import section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"path\":{\"type\":\"string\"},\"skip_templates_processing\":{\"type\":\"boolean\"},\"ignore_missing_template_values\":{\"type\":\"boolean\"},\"skip_if_missing\":{\"type\":\"boolean\"},\"context\":{\"type\":\"object\",\"additionalProperties\":true}},\"required\":[\"path\"]}]}}]},\"components\":{\"title\":\"components\",\"description\":\"Components section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"terraform\":{\"$ref\":\"#/definitions/terraform_components\"},\"helmfile\":{\"$ref\":\"#/definitions/helmfile_components\"}},\"required\":[]}]},\"terraform\":{\"title\":\"terraform\",\"description\":\"Terraform section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"vars\":{\"$ref\":\"#/definitions/vars\"},\"hooks\":{\"$ref\":\"#/definitions/hooks\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/settings\"},\"command\":{\"$ref\":\"#/definitions/command\"},\"backend_type\":{\"$ref\":\"#/definitions/backend_type\"},\"backend\":{\"$ref\":\"#/definitions/backend\"},\"remote_state_backend_type\":{\"$ref\":\"#/definitions/remote_state_backend_type\"},\"remote_state_backend\":{\"$ref\":\"#/definitions/remote_state_backend\"},\"overrides\":{\"$ref\":\"#/definitions/overrides\"},\"providers\":{\"$ref\":\"#/definitions/providers\"}},\"required\":[]}]},\"terraform_components\":{\"title\":\"terraform_components\",\"description\":\"Terraform components section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"patternProperties\":{\"^[/a-zA-Z0-9-_{}. ]+$\":{\"$ref\":\"#/definitions/terraform_component_manifest\"}},\"additionalProperties\":false}]},\"terraform_component_manifest\":{\"title\":\"terraform_component_manifest\",\"description\":\"Terraform component manifest\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"metadata\":{\"$ref\":\"#/definitions/metadata\"},\"component\":{\"$ref\":\"#/definitions/component\"},\"vars\":{\"$ref\":\"#/definitions/vars\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/settings\"},\"command\":{\"$ref\":\"#/definitions/command\"},\"backend_type\":{\"$ref\":\"#/definitions/backend_type\"},\"backend\":{\"$ref\":\"#/definitions/backend\"},\"remote_state_backend_type\":{\"$ref\":\"#/definitions/remote_state_backend_type\"},\"remote_state_backend\":{\"$ref\":\"#/definitions/remote_state_backend\"},\"providers\":{\"$ref\":\"#/definitions/providers\"},\"hooks\":{\"$ref\":\"#/definitions/hooks\"}},\"required\":[]}]},\"helmfile\":{\"title\":\"helmfile\",\"description\":\"Helmfile section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"vars\":{\"$ref\":\"#/definitions/vars\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/settings\"},\"command\":{\"$ref\":\"#/definitions/command\"},\"overrides\":{\"$ref\":\"#/definitions/overrides\"}},\"required\":[]}]},\"helmfile_components\":{\"title\":\"helmfile_components\",\"description\":\"Helmfile components section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"patternProperties\":{\"^[/a-zA-Z0-9-_{}. ]+$\":{\"$ref\":\"#/definitions/helmfile_component_manifest\"}},\"additionalProperties\":false}]},\"helmfile_component_manifest\":{\"title\":\"helmfile_component_manifest\",\"description\":\"Helmfile component manifest\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"metadata\":{\"$ref\":\"#/definitions/metadata\"},\"component\":{\"$ref\":\"#/definitions/component\"},\"vars\":{\"$ref\":\"#/definitions/vars\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/settings\"},\"command\":{\"$ref\":\"#/definitions/command\"}},\"required\":[]}]},\"command\":{\"title\":\"command\",\"description\":\"Command to execute\",\"type\":\"string\"},\"component\":{\"title\":\"component\",\"description\":\"Component section\",\"type\":\"string\"},\"metadata\":{\"title\":\"metadata\",\"description\":\"Metadata section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"abstract\",\"real\"]},\"enabled\":{\"type\":\"boolean\",\"description\":\"Flag to enable or disable the component\"},\"component\":{\"type\":\"string\",\"description\":\"Terraform/OpenTofu/Helmfile component\"},\"inherits\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"array\",\"description\":\"A list of Atmos components that the current component inherits from\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}}]},\"terraform_workspace\":{\"type\":\"string\",\"description\":\"Terraform workspace\"},\"terraform_workspace_pattern\":{\"type\":\"string\",\"description\":\"Terraform workspace pattern\"},\"custom\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"description\":\"Custom configuration per component, not inherited by derived components\",\"additionalProperties\":true,\"title\":\"custom\"}]},\"locked\":{\"type\":\"boolean\",\"description\":\"Flag to lock the component and prevent modifications while allowing read operations\"}},\"required\":[]}]},\"settings\":{\"title\":\"settings\",\"description\":\"Settings section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"validation\":{\"$ref\":\"#/definitions/validation\"},\"depends_on\":{\"$ref\":\"#/definitions/depends_on\"},\"spacelift\":{\"$ref\":\"#/definitions/spacelift\"},\"atlantis\":{\"$ref\":\"#/definitions/atlantis\"},\"templates\":{\"$ref\":\"#/definitions/templates\"}},\"required\":[]}]},\"validation\":{\"title\":\"validation\",\"description\":\"Validation section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"patternProperties\":{\"^[/a-zA-Z0-9-_{}. ]+$\":{\"$ref\":\"#/definitions/validation_manifest\"}},\"additionalProperties\":false}]},\"validation_manifest\":{\"title\":\"validation_manifest\",\"description\":\"Validation manifest\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"properties\":{\"schema_type\":{\"type\":\"string\",\"enum\":[\"jsonschema\",\"opa\"]},\"schema_path\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"disabled\":{\"type\":\"boolean\"},\"timeout\":{\"type\":\"integer\",\"minimum\":0},\"module_paths\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"},\"description\":\"List of paths to validation modules\"}},\"additionalProperties\":false,\"required\":[\"schema_type\",\"schema_path\"]}]},\"vars\":{\"title\":\"vars\",\"description\":\"Vars section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"env\":{\"title\":\"env\",\"description\":\"Env section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"backend_type\":{\"title\":\"backend_type\",\"description\":\"Backend type\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"string\",\"enum\":[\"local\",\"s3\",\"remote\",\"vault\",\"static\",\"azurerm\",\"gcs\",\"cloud\"]}]},\"backend\":{\"title\":\"backend\",\"description\":\"Backend section\",\"$ref\":\"#/definitions/backend_manifest\"},\"remote_state_backend_type\":{\"title\":\"remote_state_backend_type\",\"description\":\"Remote state backend type\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"string\",\"enum\":[\"local\",\"s3\",\"remote\",\"vault\",\"static\",\"azurerm\",\"gcs\",\"cloud\"]}]},\"remote_state_backend\":{\"title\":\"remote_state_backend\",\"description\":\"Remote state backend section\",\"$ref\":\"#/definitions/backend_manifest\"},\"backend_manifest\":{\"title\":\"backend\",\"description\":\"Backend manifest\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"local\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"s3\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"remote\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"vault\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"static\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"azurerm\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"gcs\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"cloud\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]}},\"required\":[]}]},\"overrides\":{\"title\":\"overrides\",\"description\":\"Overrides section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"command\":{\"$ref\":\"#/definitions/command\"},\"vars\":{\"$ref\":\"#/definitions/vars\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/settings\"},\"providers\":{\"$ref\":\"#/definitions/providers\"}},\"required\":[]}]},\"depends_on\":{\"title\":\"depends_on\",\"description\":\"Depends_on section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"patternProperties\":{\"^[/a-zA-Z0-9-_{}. ]+$\":{\"$ref\":\"#/definitions/depends_on_manifest\"}},\"additionalProperties\":false}]},\"depends_on_manifest\":{\"title\":\"depends_on_manifest\",\"description\":\"Depends_on manifest\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"properties\":{\"namespace\":{\"type\":\"string\"},\"tenant\":{\"type\":\"string\"},\"environment\":{\"type\":\"string\"},\"stage\":{\"type\":\"string\"},\"component\":{\"type\":\"string\"},\"file\":{\"type\":\"string\"},\"folder\":{\"type\":\"string\"}},\"oneOf\":[{\"required\":[\"component\"]},{\"required\":[\"file\"]},{\"required\":[\"folder\"]}],\"additionalProperties\":false}]},\"spacelift\":{\"title\":\"spacelift\",\"description\":\"Spacelift section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true,\"properties\":{\"workspace_enabled\":{\"type\":\"boolean\"},\"stack_destructor_enabled\":{\"type\":\"boolean\"},\"protect_from_deletion\":{\"type\":\"boolean\"},\"autodeploy\":{\"type\":\"boolean\"},\"terraform_version\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"string\"}]}},\"required\":[]}]},\"atlantis\":{\"title\":\"atlantis\",\"description\":\"Atlantis section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"config_template_name\":{\"type\":\"string\"},\"config_template\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"project_template_name\":{\"type\":\"string\"},\"project_template\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"workflow_templates\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]}},\"required\":[]}]},\"workflows\":{\"title\":\"workflows\",\"description\":\"Workflows section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"}},\"patternProperties\":{\"^[/a-zA-Z0-9-_{}. ]+$\":{\"$ref\":\"#/definitions/workflow_manifest\"}},\"additionalProperties\":false}]},\"workflow_manifest\":{\"title\":\"workflow_manifest\",\"description\":\"Workflow manifest\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"description\":{\"type\":\"string\"},\"stack\":{\"type\":\"string\"},\"steps\":{\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"command\":{\"type\":\"string\"},\"stack\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"}},\"required\":[\"command\"]}}]}},\"required\":[\"steps\"]}]},\"providers\":{\"title\":\"providers\",\"description\":\"Providers section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"templates\":{\"title\":\"templates\",\"description\":\"Templates section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]},\"hooks\":{\"title\":\"hooks\",\"description\":\"Hooks section\",\"oneOf\":[{\"type\":\"string\",\"pattern\":\"^!include\"},{\"type\":\"object\",\"additionalProperties\":true}]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Atmos Stack Manifest files. Version 1.0. https://atmos.tools\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://json.schemastore.org/atmos-manifest.json","title":"JSON Schema for Atmos Stack Manifest files. Version 1.0. https://atmos.tools","type":"object","properties":{"import":{"$ref":"#/definitions/import"},"terraform":{"$ref":"#/definitions/terraform"},"helmfile":{"$ref":"#/definitions/helmfile"},"vars":{"$ref":"#/definitions/vars"},"hooks":{"$ref":"#/definitions/hooks"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/settings"},"components":{"$ref":"#/definitions/components"},"overrides":{"$ref":"#/definitions/overrides"},"workflows":{"$ref":"#/definitions/workflows"}},"additionalProperties":true,"oneOf":[{"required":["workflows"]},{"anyOf":[{"additionalProperties":true,"not":{"required":["workflows"]}},{"required":["import"]},{"required":["terraform"]},{"required":["helmfile"]},{"required":["vars"]},{"required":["hooks"]},{"required":["env"]},{"required":["settings"]},{"required":["components"]},{"required":["overrides"]}]}],"definitions":{"import":{"title":"import","description":"Import section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":false,"properties":{"path":{"type":"string"},"skip_templates_processing":{"type":"boolean"},"ignore_missing_template_values":{"type":"boolean"},"skip_if_missing":{"type":"boolean"},"context":{"type":"object","additionalProperties":true}},"required":["path"]}]}}]},"components":{"title":"components","description":"Components section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"terraform":{"$ref":"#/definitions/terraform_components"},"helmfile":{"$ref":"#/definitions/helmfile_components"}},"required":[]}]},"terraform":{"title":"terraform","description":"Terraform section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"vars":{"$ref":"#/definitions/vars"},"hooks":{"$ref":"#/definitions/hooks"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/settings"},"command":{"$ref":"#/definitions/command"},"backend_type":{"$ref":"#/definitions/backend_type"},"backend":{"$ref":"#/definitions/backend"},"remote_state_backend_type":{"$ref":"#/definitions/remote_state_backend_type"},"remote_state_backend":{"$ref":"#/definitions/remote_state_backend"},"overrides":{"$ref":"#/definitions/overrides"},"providers":{"$ref":"#/definitions/providers"}},"required":[]}]},"terraform_components":{"title":"terraform_components","description":"Terraform components section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","patternProperties":{"^[/a-zA-Z0-9-_{}. ]+$":{"$ref":"#/definitions/terraform_component_manifest"}},"additionalProperties":false}]},"terraform_component_manifest":{"title":"terraform_component_manifest","description":"Terraform component manifest","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"metadata":{"$ref":"#/definitions/metadata"},"component":{"$ref":"#/definitions/component"},"vars":{"$ref":"#/definitions/vars"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/settings"},"command":{"$ref":"#/definitions/command"},"backend_type":{"$ref":"#/definitions/backend_type"},"backend":{"$ref":"#/definitions/backend"},"remote_state_backend_type":{"$ref":"#/definitions/remote_state_backend_type"},"remote_state_backend":{"$ref":"#/definitions/remote_state_backend"},"providers":{"$ref":"#/definitions/providers"},"hooks":{"$ref":"#/definitions/hooks"}},"required":[]}]},"helmfile":{"title":"helmfile","description":"Helmfile section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"vars":{"$ref":"#/definitions/vars"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/settings"},"command":{"$ref":"#/definitions/command"},"overrides":{"$ref":"#/definitions/overrides"}},"required":[]}]},"helmfile_components":{"title":"helmfile_components","description":"Helmfile components section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","patternProperties":{"^[/a-zA-Z0-9-_{}. ]+$":{"$ref":"#/definitions/helmfile_component_manifest"}},"additionalProperties":false}]},"helmfile_component_manifest":{"title":"helmfile_component_manifest","description":"Helmfile component manifest","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"metadata":{"$ref":"#/definitions/metadata"},"component":{"$ref":"#/definitions/component"},"vars":{"$ref":"#/definitions/vars"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/settings"},"command":{"$ref":"#/definitions/command"}},"required":[]}]},"command":{"title":"command","description":"Command to execute","type":"string"},"component":{"title":"component","description":"Component section","type":"string"},"metadata":{"title":"metadata","description":"Metadata section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["abstract","real"]},"enabled":{"type":"boolean","description":"Flag to enable or disable the component"},"component":{"type":"string","description":"Terraform/OpenTofu/Helmfile component"},"inherits":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"array","description":"A list of Atmos components that the current component inherits from","uniqueItems":true,"items":{"type":"string"}}]},"terraform_workspace":{"type":"string","description":"Terraform workspace"},"terraform_workspace_pattern":{"type":"string","description":"Terraform workspace pattern"},"custom":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","description":"Custom configuration per component, not inherited by derived components","additionalProperties":true,"title":"custom"}]},"locked":{"type":"boolean","description":"Flag to lock the component and prevent modifications while allowing read operations"}},"required":[]}]},"settings":{"title":"settings","description":"Settings section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true,"properties":{"validation":{"$ref":"#/definitions/validation"},"depends_on":{"$ref":"#/definitions/depends_on"},"spacelift":{"$ref":"#/definitions/spacelift"},"atlantis":{"$ref":"#/definitions/atlantis"},"templates":{"$ref":"#/definitions/templates"}},"required":[]}]},"validation":{"title":"validation","description":"Validation section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","patternProperties":{"^[/a-zA-Z0-9-_{}. ]+$":{"$ref":"#/definitions/validation_manifest"}},"additionalProperties":false}]},"validation_manifest":{"title":"validation_manifest","description":"Validation manifest","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","properties":{"schema_type":{"type":"string","enum":["jsonschema","opa"]},"schema_path":{"type":"string"},"description":{"type":"string"},"disabled":{"type":"boolean"},"timeout":{"type":"integer","minimum":0},"module_paths":{"type":"array","uniqueItems":true,"items":{"type":"string"},"description":"List of paths to validation modules"}},"additionalProperties":false,"required":["schema_type","schema_path"]}]},"vars":{"title":"vars","description":"Vars section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"env":{"title":"env","description":"Env section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"backend_type":{"title":"backend_type","description":"Backend type","oneOf":[{"type":"string","pattern":"^!include"},{"type":"string","enum":["local","s3","remote","vault","static","azurerm","gcs","cloud"]}]},"backend":{"title":"backend","description":"Backend section","$ref":"#/definitions/backend_manifest"},"remote_state_backend_type":{"title":"remote_state_backend_type","description":"Remote state backend type","oneOf":[{"type":"string","pattern":"^!include"},{"type":"string","enum":["local","s3","remote","vault","static","azurerm","gcs","cloud"]}]},"remote_state_backend":{"title":"remote_state_backend","description":"Remote state backend section","$ref":"#/definitions/backend_manifest"},"backend_manifest":{"title":"backend","description":"Backend manifest","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"local":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"s3":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"remote":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"vault":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"static":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"azurerm":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"gcs":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"cloud":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]}},"required":[]}]},"overrides":{"title":"overrides","description":"Overrides section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"command":{"$ref":"#/definitions/command"},"vars":{"$ref":"#/definitions/vars"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/settings"},"providers":{"$ref":"#/definitions/providers"}},"required":[]}]},"depends_on":{"title":"depends_on","description":"Depends_on section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","patternProperties":{"^[/a-zA-Z0-9-_{}. ]+$":{"$ref":"#/definitions/depends_on_manifest"}},"additionalProperties":false}]},"depends_on_manifest":{"title":"depends_on_manifest","description":"Depends_on manifest","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","properties":{"namespace":{"type":"string"},"tenant":{"type":"string"},"environment":{"type":"string"},"stage":{"type":"string"},"component":{"type":"string"},"file":{"type":"string"},"folder":{"type":"string"}},"oneOf":[{"required":["component"]},{"required":["file"]},{"required":["folder"]}],"additionalProperties":false}]},"spacelift":{"title":"spacelift","description":"Spacelift section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true,"properties":{"workspace_enabled":{"type":"boolean"},"stack_destructor_enabled":{"type":"boolean"},"protect_from_deletion":{"type":"boolean"},"autodeploy":{"type":"boolean"},"terraform_version":{"anyOf":[{"type":"number"},{"type":"string"}]}},"required":[]}]},"atlantis":{"title":"atlantis","description":"Atlantis section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"config_template_name":{"type":"string"},"config_template":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"project_template_name":{"type":"string"},"project_template":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"workflow_templates":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]}},"required":[]}]},"workflows":{"title":"workflows","description":"Workflows section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"patternProperties":{"^[/a-zA-Z0-9-_{}. ]+$":{"$ref":"#/definitions/workflow_manifest"}},"additionalProperties":false}]},"workflow_manifest":{"title":"workflow_manifest","description":"Workflow manifest","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"stack":{"type":"string"},"steps":{"oneOf":[{"type":"string","pattern":"^!include"},{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"command":{"type":"string"},"stack":{"type":"string"},"type":{"type":"string"}},"required":["command"]}}]}},"required":["steps"]}]},"providers":{"title":"providers","description":"Providers section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"templates":{"title":"templates","description":"Templates section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]},"hooks":{"title":"hooks","description":"Hooks section","oneOf":[{"type":"string","pattern":"^!include"},{"type":"object","additionalProperties":true}]}}}
|
Provide a JSON object that satisfies the schema "JSON Schema for Atmos Stack Manifest files. Version 1.0. https://atmos.tools". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON Schema for Atmos Stack Manifest files. Version 1.0. https://atmos.tools
|
schema-store
|
schema_store_67
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/aurora-1.1.json\",\"$comment\":\"https://docs.aurorajs.dev/\",\"additionalProperties\":false,\"definitions\":{\"property\":{\"type\":\"object\",\"required\":[\"name\",\"type\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The name of property, in camelCase\",\"minLength\":2},\"type\":{\"type\":\"string\",\"description\":\"The type of property\",\"enum\":[\"array\",\"bigint\",\"blob.long\",\"blob.medium\",\"blob.tiny\",\"blob\",\"boolean\",\"char\",\"date\",\"decimal\",\"enum\",\"float\",\"id\",\"int\",\"json\",\"jsonb\",\"manyToMany\",\"password\",\"relationship\",\"smallint\",\"text\",\"timestamp\",\"varchar\"]},\"arrayOptions\":{\"type\":\"object\",\"description\":\"Options to define array property\",\"required\":[\"type\"],\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of property\",\"enum\":[\"char\",\"date\",\"decimal\",\"enum\",\"id\",\"int\",\"timestamp\",\"varchar\"]},\"length\":{\"type\":\"number\",\"description\":\"Set max length to property\",\"minimum\":1},\"maxLength\":{\"type\":\"number\",\"description\":\"Set max length to property\",\"minimum\":1},\"enumOptions\":{\"type\":\"array\",\"description\":\"Values for enum type\",\"items\":{\"type\":\"string\",\"minLength\":1}}}},\"length\":{\"type\":\"number\",\"description\":\"Set max length to property\",\"minimum\":1},\"maxLength\":{\"type\":\"number\",\"description\":\"Set max length to property\",\"minimum\":1},\"nullable\":{\"type\":\"boolean\",\"description\":\"Set property to nullable\"},\"unsigned\":{\"type\":\"boolean\",\"description\":\"Set property like unsigned\"},\"primaryKey\":{\"type\":\"boolean\",\"description\":\"Set property to primary key\"},\"index\":{\"type\":\"string\",\"description\":\"To define property like a index\",\"enum\":[\"index\",\"unique\"]},\"indexFields\":{\"type\":\"array\",\"description\":\"Fields to do composite unique index\",\"items\":{\"type\":\"string\",\"minLength\":1}},\"indexName\":{\"type\":\"string\",\"description\":\"The name of index, if there are various indexes with the same name, they will be grouped\",\"minLength\":2},\"isI18n\":{\"type\":\"boolean\",\"description\":\"Set property as i18n, this property will be used to translate the entity in the translation table\"},\"enumOptions\":{\"type\":\"array\",\"description\":\"Values for enum type\",\"items\":{\"type\":\"string\",\"minLength\":1}},\"defaultValue\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"number\"},{\"type\":\"boolean\"}],\"description\":\"Default value for property\"},\"example\":{\"type\":[\"number\",\"string\",\"boolean\",\"array\"],\"description\":\"Example value for property, this value will be used in swagger documentation\"},\"decimals\":{\"type\":\"array\",\"description\":\"Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].\",\"items\":{\"type\":\"number\",\"minimum\":1}},\"autoIncrement\":{\"type\":\"boolean\",\"description\":\"Set number property as auto increment\"},\"relationship\":{\"$ref\":\"#/definitions/relationship\"},\"webComponent\":{\"$ref\":\"#/definitions/webComponent\"}}},\"apiDefinition\":{\"type\":\"object\",\"required\":[\"path\",\"resolverType\",\"httpMethod\"],\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Path to access api\",\"minLength\":2},\"resolverType\":{\"type\":\"string\",\"description\":\"Type of resolver, query or mutation\",\"enum\":[\"query\",\"mutation\"]},\"httpMethod\":{\"type\":\"string\",\"description\":\"Verb of api rest\",\"enum\":[\"get\",\"post\",\"put\",\"delete\",\"patch\"]}}},\"relationship\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Relationship definition for this property\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of web component\",\"enum\":[\"many-to-many\",\"many-to-one\",\"none\",\"one-to-many\",\"one-to-one\"]},\"singularName\":{\"type\":\"string\",\"description\":\"Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book\",\"minLength\":2},\"aggregateName\":{\"type\":\"string\",\"description\":\"Aggregate referring to this relationship, example: LibraryAuthor\",\"minLength\":2},\"modulePath\":{\"type\":\"string\",\"description\":\"Path to the module that refers to this relationship, example: library/author\",\"minLength\":2},\"key\":{\"type\":\"string\",\"description\":\"Property key that refers to this relationship, only for many-to-one relationship, example: id\",\"minLength\":2},\"field\":{\"type\":\"string\",\"description\":\"Field to obtain the relationship data, example: author\",\"minLength\":2},\"avoidConstraint\":{\"type\":\"boolean\",\"description\":\"Avoid constraint rules for this relationship\"},\"packageName\":{\"type\":\"string\",\"description\":\"Path to packageName where is the relationship, example: @aurora-ts/core\",\"minLength\":2},\"isDenormalized\":{\"type\":\"boolean\",\"description\":\"Set many-to-many relationship as denormalized, creating a field to store the selected ids\"},\"pivot\":{\"$ref\":\"#/definitions/pivotTable\"}}},\"webComponent\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Web Component that wil be rendered for this property\",\"properties\":{\"type\":{\"type\":\"string\",\"description\":\"The type of web component\",\"enum\":[\"async-search-multiple-select\",\"async-search-select\",\"grid-elements-manager\",\"grid-select-element\",\"grid-select-multiple-elements\",\"multiple-select\",\"search-multiple-select\",\"search-select\",\"select\"]},\"className\":{\"type\":\"string\",\"description\":\"CSS class for web component\",\"minLength\":2},\"detailSort\":{\"type\":\"number\",\"description\":\"Web component order on detail view\",\"minimum\":1},\"listSort\":{\"type\":\"number\",\"description\":\"Web component order on list view\",\"minimum\":1},\"isListHidden\":{\"type\":\"boolean\",\"description\":\"Set hidden web component on list view\"},\"isDetailHidden\":{\"type\":\"boolean\",\"description\":\"Set hidden web component on detail view\"}}},\"excludedOperationValues\":{\"type\":\"array\",\"items\":{\"enum\":[\"count\",\"create\",\"createBatch\",\"deleteById\",\"delete\",\"findById\",\"find\",\"get\",\"max\",\"min\",\"paginate\",\"rawSql\",\"sum\",\"updateAndIncrement\",\"updateById\",\"update\",\"upsert\"]}},\"front\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Appearance properties for front application\",\"properties\":{\"outlineFontSetIcon\":{\"type\":\"string\",\"description\":\"Font set outline icon to be used in the front application, example: material-symbols-outlined\",\"minLength\":2},\"outlineIcon\":{\"type\":\"string\",\"description\":\"Outline icon to be used in the front application, example: heroicons_solid:tag\",\"minLength\":2},\"solidFontSetIcon\":{\"type\":\"string\",\"description\":\"Font set solid icon to be used in the front application, example: material-symbols-outlined\",\"minLength\":2},\"solidIcon\":{\"type\":\"string\",\"description\":\"Solid icon to be used in the front application, example: heroicons_solid:tag\",\"minLength\":2}}},\"pivotTable\":{\"type\":\"object\",\"additionalProperties\":false,\"description\":\"Relationship pivot table definition for this relationship\",\"properties\":{\"boundedContextName\":{\"type\":\"string\",\"description\":\"The name of the package, singular in kebab-case\",\"minLength\":2},\"moduleName\":{\"type\":\"string\",\"description\":\"The name of the module, singular in kebab-case\",\"minLength\":2},\"moduleNames\":{\"type\":\"string\",\"description\":\"The name of the module, plural in kebab-case\",\"minLength\":2},\"aggregateName\":{\"type\":\"string\",\"description\":\"The name of the aggregateName, singular in PascalCase\",\"minLength\":2},\"hasOAuth\":{\"type\":\"boolean\",\"description\":\"Enabled authentication for this pivot table\",\"default\":false},\"hasAuditing\":{\"type\":\"boolean\",\"description\":\"Enabled auditing for pivot table\",\"default\":false},\"aggregateProperties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/property\"}},\"excludedFiles\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"excludedOperations\":{\"$ref\":\"#/definitions/excludedOperationValues\"}}}},\"description\":\"Make agile applications without technical debt\",\"properties\":{\"version\":{\"type\":\"string\",\"description\":\"Schema version\",\"default\":\"0.0.1\",\"minLength\":2},\"boundedContextName\":{\"type\":\"string\",\"description\":\"The name of the package, singular in kebab-case\",\"minLength\":2},\"moduleName\":{\"type\":\"string\",\"description\":\"The name of the module, singular in kebab-case\",\"minLength\":2},\"moduleNames\":{\"type\":\"string\",\"description\":\"The name of the module, plural in kebab-case\",\"minLength\":2},\"aggregateName\":{\"type\":\"string\",\"description\":\"The name of the aggregateName, singular in PascalCase\",\"minLength\":2},\"hasOAuth\":{\"type\":\"boolean\",\"description\":\"Enabled authentication for this module\",\"default\":false},\"hasTenant\":{\"type\":\"boolean\",\"description\":\"Enabled tenant for this module\",\"default\":false},\"hasAuditing\":{\"type\":\"boolean\",\"description\":\"Enabled auditing for this module\",\"default\":false},\"front\":{\"$ref\":\"#/definitions/front\"},\"aggregateProperties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/property\"}},\"additionalApis\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/apiDefinition\"}},\"excludedFiles\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"excludedOperations\":{\"$ref\":\"#/definitions/excludedOperationValues\"}},\"required\":[\"boundedContextName\",\"moduleName\",\"moduleNames\",\"aggregateName\"],\"title\":\"Aurora Agile Meta Framework\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Aurora Agile Meta Framework\". Here are the required top‑level fields: boundedContextName, moduleName, moduleNames, aggregateName. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/aurora-1.1.json","$comment":"https://docs.aurorajs.dev/","additionalProperties":false,"definitions":{"property":{"type":"object","required":["name","type"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"The name of property, in camelCase","minLength":2},"type":{"type":"string","description":"The type of property","enum":["array","bigint","blob.long","blob.medium","blob.tiny","blob","boolean","char","date","decimal","enum","float","id","int","json","jsonb","manyToMany","password","relationship","smallint","text","timestamp","varchar"]},"arrayOptions":{"type":"object","description":"Options to define array property","required":["type"],"properties":{"type":{"type":"string","description":"The type of property","enum":["char","date","decimal","enum","id","int","timestamp","varchar"]},"length":{"type":"number","description":"Set max length to property","minimum":1},"maxLength":{"type":"number","description":"Set max length to property","minimum":1},"enumOptions":{"type":"array","description":"Values for enum type","items":{"type":"string","minLength":1}}}},"length":{"type":"number","description":"Set max length to property","minimum":1},"maxLength":{"type":"number","description":"Set max length to property","minimum":1},"nullable":{"type":"boolean","description":"Set property to nullable"},"unsigned":{"type":"boolean","description":"Set property like unsigned"},"primaryKey":{"type":"boolean","description":"Set property to primary key"},"index":{"type":"string","description":"To define property like a index","enum":["index","unique"]},"indexFields":{"type":"array","description":"Fields to do composite unique index","items":{"type":"string","minLength":1}},"indexName":{"type":"string","description":"The name of index, if there are various indexes with the same name, they will be grouped","minLength":2},"isI18n":{"type":"boolean","description":"Set property as i18n, this property will be used to translate the entity in the translation table"},"enumOptions":{"type":"array","description":"Values for enum type","items":{"type":"string","minLength":1}},"defaultValue":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Default value for property"},"example":{"type":["number","string","boolean","array"],"description":"Example value for property, this value will be used in swagger documentation"},"decimals":{"type":"array","description":"Total digits of the number and length of the decimal places in the back of the number, example: [10, 2].","items":{"type":"number","minimum":1}},"autoIncrement":{"type":"boolean","description":"Set number property as auto increment"},"relationship":{"$ref":"#/definitions/relationship"},"webComponent":{"$ref":"#/definitions/webComponent"}}},"apiDefinition":{"type":"object","required":["path","resolverType","httpMethod"],"properties":{"path":{"type":"string","description":"Path to access api","minLength":2},"resolverType":{"type":"string","description":"Type of resolver, query or mutation","enum":["query","mutation"]},"httpMethod":{"type":"string","description":"Verb of api rest","enum":["get","post","put","delete","patch"]}}},"relationship":{"type":"object","additionalProperties":false,"description":"Relationship definition for this property","properties":{"type":{"type":"string","description":"The type of web component","enum":["many-to-many","many-to-one","none","one-to-many","one-to-one"]},"singularName":{"type":"string","description":"Singular name of the property referred to in the relationship, only for one-to-many and many-to-many relationship, example: book","minLength":2},"aggregateName":{"type":"string","description":"Aggregate referring to this relationship, example: LibraryAuthor","minLength":2},"modulePath":{"type":"string","description":"Path to the module that refers to this relationship, example: library/author","minLength":2},"key":{"type":"string","description":"Property key that refers to this relationship, only for many-to-one relationship, example: id","minLength":2},"field":{"type":"string","description":"Field to obtain the relationship data, example: author","minLength":2},"avoidConstraint":{"type":"boolean","description":"Avoid constraint rules for this relationship"},"packageName":{"type":"string","description":"Path to packageName where is the relationship, example: @aurora-ts/core","minLength":2},"isDenormalized":{"type":"boolean","description":"Set many-to-many relationship as denormalized, creating a field to store the selected ids"},"pivot":{"$ref":"#/definitions/pivotTable"}}},"webComponent":{"type":"object","additionalProperties":false,"description":"Web Component that wil be rendered for this property","properties":{"type":{"type":"string","description":"The type of web component","enum":["async-search-multiple-select","async-search-select","grid-elements-manager","grid-select-element","grid-select-multiple-elements","multiple-select","search-multiple-select","search-select","select"]},"className":{"type":"string","description":"CSS class for web component","minLength":2},"detailSort":{"type":"number","description":"Web component order on detail view","minimum":1},"listSort":{"type":"number","description":"Web component order on list view","minimum":1},"isListHidden":{"type":"boolean","description":"Set hidden web component on list view"},"isDetailHidden":{"type":"boolean","description":"Set hidden web component on detail view"}}},"excludedOperationValues":{"type":"array","items":{"enum":["count","create","createBatch","deleteById","delete","findById","find","get","max","min","paginate","rawSql","sum","updateAndIncrement","updateById","update","upsert"]}},"front":{"type":"object","additionalProperties":false,"description":"Appearance properties for front application","properties":{"outlineFontSetIcon":{"type":"string","description":"Font set outline icon to be used in the front application, example: material-symbols-outlined","minLength":2},"outlineIcon":{"type":"string","description":"Outline icon to be used in the front application, example: heroicons_solid:tag","minLength":2},"solidFontSetIcon":{"type":"string","description":"Font set solid icon to be used in the front application, example: material-symbols-outlined","minLength":2},"solidIcon":{"type":"string","description":"Solid icon to be used in the front application, example: heroicons_solid:tag","minLength":2}}},"pivotTable":{"type":"object","additionalProperties":false,"description":"Relationship pivot table definition for this relationship","properties":{"boundedContextName":{"type":"string","description":"The name of the package, singular in kebab-case","minLength":2},"moduleName":{"type":"string","description":"The name of the module, singular in kebab-case","minLength":2},"moduleNames":{"type":"string","description":"The name of the module, plural in kebab-case","minLength":2},"aggregateName":{"type":"string","description":"The name of the aggregateName, singular in PascalCase","minLength":2},"hasOAuth":{"type":"boolean","description":"Enabled authentication for this pivot table","default":false},"hasAuditing":{"type":"boolean","description":"Enabled auditing for pivot table","default":false},"aggregateProperties":{"type":"array","items":{"$ref":"#/definitions/property"}},"excludedFiles":{"type":"array","items":{"type":"string"}},"excludedOperations":{"$ref":"#/definitions/excludedOperationValues"}}}},"description":"Make agile applications without technical debt","properties":{"version":{"type":"string","description":"Schema version","default":"0.0.1","minLength":2},"boundedContextName":{"type":"string","description":"The name of the package, singular in kebab-case","minLength":2},"moduleName":{"type":"string","description":"The name of the module, singular in kebab-case","minLength":2},"moduleNames":{"type":"string","description":"The name of the module, plural in kebab-case","minLength":2},"aggregateName":{"type":"string","description":"The name of the aggregateName, singular in PascalCase","minLength":2},"hasOAuth":{"type":"boolean","description":"Enabled authentication for this module","default":false},"hasTenant":{"type":"boolean","description":"Enabled tenant for this module","default":false},"hasAuditing":{"type":"boolean","description":"Enabled auditing for this module","default":false},"front":{"$ref":"#/definitions/front"},"aggregateProperties":{"type":"array","items":{"$ref":"#/definitions/property"}},"additionalApis":{"type":"array","items":{"$ref":"#/definitions/apiDefinition"}},"excludedFiles":{"type":"array","items":{"type":"string"}},"excludedOperations":{"$ref":"#/definitions/excludedOperationValues"}},"required":["boundedContextName","moduleName","moduleNames","aggregateName"],"title":"Aurora Agile Meta Framework","type":"object"}
|
Provide a JSON object that satisfies the schema "Aurora Agile Meta Framework". Here are the required top‑level fields: boundedContextName, moduleName, moduleNames, aggregateName. Return only the valid JSON object.
|
Aurora Agile Meta Framework
|
schema-store
|
schema_store_68
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Automations File\",\"description\":\"WARN: Do not remove any field here, as it will break reading automation yaml files. We error if there are any\\n unknown fields in the yaml (to ensure the yaml is correct), but would break if we removed any fields.\\n This includes marking a field as \\\"reserved\\\" in the proto file, this will also break reading the yaml.\",\"type\":\"object\",\"properties\":{\"services\":{\"type\":\"object\",\"propertyNames\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9_-]{1,128}$\"},\"additionalProperties\":{\"$ref\":\"#/$defs/gitpod.v1.AutomationsFile.Service.jsonschema.json\"}},\"tasks\":{\"type\":\"object\",\"propertyNames\":{\"type\":\"string\",\"pattern\":\"^[a-zA-Z0-9_-]{1,128}$\"},\"additionalProperties\":{\"$ref\":\"#/$defs/gitpod.v1.AutomationsFile.Task.jsonschema.json\"}}},\"additionalProperties\":false,\"$defs\":{\"gitpod.v1.AutomationsFile.Service.jsonschema.json\":{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Service\",\"type\":\"object\",\"properties\":{\"description\":{\"default\":\"\",\"type\":\"string\"},\"commands\":{\"$ref\":\"#/$defs/gitpod.v1.ServiceSpec.Commands.jsonschema.json\"},\"name\":{\"default\":\"\",\"type\":\"string\",\"minLength\":1},\"role\":{\"default\":\"\",\"type\":\"string\",\"enum\":[\"\",\"default\",\"editor\",\"ai-agent\"]},\"runsOn\":{\"$ref\":\"#/$defs/gitpod.v1.RunsOn.jsonschema.json\"},\"triggeredBy\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"manual\",\"postEnvironmentStart\",\"postDevcontainerStart\"]}}},\"patternProperties\":{\"^(runs_on)$\":{\"$ref\":\"#/$defs/gitpod.v1.RunsOn.jsonschema.json\"},\"^(triggered_by)$\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"manual\",\"postEnvironmentStart\",\"postDevcontainerStart\"]}}},\"additionalProperties\":false},\"gitpod.v1.AutomationsFile.Task.jsonschema.json\":{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Task\",\"type\":\"object\",\"properties\":{\"description\":{\"default\":\"\",\"type\":\"string\"},\"command\":{\"default\":\"\",\"type\":\"string\",\"minLength\":1},\"dependsOn\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"name\":{\"default\":\"\",\"type\":\"string\",\"minLength\":1},\"runsOn\":{\"$ref\":\"#/$defs/gitpod.v1.RunsOn.jsonschema.json\"},\"triggeredBy\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"manual\",\"postEnvironmentStart\",\"postDevcontainerStart\"]}}},\"patternProperties\":{\"^(depends_on)$\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"^(runs_on)$\":{\"$ref\":\"#/$defs/gitpod.v1.RunsOn.jsonschema.json\"},\"^(triggered_by)$\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"manual\",\"postEnvironmentStart\",\"postDevcontainerStart\"]}}},\"additionalProperties\":false},\"gitpod.v1.RunsOn.Docker.jsonschema.json\":{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Docker\",\"type\":\"object\",\"properties\":{\"environment\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"image\":{\"default\":\"\",\"type\":\"string\",\"minLength\":1}},\"additionalProperties\":false},\"gitpod.v1.RunsOn.jsonschema.json\":{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Runs On\",\"type\":\"object\",\"properties\":{\"docker\":{\"$ref\":\"#/$defs/gitpod.v1.RunsOn.Docker.jsonschema.json\"}},\"additionalProperties\":false},\"gitpod.v1.ServiceSpec.Commands.jsonschema.json\":{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"title\":\"Commands\",\"type\":\"object\",\"properties\":{\"ready\":{\"description\":\"ready is an optional command that is run repeatedly until it exits with a zero exit code.\\n If set, the service will first go into a Starting phase, and then into a Running phase once the ready\\n command exits with a zero exit code.\",\"default\":\"\",\"type\":\"string\"},\"start\":{\"description\":\"start is the command to start and run the service.\\n If start exits, the service will transition to the following phase:\\n - Stopped: if the exit code is 0\\n - Failed: if the exit code is not 0\\n If the stop command is not set, the start command will receive a SIGTERM signal when the service is\\n requested to stop. If it does not exit within 2 minutes, it will receive a SIGKILL signal.\",\"default\":\"\",\"type\":\"string\",\"minLength\":1},\"stop\":{\"description\":\"stop is an optional command that runs when the service is requested to stop.\\n If set, instead of sending a SIGTERM signal to the start command, the stop command will be run.\\n Once the stop command exits, the start command will receive a SIGKILL signal.\\n If the stop command exits with a non-zero exit code, the service will transition to the Failed phase.\\n If the stop command does not exit within 2 minutes, a SIGKILL signal will be sent to both the start and\\n stop commands.\",\"default\":\"\",\"type\":\"string\"}},\"additionalProperties\":false}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Automations File\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Automations File","description":"WARN: Do not remove any field here, as it will break reading automation yaml files. We error if there are any\n unknown fields in the yaml (to ensure the yaml is correct), but would break if we removed any fields.\n This includes marking a field as \"reserved\" in the proto file, this will also break reading the yaml.","type":"object","properties":{"services":{"type":"object","propertyNames":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,128}$"},"additionalProperties":{"$ref":"#/$defs/gitpod.v1.AutomationsFile.Service.jsonschema.json"}},"tasks":{"type":"object","propertyNames":{"type":"string","pattern":"^[a-zA-Z0-9_-]{1,128}$"},"additionalProperties":{"$ref":"#/$defs/gitpod.v1.AutomationsFile.Task.jsonschema.json"}}},"additionalProperties":false,"$defs":{"gitpod.v1.AutomationsFile.Service.jsonschema.json":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Service","type":"object","properties":{"description":{"default":"","type":"string"},"commands":{"$ref":"#/$defs/gitpod.v1.ServiceSpec.Commands.jsonschema.json"},"name":{"default":"","type":"string","minLength":1},"role":{"default":"","type":"string","enum":["","default","editor","ai-agent"]},"runsOn":{"$ref":"#/$defs/gitpod.v1.RunsOn.jsonschema.json"},"triggeredBy":{"type":"array","items":{"type":"string","enum":["manual","postEnvironmentStart","postDevcontainerStart"]}}},"patternProperties":{"^(runs_on)$":{"$ref":"#/$defs/gitpod.v1.RunsOn.jsonschema.json"},"^(triggered_by)$":{"type":"array","items":{"type":"string","enum":["manual","postEnvironmentStart","postDevcontainerStart"]}}},"additionalProperties":false},"gitpod.v1.AutomationsFile.Task.jsonschema.json":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Task","type":"object","properties":{"description":{"default":"","type":"string"},"command":{"default":"","type":"string","minLength":1},"dependsOn":{"type":"array","items":{"type":"string"}},"name":{"default":"","type":"string","minLength":1},"runsOn":{"$ref":"#/$defs/gitpod.v1.RunsOn.jsonschema.json"},"triggeredBy":{"type":"array","items":{"type":"string","enum":["manual","postEnvironmentStart","postDevcontainerStart"]}}},"patternProperties":{"^(depends_on)$":{"type":"array","items":{"type":"string"}},"^(runs_on)$":{"$ref":"#/$defs/gitpod.v1.RunsOn.jsonschema.json"},"^(triggered_by)$":{"type":"array","items":{"type":"string","enum":["manual","postEnvironmentStart","postDevcontainerStart"]}}},"additionalProperties":false},"gitpod.v1.RunsOn.Docker.jsonschema.json":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Docker","type":"object","properties":{"environment":{"type":"array","items":{"type":"string"}},"image":{"default":"","type":"string","minLength":1}},"additionalProperties":false},"gitpod.v1.RunsOn.jsonschema.json":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Runs On","type":"object","properties":{"docker":{"$ref":"#/$defs/gitpod.v1.RunsOn.Docker.jsonschema.json"}},"additionalProperties":false},"gitpod.v1.ServiceSpec.Commands.jsonschema.json":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Commands","type":"object","properties":{"ready":{"description":"ready is an optional command that is run repeatedly until it exits with a zero exit code.\n If set, the service will first go into a Starting phase, and then into a Running phase once the ready\n command exits with a zero exit code.","default":"","type":"string"},"start":{"description":"start is the command to start and run the service.\n If start exits, the service will transition to the following phase:\n - Stopped: if the exit code is 0\n - Failed: if the exit code is not 0\n If the stop command is not set, the start command will receive a SIGTERM signal when the service is\n requested to stop. If it does not exit within 2 minutes, it will receive a SIGKILL signal.","default":"","type":"string","minLength":1},"stop":{"description":"stop is an optional command that runs when the service is requested to stop.\n If set, instead of sending a SIGTERM signal to the start command, the stop command will be run.\n Once the stop command exits, the start command will receive a SIGKILL signal.\n If the stop command exits with a non-zero exit code, the service will transition to the Failed phase.\n If the stop command does not exit within 2 minutes, a SIGKILL signal will be sent to both the start and\n stop commands.","default":"","type":"string"}},"additionalProperties":false}}}
|
Provide a JSON object that satisfies the schema "Automations File". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Automations File
|
schema-store
|
schema_store_69
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/ava.json\",\"additionalProperties\":false,\"definitions\":{\"path\":{\"type\":\"string\",\"minLength\":1},\"array-of-strings\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"array-of-paths\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/path\"}}},\"description\":\"Configuration Schema for the JavaScript test runner AVA\",\"properties\":{\"files\":{\"$ref\":\"#/definitions/array-of-paths\",\"description\":\"An array of glob patterns to select test files. Files with an underscore prefix are ignored. By default only selects files with `cjs`, `mjs` & `js` extensions, even if the pattern matches other files. Specify `extensions` to allow other file extensions\"},\"ignoredByWatcher\":{\"$ref\":\"#/definitions/array-of-paths\",\"description\":\"An array of glob patterns to match files that, even if changed, are ignored by the watcher\"},\"match\":{\"$ref\":\"#/definitions/array-of-paths\",\"description\":\"Not typically useful in the `package.json` configuration, but equivalent to specifying `--match` on the CLI\"},\"cache\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead\"},\"concurrency\":{\"type\":\"number\",\"description\":\"Max number of test files running at the same time (default: CPU cores)\"},\"workerThreads\":{\"type\":\"boolean\",\"default\":true,\"description\":\"Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes\"},\"failFast\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Stop running further tests once a test fails\"},\"failWithoutAssertions\":{\"type\":\"boolean\",\"default\":true,\"description\":\"If `false`, does not fail a test if it doesn't run assertions\"},\"environmentVariables\":{\"title\":\"environment variables\",\"type\":\"object\",\"description\":\"Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`\",\"additionalProperties\":{\"type\":\"string\"}},\"serial\":{\"type\":\"boolean\",\"default\":false,\"description\":\"if `true`, prevents parallel execution of tests within a file\"},\"tap\":{\"type\":\"boolean\",\"default\":false,\"description\":\"If `true`, enables the TAP reporter\"},\"verbose\":{\"type\":\"boolean\",\"default\":false,\"description\":\"If `true`, enables verbose output (though currently non-verbose output is not supported)\"},\"snapshotDir\":{\"$ref\":\"#/definitions/path\",\"description\":\"Specifies a fixed location for storing snapshot files. Use this if your snapshots are ending up in the wrong location\"},\"extensions\":{\"anyOf\":[{\"$ref\":\"#/definitions/array-of-strings\"},{\"title\":\"extensions\",\"type\":\"object\",\"patternProperties\":{\"^(c|m)?js$\":{\"enum\":[true]}},\"additionalProperties\":{\"enum\":[\"commonjs\",\"module\"]}}],\"default\":[\"cjs\",\"mjs\",\"js\"],\"description\":\"Extensions of test files. Setting this overrides the default `[\\\"cjs\\\", \\\"mjs\\\", \\\"js\\\"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded\"},\"require\":{\"$ref\":\"#/definitions/array-of-paths\",\"description\":\"Extra modules to require before tests are run. Modules are required in the worker processes\"},\"timeout\":{\"anyOf\":[{\"type\":\"number\",\"minimum\":0},{\"type\":\"string\",\"pattern\":\"^(\\\\d+)(s|m)$\"}],\"default\":\"10s\",\"description\":\"Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options\"},\"nodeArguments\":{\"$ref\":\"#/definitions/array-of-strings\",\"description\":\"Configure Node.js arguments used to launch worker processes\"},\"utilizeParallelBuilds\":{\"type\":\"boolean\",\"default\":true,\"description\":\"If `false`, disable parallel builds (default: `true`)\"},\"typescript\":{\"title\":\"configuration\",\"type\":\"object\",\"description\":\"Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property\",\"properties\":{\"extensions\":{\"$ref\":\"#/definitions/array-of-paths\",\"default\":[\"ts\"],\"description\":\"You can configure AVA to recognize additional file extensions as TypeScript (e.g., `[\\\"ts\\\", \\\"tsx\\\"]` to add partial JSX support). Note that the preserve mode for JSX is not (yet) supported. See also AVA's `extensions` object\"},\"rewritePaths\":{\"title\":\"paths\",\"type\":\"object\",\"description\":\"AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory\",\"patternProperties\":{\"/$\":{\"type\":\"string\",\"pattern\":\"/$\"}}},\"compile\":{\"enum\":[false,\"tsc\"],\"default\":false,\"description\":\"If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode\"}}}},\"title\":\"AVA Config Schema\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"AVA Config Schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/ava.json","additionalProperties":false,"definitions":{"path":{"type":"string","minLength":1},"array-of-strings":{"type":"array","items":{"type":"string"}},"array-of-paths":{"type":"array","items":{"$ref":"#/definitions/path"}}},"description":"Configuration Schema for the JavaScript test runner AVA","properties":{"files":{"$ref":"#/definitions/array-of-paths","description":"An array of glob patterns to select test files. Files with an underscore prefix are ignored. By default only selects files with `cjs`, `mjs` & `js` extensions, even if the pattern matches other files. Specify `extensions` to allow other file extensions"},"ignoredByWatcher":{"$ref":"#/definitions/array-of-paths","description":"An array of glob patterns to match files that, even if changed, are ignored by the watcher"},"match":{"$ref":"#/definitions/array-of-paths","description":"Not typically useful in the `package.json` configuration, but equivalent to specifying `--match` on the CLI"},"cache":{"type":"boolean","default":true,"description":"Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead"},"concurrency":{"type":"number","description":"Max number of test files running at the same time (default: CPU cores)"},"workerThreads":{"type":"boolean","default":true,"description":"Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes"},"failFast":{"type":"boolean","default":false,"description":"Stop running further tests once a test fails"},"failWithoutAssertions":{"type":"boolean","default":true,"description":"If `false`, does not fail a test if it doesn't run assertions"},"environmentVariables":{"title":"environment variables","type":"object","description":"Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`","additionalProperties":{"type":"string"}},"serial":{"type":"boolean","default":false,"description":"if `true`, prevents parallel execution of tests within a file"},"tap":{"type":"boolean","default":false,"description":"If `true`, enables the TAP reporter"},"verbose":{"type":"boolean","default":false,"description":"If `true`, enables verbose output (though currently non-verbose output is not supported)"},"snapshotDir":{"$ref":"#/definitions/path","description":"Specifies a fixed location for storing snapshot files. Use this if your snapshots are ending up in the wrong location"},"extensions":{"anyOf":[{"$ref":"#/definitions/array-of-strings"},{"title":"extensions","type":"object","patternProperties":{"^(c|m)?js$":{"enum":[true]}},"additionalProperties":{"enum":["commonjs","module"]}}],"default":["cjs","mjs","js"],"description":"Extensions of test files. Setting this overrides the default `[\"cjs\", \"mjs\", \"js\"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded"},"require":{"$ref":"#/definitions/array-of-paths","description":"Extra modules to require before tests are run. Modules are required in the worker processes"},"timeout":{"anyOf":[{"type":"number","minimum":0},{"type":"string","pattern":"^(\\d+)(s|m)$"}],"default":"10s","description":"Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options"},"nodeArguments":{"$ref":"#/definitions/array-of-strings","description":"Configure Node.js arguments used to launch worker processes"},"utilizeParallelBuilds":{"type":"boolean","default":true,"description":"If `false`, disable parallel builds (default: `true`)"},"typescript":{"title":"configuration","type":"object","description":"Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property","properties":{"extensions":{"$ref":"#/definitions/array-of-paths","default":["ts"],"description":"You can configure AVA to recognize additional file extensions as TypeScript (e.g., `[\"ts\", \"tsx\"]` to add partial JSX support). Note that the preserve mode for JSX is not (yet) supported. See also AVA's `extensions` object"},"rewritePaths":{"title":"paths","type":"object","description":"AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory","patternProperties":{"/$":{"type":"string","pattern":"/$"}}},"compile":{"enum":[false,"tsc"],"default":false,"description":"If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode"}}}},"title":"AVA Config Schema","type":"object"}
|
Provide a JSON object that satisfies the schema "AVA Config Schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
AVA Config Schema
|
schema-store
|
schema_store_70
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/avro-avsc.json\",\"definitions\":{\"avroSchema\":{\"title\":\"Avro Schema\",\"description\":\"Root Schema\",\"oneOf\":[{\"$ref\":\"#/definitions/types\"}]},\"types\":{\"title\":\"Avro Types\",\"description\":\"Allowed Avro types\",\"oneOf\":[{\"$ref\":\"#/definitions/primitiveType\"},{\"$ref\":\"#/definitions/primitiveTypeWithMetadata\"},{\"$ref\":\"#/definitions/customTypeReference\"},{\"$ref\":\"#/definitions/avroRecord\"},{\"$ref\":\"#/definitions/avroEnum\"},{\"$ref\":\"#/definitions/avroArray\"},{\"$ref\":\"#/definitions/avroMap\"},{\"$ref\":\"#/definitions/avroFixed\"},{\"$ref\":\"#/definitions/avroUnion\"}]},\"primitiveType\":{\"title\":\"Primitive Type\",\"description\":\"Basic type primitives.\",\"type\":\"string\",\"enum\":[\"null\",\"boolean\",\"int\",\"long\",\"float\",\"double\",\"bytes\",\"string\"]},\"primitiveTypeWithMetadata\":{\"title\":\"Primitive Type With Metadata\",\"description\":\"A primitive type with metadata attached.\",\"type\":\"object\",\"properties\":{\"type\":{\"$ref\":\"#/definitions/primitiveType\"}},\"required\":[\"type\"]},\"customTypeReference\":{\"title\":\"Custom Type\",\"description\":\"Reference to a ComplexType\",\"not\":{\"$ref\":\"#/definitions/primitiveType\"},\"type\":\"string\",\"pattern\":\"^[A-Za-z_][A-Za-z0-9_]*(\\\\.[A-Za-z_][A-Za-z0-9_]*)*$\"},\"avroUnion\":{\"title\":\"Union\",\"description\":\"A Union of types\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/avroSchema\"},\"minItems\":1},\"avroField\":{\"title\":\"Field\",\"description\":\"A field within a Record\",\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/name\"},\"type\":{\"$ref\":\"#/definitions/types\"},\"doc\":{\"type\":\"string\"},\"default\":{},\"order\":{\"enum\":[\"ascending\",\"descending\",\"ignore\"]},\"aliases\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}}},\"required\":[\"name\",\"type\"]},\"avroRecord\":{\"title\":\"Record\",\"description\":\"A Record\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"record\"]},\"name\":{\"$ref\":\"#/definitions/name\"},\"namespace\":{\"$ref\":\"#/definitions/namespace\"},\"doc\":{\"type\":\"string\"},\"aliases\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}},\"fields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/avroField\"}}},\"required\":[\"type\",\"name\",\"fields\"]},\"avroEnum\":{\"title\":\"Enum\",\"description\":\"An enumeration\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"enum\"]},\"name\":{\"$ref\":\"#/definitions/name\"},\"namespace\":{\"$ref\":\"#/definitions/namespace\"},\"doc\":{\"type\":\"string\"},\"aliases\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}},\"symbols\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}}},\"required\":[\"type\",\"name\",\"symbols\"]},\"avroArray\":{\"title\":\"Array\",\"description\":\"An array\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"array\"]},\"name\":{\"$ref\":\"#/definitions/name\"},\"namespace\":{\"$ref\":\"#/definitions/namespace\"},\"doc\":{\"type\":\"string\"},\"aliases\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}},\"items\":{\"$ref\":\"#/definitions/types\"}},\"required\":[\"type\",\"items\"]},\"avroMap\":{\"title\":\"Map\",\"description\":\"A map of values\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"map\"]},\"name\":{\"$ref\":\"#/definitions/name\"},\"namespace\":{\"$ref\":\"#/definitions/namespace\"},\"doc\":{\"type\":\"string\"},\"aliases\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}},\"values\":{\"$ref\":\"#/definitions/types\"}},\"required\":[\"type\",\"values\"]},\"avroFixed\":{\"title\":\"Fixed\",\"description\":\"A fixed sized array of bytes\",\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"fixed\"]},\"name\":{\"$ref\":\"#/definitions/name\"},\"namespace\":{\"$ref\":\"#/definitions/namespace\"},\"doc\":{\"type\":\"string\"},\"aliases\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/name\"}},\"size\":{\"type\":\"number\"}},\"required\":[\"type\",\"name\",\"size\"]},\"name\":{\"type\":\"string\",\"pattern\":\"^[A-Za-z_][A-Za-z0-9_]*$\"},\"namespace\":{\"type\":\"string\",\"pattern\":\"^([A-Za-z_][A-Za-z0-9_]*(\\\\.[A-Za-z_][A-Za-z0-9_]*)*)*$\"}},\"description\":\"Json-Schema definition for Avro AVSC files.\",\"oneOf\":[{\"$ref\":\"#/definitions/avroSchema\"}],\"title\":\"Avro Schema Definition\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Avro Schema Definition\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/avro-avsc.json","definitions":{"avroSchema":{"title":"Avro Schema","description":"Root Schema","oneOf":[{"$ref":"#/definitions/types"}]},"types":{"title":"Avro Types","description":"Allowed Avro types","oneOf":[{"$ref":"#/definitions/primitiveType"},{"$ref":"#/definitions/primitiveTypeWithMetadata"},{"$ref":"#/definitions/customTypeReference"},{"$ref":"#/definitions/avroRecord"},{"$ref":"#/definitions/avroEnum"},{"$ref":"#/definitions/avroArray"},{"$ref":"#/definitions/avroMap"},{"$ref":"#/definitions/avroFixed"},{"$ref":"#/definitions/avroUnion"}]},"primitiveType":{"title":"Primitive Type","description":"Basic type primitives.","type":"string","enum":["null","boolean","int","long","float","double","bytes","string"]},"primitiveTypeWithMetadata":{"title":"Primitive Type With Metadata","description":"A primitive type with metadata attached.","type":"object","properties":{"type":{"$ref":"#/definitions/primitiveType"}},"required":["type"]},"customTypeReference":{"title":"Custom Type","description":"Reference to a ComplexType","not":{"$ref":"#/definitions/primitiveType"},"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*$"},"avroUnion":{"title":"Union","description":"A Union of types","type":"array","items":{"$ref":"#/definitions/avroSchema"},"minItems":1},"avroField":{"title":"Field","description":"A field within a Record","type":"object","properties":{"name":{"$ref":"#/definitions/name"},"type":{"$ref":"#/definitions/types"},"doc":{"type":"string"},"default":{},"order":{"enum":["ascending","descending","ignore"]},"aliases":{"type":"array","items":{"$ref":"#/definitions/name"}}},"required":["name","type"]},"avroRecord":{"title":"Record","description":"A Record","type":"object","properties":{"type":{"type":"string","enum":["record"]},"name":{"$ref":"#/definitions/name"},"namespace":{"$ref":"#/definitions/namespace"},"doc":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/definitions/name"}},"fields":{"type":"array","items":{"$ref":"#/definitions/avroField"}}},"required":["type","name","fields"]},"avroEnum":{"title":"Enum","description":"An enumeration","type":"object","properties":{"type":{"type":"string","enum":["enum"]},"name":{"$ref":"#/definitions/name"},"namespace":{"$ref":"#/definitions/namespace"},"doc":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/definitions/name"}},"symbols":{"type":"array","items":{"$ref":"#/definitions/name"}}},"required":["type","name","symbols"]},"avroArray":{"title":"Array","description":"An array","type":"object","properties":{"type":{"type":"string","enum":["array"]},"name":{"$ref":"#/definitions/name"},"namespace":{"$ref":"#/definitions/namespace"},"doc":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/definitions/name"}},"items":{"$ref":"#/definitions/types"}},"required":["type","items"]},"avroMap":{"title":"Map","description":"A map of values","type":"object","properties":{"type":{"type":"string","enum":["map"]},"name":{"$ref":"#/definitions/name"},"namespace":{"$ref":"#/definitions/namespace"},"doc":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/definitions/name"}},"values":{"$ref":"#/definitions/types"}},"required":["type","values"]},"avroFixed":{"title":"Fixed","description":"A fixed sized array of bytes","type":"object","properties":{"type":{"type":"string","enum":["fixed"]},"name":{"$ref":"#/definitions/name"},"namespace":{"$ref":"#/definitions/namespace"},"doc":{"type":"string"},"aliases":{"type":"array","items":{"$ref":"#/definitions/name"}},"size":{"type":"number"}},"required":["type","name","size"]},"name":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]*$"},"namespace":{"type":"string","pattern":"^([A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*)*$"}},"description":"Json-Schema definition for Avro AVSC files.","oneOf":[{"$ref":"#/definitions/avroSchema"}],"title":"Avro Schema Definition"}
|
Provide a JSON object that satisfies the schema "Avro Schema Definition". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Avro Schema Definition
|
schema-store
|
schema_store_71
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/aws-cdk-appconfig-featureflags-1.0.0.json\",\"allOf\":[{\"$ref\":\"#/definitions/flagSetDefinition\"}],\"definitions\":{\"flagSetDefinition\":{\"type\":\"object\",\"properties\":{\"version\":{\"$ref\":\"#/definitions/flagSchemaVersions\"},\"flags\":{\"$ref\":\"#/definitions/flagDefinitions\"},\"values\":{\"$ref\":\"#/definitions/flagValues\"}},\"required\":[\"version\",\"flags\",\"values\"],\"additionalProperties\":false},\"flagDefinitions\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\n]{1,64}$\":{\"$ref\":\"#/definitions/flagDefinition\"}},\"maxProperties\":25,\"additionalProperties\":false},\"flagDefinition\":{\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/customerDefinedName\"},\"description\":{\"$ref\":\"#/definitions/customerDefinedDescription\"},\"_createdAt\":{\"type\":\"string\"},\"_updatedAt\":{\"type\":\"string\"},\"_deprecation\":{\"type\":\"object\",\"properties\":{\"status\":{\"const\":\"planned\"},\"date\":{\"type\":\"string\",\"format\":\"date\"}},\"additionalProperties\":false},\"attributes\":{\"$ref\":\"#/definitions/attributeDefinitions\"}},\"required\":[\"attributes\"],\"additionalProperties\":false},\"attributeDefinitions\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\n]{1,64}$\":{\"$ref\":\"#/definitions/attributeDefinition\"}},\"maxProperties\":25,\"additionalProperties\":false},\"attributeDefinition\":{\"type\":\"object\",\"properties\":{\"description\":{\"$ref\":\"#/definitions/customerDefinedDescription\"},\"constraints\":{\"oneOf\":[{\"$ref\":\"#/definitions/numberConstraints\"},{\"$ref\":\"#/definitions/stringConstraints\"},{\"$ref\":\"#/definitions/arrayConstraints\"},{\"$ref\":\"#/definitions/boolConstraints\"}]}},\"required\":[\"constraints\"],\"additionalProperties\":false},\"flagValues\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\n]{1,64}$\":{\"$ref\":\"#/definitions/flagValue\"}},\"maxProperties\":25,\"additionalProperties\":false},\"flagValue\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"_createdAt\":{\"type\":\"string\"},\"_updatedAt\":{\"type\":\"string\"},\"_variants\":{\"type\":\"array\",\"uniqueItems\":true,\"maxItems\":32,\"items\":{\"$ref\":\"#/definitions/variant\"}}},\"required\":[\"enabled\",\"_variants\"],\"additionalProperties\":false},\"stringConstraints\":{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"string\"},\"required\":{\"type\":\"boolean\"},\"pattern\":{\"type\":\"string\",\"maxLength\":1024},\"enum\":{\"type\":\"array\",\"maxItems\":100,\"items\":{\"oneOf\":[{\"type\":\"string\",\"maxLength\":1024},{\"type\":\"integer\"}]}}},\"required\":[\"type\"],\"not\":{\"required\":[\"pattern\",\"enum\"],\"properties\":{\"pattern\":true,\"enum\":true}},\"additionalProperties\":false},\"numberConstraints\":{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"number\"},\"required\":{\"type\":\"boolean\"},\"minimum\":{\"type\":\"integer\"},\"maximum\":{\"type\":\"integer\"}},\"required\":[\"type\"],\"additionalProperties\":false},\"arrayConstraints\":{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"array\"},\"required\":{\"type\":\"boolean\"},\"elements\":{\"$ref\":\"#/definitions/elementConstraints\"}},\"required\":[\"type\"],\"additionalProperties\":false},\"boolConstraints\":{\"type\":\"object\",\"properties\":{\"type\":{\"const\":\"boolean\"},\"required\":{\"type\":\"boolean\"}},\"required\":[\"type\"],\"additionalProperties\":false},\"elementConstraints\":{\"oneOf\":[{\"$ref\":\"#/definitions/numberConstraints\"},{\"$ref\":\"#/definitions/stringConstraints\"}]},\"variant\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"name\":{\"$ref\":\"#/definitions/customerDefinedName\"},\"rule\":{\"type\":\"string\",\"maxLength\":1024},\"attributeValues\":{\"$ref\":\"#/definitions/attributeValue\"}},\"required\":[\"name\",\"enabled\"],\"additionalProperties\":false},\"attributeValue\":{\"oneOf\":[{\"type\":\"string\",\"maxLength\":1024},{\"type\":\"number\"},{\"type\":\"boolean\"},{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\",\"maxLength\":1024},{\"type\":\"number\"}]}}]},\"customerDefinedName\":{\"type\":\"string\",\"pattern\":\"^[^\\\\n]{1,64}$\"},\"customerDefinedDescription\":{\"type\":\"string\",\"maxLength\":1024},\"flagSchemaVersions\":{\"const\":\"1\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"aws-cdk-appconfig-featureflags-1.0.0\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/aws-cdk-appconfig-featureflags-1.0.0.json","allOf":[{"$ref":"#/definitions/flagSetDefinition"}],"definitions":{"flagSetDefinition":{"type":"object","properties":{"version":{"$ref":"#/definitions/flagSchemaVersions"},"flags":{"$ref":"#/definitions/flagDefinitions"},"values":{"$ref":"#/definitions/flagValues"}},"required":["version","flags","values"],"additionalProperties":false},"flagDefinitions":{"type":"object","patternProperties":{"^[^\\n]{1,64}$":{"$ref":"#/definitions/flagDefinition"}},"maxProperties":25,"additionalProperties":false},"flagDefinition":{"type":"object","properties":{"name":{"$ref":"#/definitions/customerDefinedName"},"description":{"$ref":"#/definitions/customerDefinedDescription"},"_createdAt":{"type":"string"},"_updatedAt":{"type":"string"},"_deprecation":{"type":"object","properties":{"status":{"const":"planned"},"date":{"type":"string","format":"date"}},"additionalProperties":false},"attributes":{"$ref":"#/definitions/attributeDefinitions"}},"required":["attributes"],"additionalProperties":false},"attributeDefinitions":{"type":"object","patternProperties":{"^[^\\n]{1,64}$":{"$ref":"#/definitions/attributeDefinition"}},"maxProperties":25,"additionalProperties":false},"attributeDefinition":{"type":"object","properties":{"description":{"$ref":"#/definitions/customerDefinedDescription"},"constraints":{"oneOf":[{"$ref":"#/definitions/numberConstraints"},{"$ref":"#/definitions/stringConstraints"},{"$ref":"#/definitions/arrayConstraints"},{"$ref":"#/definitions/boolConstraints"}]}},"required":["constraints"],"additionalProperties":false},"flagValues":{"type":"object","patternProperties":{"^[^\\n]{1,64}$":{"$ref":"#/definitions/flagValue"}},"maxProperties":25,"additionalProperties":false},"flagValue":{"type":"object","properties":{"enabled":{"type":"boolean"},"_createdAt":{"type":"string"},"_updatedAt":{"type":"string"},"_variants":{"type":"array","uniqueItems":true,"maxItems":32,"items":{"$ref":"#/definitions/variant"}}},"required":["enabled","_variants"],"additionalProperties":false},"stringConstraints":{"type":"object","properties":{"type":{"const":"string"},"required":{"type":"boolean"},"pattern":{"type":"string","maxLength":1024},"enum":{"type":"array","maxItems":100,"items":{"oneOf":[{"type":"string","maxLength":1024},{"type":"integer"}]}}},"required":["type"],"not":{"required":["pattern","enum"],"properties":{"pattern":true,"enum":true}},"additionalProperties":false},"numberConstraints":{"type":"object","properties":{"type":{"const":"number"},"required":{"type":"boolean"},"minimum":{"type":"integer"},"maximum":{"type":"integer"}},"required":["type"],"additionalProperties":false},"arrayConstraints":{"type":"object","properties":{"type":{"const":"array"},"required":{"type":"boolean"},"elements":{"$ref":"#/definitions/elementConstraints"}},"required":["type"],"additionalProperties":false},"boolConstraints":{"type":"object","properties":{"type":{"const":"boolean"},"required":{"type":"boolean"}},"required":["type"],"additionalProperties":false},"elementConstraints":{"oneOf":[{"$ref":"#/definitions/numberConstraints"},{"$ref":"#/definitions/stringConstraints"}]},"variant":{"type":"object","properties":{"enabled":{"type":"boolean"},"name":{"$ref":"#/definitions/customerDefinedName"},"rule":{"type":"string","maxLength":1024},"attributeValues":{"$ref":"#/definitions/attributeValue"}},"required":["name","enabled"],"additionalProperties":false},"attributeValue":{"oneOf":[{"type":"string","maxLength":1024},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"oneOf":[{"type":"string","maxLength":1024},{"type":"number"}]}}]},"customerDefinedName":{"type":"string","pattern":"^[^\\n]{1,64}$"},"customerDefinedDescription":{"type":"string","maxLength":1024},"flagSchemaVersions":{"const":"1"}}}
|
Provide a JSON object that satisfies the schema "aws-cdk-appconfig-featureflags-1.0.0". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
aws-cdk-appconfig-featureflags-1.0.0
|
schema-store
|
schema_store_72
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/azure-containerapp-template.json\",\"description\":\"Container App versioned application definition.\\nDefines the desired state of an immutable revision.\\nAny changes to this section Will result in a new revision being created\",\"properties\":{\"containers\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"args\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container start command arguments.\"},\"command\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container start command.\"},\"env\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Environment variable name.\"},\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the Container App secret from which to pull the environment variable value.\"},\"value\":{\"type\":\"string\",\"description\":\"Non-secret environment variable value.\"}},\"description\":\"Container App container environment variable.\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container environment variables.\"},\"image\":{\"type\":\"string\",\"description\":\"Container image tag.\"},\"name\":{\"type\":\"string\",\"description\":\"Custom container name.\"},\"probes\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"failureThreshold\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.\"},\"httpGet\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"Host name to connect to, defaults to the pod IP. You probably want to set \\\"Host\\\" in httpHeaders instead.\"},\"httpHeaders\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"The header field name\"},\"value\":{\"type\":\"string\",\"description\":\"The header field value\"}},\"required\":[],\"description\":\"HTTPHeader describes a custom header to be used in HTTP probes\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Custom headers to set in the request. HTTP allows repeated headers.\"},\"path\":{\"type\":\"string\",\"description\":\"Path to access on the HTTP server.\"},\"port\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.\"},\"scheme\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"HTTP\",\"HTTPS\"]},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Scheme to use for connecting to the host. Defaults to HTTP.\"}},\"required\":[],\"description\":\"HTTPGet specifies the http request to perform.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"HTTPGet specifies the http request to perform.\"},\"initialDelaySeconds\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.\"},\"periodSeconds\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.\"},\"successThreshold\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.\"},\"tcpSocket\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"host\":{\"type\":\"string\",\"description\":\"Optional: Host name to connect to, defaults to the pod IP.\"},\"port\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.\"}},\"required\":[],\"description\":\"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.\"},\"terminationGracePeriodSeconds\":{\"$comment\":\"The value of 'null' is UNDOCUMENTED.\",\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)\"},\"timeoutSeconds\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.\"},\"type\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"Liveness\",\"Readiness\",\"Startup\"]},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"The type of probe.\"}},\"description\":\"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"List of probes for the container.\"},\"resources\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"cpu\":{\"oneOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Required CPU in cores, e.g. 0.5\"},\"memory\":{\"type\":\"string\",\"description\":\"Required memory, e.g. \\\"250Mb\\\"\"},\"ephemeralStorage\":{\"type\":\"string\",\"description\":\"UNDOCUMENTED. The total amount of storage available to each replica.\"}},\"description\":\"Container App container resource requirements.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App container resource requirements.\"},\"volumeMounts\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"mountPath\":{\"type\":\"string\",\"description\":\"Path within the container at which the volume should be mounted.Must not contain ':'.\"},\"subPath\":{\"type\":\"string\",\"description\":\"Path within the volume from which the container's volume should be mounted. Defaults to \\\"\\\" (volume's root).\"},\"volumeName\":{\"type\":\"string\",\"description\":\"This must match the Name of a Volume.\"}},\"description\":\"Volume mount for the Container App.\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container volume mounts.\"}},\"description\":\"Container App container definition\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"List of container definitions for the Container App.\"},\"initContainers\":{\"oneOf\":[{\"type\":\"null\"},{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"args\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container start command arguments.\"},\"command\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container start command.\"},\"env\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Environment variable name.\"},\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the Container App secret from which to pull the environment variable value.\"},\"value\":{\"type\":\"string\",\"description\":\"Non-secret environment variable value.\"}},\"description\":\"Container App container environment variable.\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container environment variables.\"},\"image\":{\"type\":\"string\",\"description\":\"Container image tag.\"},\"name\":{\"type\":\"string\",\"description\":\"Custom container name.\"},\"resources\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"cpu\":{\"oneOf\":[{\"type\":\"number\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Required CPU in cores, e.g. 0.5\"},\"memory\":{\"type\":\"string\",\"description\":\"Required memory, e.g. \\\"250Mb\\\"\"}},\"description\":\"Container App container resource requirements.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App container resource requirements.\"},\"volumeMounts\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"mountPath\":{\"type\":\"string\",\"description\":\"Path within the container at which the volume should be mounted.Must not contain ':'.\"},\"subPath\":{\"type\":\"string\",\"description\":\"Path within the volume from which the container's volume should be mounted. Defaults to \\\"\\\" (volume's root).\"},\"volumeName\":{\"type\":\"string\",\"description\":\"This must match the Name of a Volume.\"}},\"description\":\"Volume mount for the Container App.\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container volume mounts.\"}},\"description\":\"Container App init container definition\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"List of specialized containers that run before app containers.\"},\"revisionSuffix\":{\"type\":\"string\",\"description\":\"User friendly suffix that is appended to the revision name\"},\"scale\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"maxReplicas\":{\"oneOf\":[{\"type\":\"integer\",\"default\":\"10\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Optional. Maximum number of container replicas. Defaults to 10 if not set.\"},\"minReplicas\":{\"$comment\":\"The value of 'null' is UNDOCUMENTED.\",\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Optional. Minimum number of container replicas.\"},\"rules\":{\"$comment\":\"The value of 'null' is UNDOCUMENTED.\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"azureQueue\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"auth\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the secret from which to pull the auth params.\"},\"triggerParameter\":{\"type\":\"string\",\"description\":\"Trigger Parameter that uses the secret\"}},\"description\":\"Auth Secrets for Scale Rule\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Authentication secrets for the queue scale rule.\"},\"queueLength\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Queue length.\"},\"queueName\":{\"type\":\"string\",\"description\":\"Queue name.\"}},\"description\":\"Container App container Azure Queue based scaling rule.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App container Azure Queue based scaling rule.\"},\"custom\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"auth\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the secret from which to pull the auth params.\"},\"triggerParameter\":{\"type\":\"string\",\"description\":\"Trigger Parameter that uses the secret\"}},\"description\":\"Auth Secrets for Scale Rule\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Authentication secrets for the custom scale rule.\"},\"metadata\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"properties\":{}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Metadata properties to describe custom scale rule.\"},\"type\":{\"type\":\"string\",\"description\":\"Type of the custom scale rule\\neg: azure-servicebus, redis etc.\"}},\"description\":\"Container App container Custom scaling rule.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App container Custom scaling rule.\"},\"http\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"auth\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the secret from which to pull the auth params.\"},\"triggerParameter\":{\"type\":\"string\",\"description\":\"Trigger Parameter that uses the secret\"}},\"description\":\"Auth Secrets for Scale Rule\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Authentication secrets for the custom scale rule.\"},\"metadata\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"properties\":{}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Metadata properties to describe http scale rule.\"}},\"description\":\"Container App container Http scaling rule.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App container Http scaling rule.\"},\"name\":{\"type\":\"string\",\"description\":\"Scale Rule Name\"},\"tcp\":{\"oneOf\":[{\"type\":\"object\",\"properties\":{\"auth\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the secret from which to pull the auth params.\"},\"triggerParameter\":{\"type\":\"string\",\"description\":\"Trigger Parameter that uses the secret\"}},\"description\":\"Auth Secrets for Scale Rule\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Authentication secrets for the tcp scale rule.\"},\"metadata\":{\"oneOf\":[{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"},\"properties\":{}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Metadata properties to describe tcp scale rule.\"}},\"description\":\"Container App container Tcp scaling rule.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App container Tcp scaling rule.\"}},\"description\":\"Container App container scaling rule.\",\"additionalProperties\":false}},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Scaling rules.\"}},\"description\":\"Container App scaling configurations.\",\"additionalProperties\":false},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Container App scaling configurations.\"},\"serviceBinds\":{\"$comment\":\"The value of 'null' is UNDOCUMENTED.\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the service bind\"},\"serviceId\":{\"type\":\"string\",\"description\":\"Resource id of the target service\"}},\"description\":\"Configuration to bind a ContainerApp to a dev ContainerApp Service\",\"additionalProperties\":false}},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"List of container app services bound to the app\"},\"terminationGracePeriodSeconds\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.\"},\"volumes\":{\"$comment\":\"The value of 'null' is UNDOCUMENTED.\",\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"mountOptions\":{\"type\":\"string\",\"description\":\"Mount options used while mounting the AzureFile. Must be a comma-separated string.\"},\"name\":{\"type\":\"string\",\"description\":\"Volume name.\"},\"secrets\":{\"oneOf\":[{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\",\"description\":\"Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.\"},\"secretRef\":{\"type\":\"string\",\"description\":\"Name of the Container App secret from which to pull the secret value.\"}},\"description\":\"Secret to be added to volume.\",\"additionalProperties\":false}},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.\"},\"storageName\":{\"type\":\"string\",\"description\":\"Name of storage resource. No need to provide for EmptyDir and Secret.\"},\"storageType\":{\"oneOf\":[{\"type\":\"string\",\"enum\":[\"AzureFile\",\"EmptyDir\",\"Secret\"]},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"Storage type for the volume. If not provided, use EmptyDir.\"}},\"description\":\"Volume definitions for the Container App.\",\"additionalProperties\":false}},{\"type\":\"null\"},{\"type\":\"string\",\"pattern\":\"^\\\\[([^\\\\[].*)?\\\\]$\",\"description\":\"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax.\"}],\"description\":\"List of volume definitions for the Container App.\"}},\"additionalProperties\":true,\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"azure-containerapp-template\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/azure-containerapp-template.json","description":"Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created","properties":{"containers":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"args":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container start command arguments."},"command":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container start command."},"env":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"secretRef":{"type":"string","description":"Name of the Container App secret from which to pull the environment variable value."},"value":{"type":"string","description":"Non-secret environment variable value."}},"description":"Container App container environment variable.","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container environment variables."},"image":{"type":"string","description":"Container image tag."},"name":{"type":"string","description":"Custom container name."},"probes":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"failureThreshold":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10."},"httpGet":{"oneOf":[{"type":"object","properties":{"host":{"type":"string","description":"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."},"httpHeaders":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The header field name"},"value":{"type":"string","description":"The header field value"}},"required":[],"description":"HTTPHeader describes a custom header to be used in HTTP probes","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Custom headers to set in the request. HTTP allows repeated headers."},"path":{"type":"string","description":"Path to access on the HTTP server."},"port":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."},"scheme":{"oneOf":[{"type":"string","enum":["HTTP","HTTPS"]},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Scheme to use for connecting to the host. Defaults to HTTP."}},"required":[],"description":"HTTPGet specifies the http request to perform.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"HTTPGet specifies the http request to perform."},"initialDelaySeconds":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60."},"periodSeconds":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240."},"successThreshold":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10."},"tcpSocket":{"oneOf":[{"type":"object","properties":{"host":{"type":"string","description":"Optional: Host name to connect to, defaults to the pod IP."},"port":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME."}},"required":[],"description":"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported."},"terminationGracePeriodSeconds":{"$comment":"The value of 'null' is UNDOCUMENTED.","oneOf":[{"type":"integer"},{"type":"null"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)"},"timeoutSeconds":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240."},"type":{"oneOf":[{"type":"string","enum":["Liveness","Readiness","Startup"]},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"The type of probe."}},"description":"Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"List of probes for the container."},"resources":{"oneOf":[{"type":"object","properties":{"cpu":{"oneOf":[{"type":"number"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Required CPU in cores, e.g. 0.5"},"memory":{"type":"string","description":"Required memory, e.g. \"250Mb\""},"ephemeralStorage":{"type":"string","description":"UNDOCUMENTED. The total amount of storage available to each replica."}},"description":"Container App container resource requirements.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App container resource requirements."},"volumeMounts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"mountPath":{"type":"string","description":"Path within the container at which the volume should be mounted.Must not contain ':'."},"subPath":{"type":"string","description":"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."},"volumeName":{"type":"string","description":"This must match the Name of a Volume."}},"description":"Volume mount for the Container App.","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container volume mounts."}},"description":"Container App container definition","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"List of container definitions for the Container App."},"initContainers":{"oneOf":[{"type":"null"},{"type":"array","items":{"type":"object","properties":{"args":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container start command arguments."},"command":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container start command."},"env":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Environment variable name."},"secretRef":{"type":"string","description":"Name of the Container App secret from which to pull the environment variable value."},"value":{"type":"string","description":"Non-secret environment variable value."}},"description":"Container App container environment variable.","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container environment variables."},"image":{"type":"string","description":"Container image tag."},"name":{"type":"string","description":"Custom container name."},"resources":{"oneOf":[{"type":"object","properties":{"cpu":{"oneOf":[{"type":"number"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Required CPU in cores, e.g. 0.5"},"memory":{"type":"string","description":"Required memory, e.g. \"250Mb\""}},"description":"Container App container resource requirements.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App container resource requirements."},"volumeMounts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"mountPath":{"type":"string","description":"Path within the container at which the volume should be mounted.Must not contain ':'."},"subPath":{"type":"string","description":"Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)."},"volumeName":{"type":"string","description":"This must match the Name of a Volume."}},"description":"Volume mount for the Container App.","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container volume mounts."}},"description":"Container App init container definition","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"List of specialized containers that run before app containers."},"revisionSuffix":{"type":"string","description":"User friendly suffix that is appended to the revision name"},"scale":{"oneOf":[{"type":"object","properties":{"maxReplicas":{"oneOf":[{"type":"integer","default":"10"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Optional. Maximum number of container replicas. Defaults to 10 if not set."},"minReplicas":{"$comment":"The value of 'null' is UNDOCUMENTED.","oneOf":[{"type":"integer"},{"type":"null"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Optional. Minimum number of container replicas."},"rules":{"$comment":"The value of 'null' is UNDOCUMENTED.","oneOf":[{"type":"array","items":{"type":"object","properties":{"azureQueue":{"oneOf":[{"type":"object","properties":{"auth":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"secretRef":{"type":"string","description":"Name of the secret from which to pull the auth params."},"triggerParameter":{"type":"string","description":"Trigger Parameter that uses the secret"}},"description":"Auth Secrets for Scale Rule","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Authentication secrets for the queue scale rule."},"queueLength":{"oneOf":[{"type":"integer"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Queue length."},"queueName":{"type":"string","description":"Queue name."}},"description":"Container App container Azure Queue based scaling rule.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App container Azure Queue based scaling rule."},"custom":{"oneOf":[{"type":"object","properties":{"auth":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"secretRef":{"type":"string","description":"Name of the secret from which to pull the auth params."},"triggerParameter":{"type":"string","description":"Trigger Parameter that uses the secret"}},"description":"Auth Secrets for Scale Rule","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Authentication secrets for the custom scale rule."},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"properties":{}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Metadata properties to describe custom scale rule."},"type":{"type":"string","description":"Type of the custom scale rule\neg: azure-servicebus, redis etc."}},"description":"Container App container Custom scaling rule.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App container Custom scaling rule."},"http":{"oneOf":[{"type":"object","properties":{"auth":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"secretRef":{"type":"string","description":"Name of the secret from which to pull the auth params."},"triggerParameter":{"type":"string","description":"Trigger Parameter that uses the secret"}},"description":"Auth Secrets for Scale Rule","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Authentication secrets for the custom scale rule."},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"properties":{}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Metadata properties to describe http scale rule."}},"description":"Container App container Http scaling rule.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App container Http scaling rule."},"name":{"type":"string","description":"Scale Rule Name"},"tcp":{"oneOf":[{"type":"object","properties":{"auth":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"secretRef":{"type":"string","description":"Name of the secret from which to pull the auth params."},"triggerParameter":{"type":"string","description":"Trigger Parameter that uses the secret"}},"description":"Auth Secrets for Scale Rule","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Authentication secrets for the tcp scale rule."},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"properties":{}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Metadata properties to describe tcp scale rule."}},"description":"Container App container Tcp scaling rule.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App container Tcp scaling rule."}},"description":"Container App container scaling rule.","additionalProperties":false}},{"type":"null"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Scaling rules."}},"description":"Container App scaling configurations.","additionalProperties":false},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Container App scaling configurations."},"serviceBinds":{"$comment":"The value of 'null' is UNDOCUMENTED.","oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the service bind"},"serviceId":{"type":"string","description":"Resource id of the target service"}},"description":"Configuration to bind a ContainerApp to a dev ContainerApp Service","additionalProperties":false}},{"type":"null"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"List of container app services bound to the app"},"terminationGracePeriodSeconds":{"oneOf":[{"type":"integer"},{"type":"null"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds."},"volumes":{"$comment":"The value of 'null' is UNDOCUMENTED.","oneOf":[{"type":"array","items":{"type":"object","properties":{"mountOptions":{"type":"string","description":"Mount options used while mounting the AzureFile. Must be a comma-separated string."},"name":{"type":"string","description":"Volume name."},"secrets":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef."},"secretRef":{"type":"string","description":"Name of the Container App secret from which to pull the secret value."}},"description":"Secret to be added to volume.","additionalProperties":false}},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume."},"storageName":{"type":"string","description":"Name of storage resource. No need to provide for EmptyDir and Secret."},"storageType":{"oneOf":[{"type":"string","enum":["AzureFile","EmptyDir","Secret"]},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"Storage type for the volume. If not provided, use EmptyDir."}},"description":"Volume definitions for the Container App.","additionalProperties":false}},{"type":"null"},{"type":"string","pattern":"^\\[([^\\[].*)?\\]$","description":"Deployment template expression. See https://aka.ms/arm-template-expressions for more details on the ARM expression syntax."}],"description":"List of volume definitions for the Container App."}},"additionalProperties":true,"type":"object"}
|
Provide a JSON object that satisfies the schema "azure-containerapp-template". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
azure-containerapp-template
|
schema-store
|
schema_store_73
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json\",\"definitions\":{\"instructions\":{\"type\":\"object\",\"title\":\"Installation instructions\",\"description\":\"Update installation instructions.\",\"properties\":{\"steps\":{\"type\":\"array\",\"title\":\"Installation steps\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/inlineStep\"},{\"$ref\":\"#/definitions/referenceStep\"}]},\"minItems\":1,\"maxItems\":10}},\"additionalProperties\":false,\"required\":[\"steps\"]},\"stepDescription\":{\"type\":\"string\",\"title\":\"Step description\",\"description\":\"Optional instruction step description.\",\"minLength\":1,\"maxLength\":64},\"inlineStep\":{\"type\":\"object\",\"title\":\"Inline installation step\",\"description\":\"Installation instruction step that performs code execution.\",\"properties\":{\"type\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepType\"},\"description\":{\"$ref\":\"#/definitions/stepDescription\"},\"handler\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandler\"},\"files\":{\"type\":\"array\",\"title\":\"Step update files\",\"description\":\"Names of update files that agent will pass to handler.\",\"items\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/filename\"},\"minItems\":1,\"maxItems\":10},\"handlerProperties\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandlerProperties\"}},\"additionalProperties\":false,\"required\":[\"handler\",\"files\"]},\"referenceStep\":{\"type\":\"object\",\"title\":\"Reference installation step\",\"description\":\"Installation instruction step that installs another update.\",\"properties\":{\"type\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/referenceStepType\"},\"description\":{\"$ref\":\"#/definitions/stepDescription\"},\"updateId\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId\"}},\"additionalProperties\":false,\"required\":[\"type\",\"updateId\"]}},\"description\":\"Schema for import manifest used for importing an update to Device Update for IoT Hub.\",\"examples\":[{\"updateId\":{\"provider\":\"Microsoft\",\"name\":\"Toaster\",\"version\":\"1.0\"},\"description\":\"Example update\",\"compatibility\":[{\"deviceManufacturer\":\"Microsoft\",\"deviceModel\":\"Toaster\"}],\"instructions\":{\"steps\":[{\"description\":\"pre-install script\",\"handler\":\"microsoft/script:1\",\"handlerProperties\":{\"arguments\":\"--pre-install\"},\"files\":[\"configure.sh\"]},{\"type\":\"reference\",\"updateId\":{\"provider\":\"Microsoft\",\"name\":\"Sensor\",\"version\":\"1.0\"}}]},\"files\":[{\"filename\":\"configure.sh\",\"sizeInBytes\":718,\"hashes\":{\"sha256\":\"mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs=\"},\"relatedFiles\":[{\"filename\":\"in1_in2_deltaupdate.dat\",\"sizeInBytes\":102910752,\"hashes\":{\"sha256\":\"2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY=\"},\"properties\":{\"microsoft.sourceFileHashAlgorithm\":\"sha256\",\"microsoft.sourceFileHash\":\"YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24=\"}}],\"downloadHandler\":{\"id\":\"microsoft/delta:1\"}}],\"manifestVersion\":\"5.0\",\"createdDateTime\":\"2020-10-02T22:18:04.9446744Z\"}],\"properties\":{\"$schema\":{\"type\":\"string\",\"description\":\"JSON schema reference.\"},\"updateId\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId\"},\"description\":{\"type\":\"string\",\"title\":\"Update description\",\"description\":\"Optional update description.\",\"minLength\":1,\"maxLength\":512},\"compatibility\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/compatibility\"},\"instructions\":{\"$ref\":\"#/definitions/instructions\"},\"files\":{\"type\":\"array\",\"title\":\"Update files\",\"description\":\"List of update payload files. Sum of all file sizes may not exceed 2 GB. May be empty or null if all instruction steps are reference steps.\",\"items\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file\"},\"minItems\":0,\"maxItems\":10},\"manifestVersion\":{\"type\":\"string\",\"title\":\"Import manifest schema version\",\"description\":\"Import manifest schema version. Must be 5.0.\",\"const\":\"5.0\"},\"createdDateTime\":{\"type\":\"string\",\"title\":\"Created date & time\",\"description\":\"Date & time import manifest was created in ISO 8601 format.\",\"examples\":[\"2020-10-02T22:18:04.9446744Z\"]}},\"required\":[\"updateId\",\"compatibility\",\"instructions\",\"manifestVersion\",\"createdDateTime\"],\"title\":\"JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0\". Here are the required top‑level fields: updateId, compatibility, instructions, manifestVersion, createdDateTime. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json","definitions":{"instructions":{"type":"object","title":"Installation instructions","description":"Update installation instructions.","properties":{"steps":{"type":"array","title":"Installation steps","items":{"anyOf":[{"$ref":"#/definitions/inlineStep"},{"$ref":"#/definitions/referenceStep"}]},"minItems":1,"maxItems":10}},"additionalProperties":false,"required":["steps"]},"stepDescription":{"type":"string","title":"Step description","description":"Optional instruction step description.","minLength":1,"maxLength":64},"inlineStep":{"type":"object","title":"Inline installation step","description":"Installation instruction step that performs code execution.","properties":{"type":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepType"},"description":{"$ref":"#/definitions/stepDescription"},"handler":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandler"},"files":{"type":"array","title":"Step update files","description":"Names of update files that agent will pass to handler.","items":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/filename"},"minItems":1,"maxItems":10},"handlerProperties":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandlerProperties"}},"additionalProperties":false,"required":["handler","files"]},"referenceStep":{"type":"object","title":"Reference installation step","description":"Installation instruction step that installs another update.","properties":{"type":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/referenceStepType"},"description":{"$ref":"#/definitions/stepDescription"},"updateId":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId"}},"additionalProperties":false,"required":["type","updateId"]}},"description":"Schema for import manifest used for importing an update to Device Update for IoT Hub.","examples":[{"updateId":{"provider":"Microsoft","name":"Toaster","version":"1.0"},"description":"Example update","compatibility":[{"deviceManufacturer":"Microsoft","deviceModel":"Toaster"}],"instructions":{"steps":[{"description":"pre-install script","handler":"microsoft/script:1","handlerProperties":{"arguments":"--pre-install"},"files":["configure.sh"]},{"type":"reference","updateId":{"provider":"Microsoft","name":"Sensor","version":"1.0"}}]},"files":[{"filename":"configure.sh","sizeInBytes":718,"hashes":{"sha256":"mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="},"relatedFiles":[{"filename":"in1_in2_deltaupdate.dat","sizeInBytes":102910752,"hashes":{"sha256":"2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="},"properties":{"microsoft.sourceFileHashAlgorithm":"sha256","microsoft.sourceFileHash":"YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="}}],"downloadHandler":{"id":"microsoft/delta:1"}}],"manifestVersion":"5.0","createdDateTime":"2020-10-02T22:18:04.9446744Z"}],"properties":{"$schema":{"type":"string","description":"JSON schema reference."},"updateId":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId"},"description":{"type":"string","title":"Update description","description":"Optional update description.","minLength":1,"maxLength":512},"compatibility":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/compatibility"},"instructions":{"$ref":"#/definitions/instructions"},"files":{"type":"array","title":"Update files","description":"List of update payload files. Sum of all file sizes may not exceed 2 GB. May be empty or null if all instruction steps are reference steps.","items":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file"},"minItems":0,"maxItems":10},"manifestVersion":{"type":"string","title":"Import manifest schema version","description":"Import manifest schema version. Must be 5.0.","const":"5.0"},"createdDateTime":{"type":"string","title":"Created date & time","description":"Date & time import manifest was created in ISO 8601 format.","examples":["2020-10-02T22:18:04.9446744Z"]}},"required":["updateId","compatibility","instructions","manifestVersion","createdDateTime"],"title":"JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0". Here are the required top‑level fields: updateId, compatibility, instructions, manifestVersion, createdDateTime. Return only the valid JSON object.
|
JSON Schema for Azure Device Update for IoT Hub 'Import Manifest' version 5.0
|
schema-store
|
schema_store_74
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/azure-deviceupdate-update-manifest-5.json\",\"definitions\":{\"miniUpdateManifest\":{\"type\":\"object\",\"title\":\"Mini update manifest\",\"description\":\"Manifest containing metadata of the detached, downloadable, complete update manifest.\",\"properties\":{\"detachedManifestFileId\":{\"$ref\":\"#/definitions/fileId\"},\"files\":{\"type\":\"object\",\"title\":\"Update manifest file\",\"description\":\"Map of '#/definitions/fileId' to file metadata.\",\"additionalProperties\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file\"},\"minProperties\":1,\"maxProperties\":1}},\"required\":[\"detachedManifestFileId\",\"files\"]},\"fullUpdateManifest\":{\"type\":\"object\",\"title\":\"Complete update manifest.\",\"description\":\"Full update manifest containing metadata of the update being deployed.\",\"properties\":{\"compatibility\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/compatibility\"},\"instructions\":{\"type\":\"object\",\"title\":\"Installation instructions\",\"properties\":{\"steps\":{\"type\":\"array\",\"title\":\"Installation steps\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/inlineStep\"},{\"$ref\":\"#/definitions/referenceStep\"}]},\"minItems\":1,\"maxItems\":10}},\"required\":[\"steps\"]},\"files\":{\"type\":\"object\",\"title\":\"Update files\",\"description\":\"Map of '#/definitions/fileId' to file metadata.\",\"additionalProperties\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file\"},\"minProperties\":1,\"maxProperties\":20},\"createdDateTime\":{\"type\":\"string\",\"title\":\"Created date & time\",\"description\":\"Date & time update was created in ISO 8601 format.\",\"examples\":[\"2020-10-02T22:18:04.9446744Z\"]}},\"required\":[\"compatibility\",\"instructions\",\"files\",\"createdDateTime\"]},\"fileId\":{\"type\":\"string\",\"title\":\"Update file id\",\"description\":\"Server generated file identifier to be used for retrieving file metadata and download URL.\",\"minLength\":1},\"inlineStep\":{\"type\":\"object\",\"title\":\"Inline installation step\",\"description\":\"Installation instruction step that performs code execution.\",\"properties\":{\"type\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepType\"},\"handler\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandler\"},\"files\":{\"type\":\"array\",\"title\":\"Step update files\",\"description\":\"'fileId' of update files that agent will pass to handler.\",\"items\":{\"$ref\":\"#/definitions/fileId\"},\"minItems\":1,\"maxItems\":10},\"handlerProperties\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandlerProperties\"}},\"additionalProperties\":false,\"required\":[\"handler\",\"files\"]},\"referenceStep\":{\"type\":\"object\",\"title\":\"Reference installation step\",\"description\":\"Installation instruction step that installs another update.\",\"properties\":{\"type\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/referenceStepType\"},\"detachedManifestFileId\":{\"$ref\":\"#/definitions/fileId\"}},\"additionalProperties\":false,\"required\":[\"type\",\"detachedManifestFileId\"]}},\"description\":\"JSON schema of update manifest sent by Device Update for IoT Hub to device agent during deployment.\",\"examples\":[{\"manifestVersion\":\"4\",\"updateId\":{\"provider\":\"Microsoft\",\"name\":\"Toaster\",\"version\":\"1.0\"},\"compatibility\":[{\"deviceManufacturer\":\"Microsoft\",\"deviceModel\":\"Toaster\"}],\"instructions\":{\"steps\":[{\"handler\":\"microsoft/script:1\",\"handlerProperties\":{\"arguments\":\"--pre-install\"},\"files\":[\"fileId0\"]},{\"type\":\"reference\",\"detachedManifestFileId\":\"fileId1\"}]},\"files\":{\"fileId0\":{\"filename\":\"configure.sh\",\"sizeInBytes\":718,\"hashes\":{\"sha256\":\"mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs=\"},\"relatedFiles\":[{\"filename\":\"in1_in2_deltaupdate.dat\",\"sizeInBytes\":102910752,\"hashes\":{\"sha256\":\"2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY=\"},\"properties\":{\"microsoft.sourceFileHashAlgorithm\":\"sha256\",\"microsoft.sourceFileHash\":\"YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24=\"}}],\"downloadHandler\":{\"id\":\"microsoft/delta:1\"}},\"fileId1\":{\"filename\":\"microsoft.sensor.1.0.updatemanifest.json\",\"sizeInBytes\":2048,\"hashes\":{\"sha256\":\"789s9PDfX4uA9wFUubyC30BWkLFbgmpkpmz1fEdqo2U=\"}}},\"createdDateTime\":\"2021-09-28T18:32:01.8404544Z\"}],\"oneOf\":[{\"$ref\":\"#/definitions/miniUpdateManifest\"},{\"$ref\":\"#/definitions/fullUpdateManifest\"}],\"properties\":{\"$schema\":{\"type\":\"string\",\"description\":\"JSON schema reference\"},\"updateId\":{\"$ref\":\"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId\"},\"manifestVersion\":{\"type\":\"string\",\"title\":\"Update manifest schema version\",\"const\":\"4\"}},\"required\":[\"updateId\",\"manifestVersion\"],\"title\":\"JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0\". Here are the required top‑level fields: updateId, manifestVersion. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/azure-deviceupdate-update-manifest-5.json","definitions":{"miniUpdateManifest":{"type":"object","title":"Mini update manifest","description":"Manifest containing metadata of the detached, downloadable, complete update manifest.","properties":{"detachedManifestFileId":{"$ref":"#/definitions/fileId"},"files":{"type":"object","title":"Update manifest file","description":"Map of '#/definitions/fileId' to file metadata.","additionalProperties":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file"},"minProperties":1,"maxProperties":1}},"required":["detachedManifestFileId","files"]},"fullUpdateManifest":{"type":"object","title":"Complete update manifest.","description":"Full update manifest containing metadata of the update being deployed.","properties":{"compatibility":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/compatibility"},"instructions":{"type":"object","title":"Installation instructions","properties":{"steps":{"type":"array","title":"Installation steps","items":{"anyOf":[{"$ref":"#/definitions/inlineStep"},{"$ref":"#/definitions/referenceStep"}]},"minItems":1,"maxItems":10}},"required":["steps"]},"files":{"type":"object","title":"Update files","description":"Map of '#/definitions/fileId' to file metadata.","additionalProperties":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/file"},"minProperties":1,"maxProperties":20},"createdDateTime":{"type":"string","title":"Created date & time","description":"Date & time update was created in ISO 8601 format.","examples":["2020-10-02T22:18:04.9446744Z"]}},"required":["compatibility","instructions","files","createdDateTime"]},"fileId":{"type":"string","title":"Update file id","description":"Server generated file identifier to be used for retrieving file metadata and download URL.","minLength":1},"inlineStep":{"type":"object","title":"Inline installation step","description":"Installation instruction step that performs code execution.","properties":{"type":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepType"},"handler":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandler"},"files":{"type":"array","title":"Step update files","description":"'fileId' of update files that agent will pass to handler.","items":{"$ref":"#/definitions/fileId"},"minItems":1,"maxItems":10},"handlerProperties":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/inlineStepHandlerProperties"}},"additionalProperties":false,"required":["handler","files"]},"referenceStep":{"type":"object","title":"Reference installation step","description":"Installation instruction step that installs another update.","properties":{"type":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/referenceStepType"},"detachedManifestFileId":{"$ref":"#/definitions/fileId"}},"additionalProperties":false,"required":["type","detachedManifestFileId"]}},"description":"JSON schema of update manifest sent by Device Update for IoT Hub to device agent during deployment.","examples":[{"manifestVersion":"4","updateId":{"provider":"Microsoft","name":"Toaster","version":"1.0"},"compatibility":[{"deviceManufacturer":"Microsoft","deviceModel":"Toaster"}],"instructions":{"steps":[{"handler":"microsoft/script:1","handlerProperties":{"arguments":"--pre-install"},"files":["fileId0"]},{"type":"reference","detachedManifestFileId":"fileId1"}]},"files":{"fileId0":{"filename":"configure.sh","sizeInBytes":718,"hashes":{"sha256":"mcB5SexMU4JOOzqmlJqKbue9qMskWY3EI/iVjJxCtAs="},"relatedFiles":[{"filename":"in1_in2_deltaupdate.dat","sizeInBytes":102910752,"hashes":{"sha256":"2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="},"properties":{"microsoft.sourceFileHashAlgorithm":"sha256","microsoft.sourceFileHash":"YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="}}],"downloadHandler":{"id":"microsoft/delta:1"}},"fileId1":{"filename":"microsoft.sensor.1.0.updatemanifest.json","sizeInBytes":2048,"hashes":{"sha256":"789s9PDfX4uA9wFUubyC30BWkLFbgmpkpmz1fEdqo2U="}}},"createdDateTime":"2021-09-28T18:32:01.8404544Z"}],"oneOf":[{"$ref":"#/definitions/miniUpdateManifest"},{"$ref":"#/definitions/fullUpdateManifest"}],"properties":{"$schema":{"type":"string","description":"JSON schema reference"},"updateId":{"$ref":"azure-deviceupdate-manifest-definitions-5.0.json#/definitions/updateId"},"manifestVersion":{"type":"string","title":"Update manifest schema version","const":"4"}},"required":["updateId","manifestVersion"],"title":"JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0". Here are the required top‑level fields: updateId, manifestVersion. Return only the valid JSON object.
|
JSON Schema for Azure Device Update for IoT Hub 'Update Manifest' version 4.0
|
schema-store
|
schema_store_75
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/azure-devops-extension-manifest-1.0.json\",\"definitions\":{\"Badge\":{\"description\":\"A link to external metadata badge.\",\"properties\":{\"href\":{\"description\":\"Link the user navigates to when selecting the badge.\",\"type\":\"string\"},\"uri\":{\"description\":\"The absolute URL of the badge image to be displayed.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the badge, to be displayed on hover.\",\"type\":\"string\"}},\"required\":[\"uri\"],\"title\":\"badge\",\"type\":\"object\"},\"Content\":{\"description\":\"A content file that describes the extension to users.\",\"properties\":{\"path\":{\"description\":\"The path to the file in the extension.\",\"type\":\"string\"}},\"required\":[\"path\"],\"title\":\"content\",\"type\":\"object\"},\"Contribution\":{\"description\":\"An individual contribution made by an extension\",\"properties\":{\"constraints\":{\"description\":\"List of constraints (filters) that should be applied to the availability of this contribution\",\"items\":{\"$ref\":\"#/definitions/ContributionConstraint\"},\"type\":\"array\"},\"description\":{\"description\":\"Description of the contribution/type\",\"type\":\"string\"},\"id\":{\"description\":\"Fully qualified identifier of the contribution/type\",\"type\":\"string\"},\"includes\":{\"description\":\"Includes is a set of contributions that should have this contribution included in their targets list.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"properties\":{\"description\":\"Properties/attributes of this contribution\"},\"restrictedTo\":{\"description\":\"List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"targets\":{\"description\":\"The ids of the contribution(s) that this contribution targets. (parent contributions)\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type\":{\"description\":\"Id of the Contribution Type\",\"type\":\"string\"},\"visibleTo\":{\"description\":\"VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: \\\"ms\\\" - Means only the \\\"ms\\\" publisher can reference this. \\\"ms.vss-web\\\" - Means only the \\\"vss-web\\\" extension from the \\\"ms\\\" publisher can reference this.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"id\",\"targets\",\"type\"],\"title\":\"contribution\",\"type\":\"object\"},\"ContributionConstraint\":{\"description\":\"Specifies a constraint that can be used to dynamically include/exclude a given contribution\",\"properties\":{\"group\":{\"description\":\"An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).\",\"type\":\"number\"},\"id\":{\"description\":\"Fully qualified identifier of a shared constraint\",\"type\":\"string\"},\"inverse\":{\"description\":\"If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)\",\"type\":\"boolean\"},\"name\":{\"description\":\"Name of the IContributionFilter plugin\",\"type\":\"string\"},\"properties\":{\"description\":\"Properties that are fed to the contribution filter class\"},\"relationships\":{\"description\":\"Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"type\":\"object\"},\"ContributionLicensingBehaviorType\":{\"description\":\"Represents different ways of including contributions based on licensing\",\"enum\":[0,1,2],\"type\":\"number\"},\"ContributionPropertyDescription\":{\"description\":\"Description about a property of a contribution type\",\"properties\":{\"description\":{\"description\":\"Description of the property\",\"type\":\"string\"},\"name\":{\"description\":\"Name of the property\",\"type\":\"string\"},\"required\":{\"description\":\"True if this property is required\",\"type\":\"boolean\"},\"type\":{\"$ref\":\"#/definitions/ContributionPropertyType\",\"description\":\"The type of value used for this property\"}},\"type\":\"object\"},\"ContributionPropertyType\":{\"description\":\"The type of value used for a property\",\"enum\":[0,1,128,16,2,256,32,4,512,64,8],\"type\":\"number\"},\"ContributionType\":{\"description\":\"A contribution type, given by a json schema\",\"properties\":{\"description\":{\"description\":\"Description of the contribution/type\",\"type\":\"string\"},\"id\":{\"description\":\"Fully qualified identifier of the contribution/type\",\"type\":\"string\"},\"indexed\":{\"description\":\"Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type. NOTE: Only TrustedPartners are allowed to specify indexed contribution types.\",\"type\":\"boolean\"},\"name\":{\"description\":\"Friendly name of the contribution/type\",\"type\":\"string\"},\"properties\":{\"additionalProperties\":{\"$ref\":\"#/definitions/ContributionPropertyDescription\"},\"description\":\"Describes the allowed properties for this contribution type\",\"type\":\"object\"},\"visibleTo\":{\"description\":\"VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: \\\"ms\\\" - Means only the \\\"ms\\\" publisher can reference this. \\\"ms.vss-web\\\" - Means only the \\\"vss-web\\\" extension from the \\\"ms\\\" publisher can reference this.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"type\":\"object\"},\"ExtensionEventCallback\":{\"description\":\"Base class for an event callback for an extension\",\"properties\":{\"uri\":{\"description\":\"The uri of the endpoint that is hit when an event occurs\",\"type\":\"string\"}},\"type\":\"object\"},\"ExtensionEventCallbackCollection\":{\"description\":\"Collection of event callbacks - endpoints called when particular extension events occur.\",\"properties\":{\"postDisable\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"Optional. Defines an endpoint that gets called via a POST request to notify that an extension disable has occurred.\"},\"postEnable\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"Optional. Defines an endpoint that gets called via a POST request to notify that an extension enable has occurred.\"},\"postInstall\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"Optional. Defines an endpoint that gets called via a POST request to notify that an extension install has completed.\"},\"postUninstall\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"Optional. Defines an endpoint that gets called via a POST request to notify that an extension uninstall has occurred.\"},\"postUpdate\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"Optional. Defines an endpoint that gets called via a POST request to notify that an extension update has occurred.\"},\"preInstall\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"Optional. Defines an endpoint that gets called via a POST request to notify that an extension install is about to occur. Response indicates whether to proceed or abort.\"},\"versionCheck\":{\"$ref\":\"#/definitions/ExtensionEventCallback\",\"description\":\"For multi-version extensions, defines an endpoint that gets called via an OPTIONS request to determine the particular version of the extension to be used\"}},\"type\":\"object\"},\"ExtensionLicensing\":{\"description\":\"How an extension should handle including contributions based on licensing\",\"properties\":{\"overrides\":{\"description\":\"A list of contributions which deviate from the default licensing behavior\",\"items\":{\"$ref\":\"#/definitions/LicensingOverride\"},\"type\":\"array\"}},\"type\":\"object\"},\"File\":{\"properties\":{\"path\":{\"description\":\"Path to resource on disk, which can be relative to your root directory.\",\"type\":\"string\"},\"addressable\":{\"description\":\"(optional) Set to true if you want your file to be URL-addressable. Defaults to false.\",\"type\":\"boolean\"},\"packagePath\":{\"description\":\"(optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.\",\"type\":\"string\"},\"contentType\":{\"description\":\"(optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.\",\"type\":\"string\"},\"assetType\":{\"description\":\"(optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.\",\"type\":\"string\"},\"lang\":{\"description\":\"(optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.\",\"type\":\"string\"}},\"required\":[\"path\"],\"title\":\"file\",\"type\":\"object\"},\"LicensingOverride\":{\"description\":\"Maps a contribution to a licensing behavior\",\"properties\":{\"behavior\":{\"$ref\":\"#/definitions/ContributionLicensingBehaviorType\",\"description\":\"How the inclusion of this contribution should change based on licensing\"},\"id\":{\"description\":\"Fully qualified contribution id which we want to define licensing behavior for\",\"type\":\"string\"}},\"type\":\"object\"},\"Link\":{\"properties\":{\"uri\":{\"description\":\"The absolute URL of the link.\",\"type\":\"string\"}},\"title\":\"link\",\"type\":\"object\"},\"Target\":{\"properties\":{\"id\":{\"type\":\"string\",\"enum\":[\"Microsoft.VisualStudio.Services\",\"Microsoft.TeamFoundation.Server\",\"Microsoft.VisualStudio.Services.Integration\",\"Microsoft.TeamFoundation.Server.Integration\"]}},\"required\":[\"id\"],\"title\":\"target\",\"type\":\"object\"}},\"description\":\"Base class for extension properties which are shared by the extension manifest and the extension model\",\"properties\":{\"badges\":{\"description\":\"Array of links to external metadata badges like TravisCI, Appveyor, and so on, from the approved badges sites.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Badge\"}},\"baseUri\":{\"description\":\"Uri used as base for other relative uri's defined in extension\",\"type\":\"string\"},\"branding\":{\"description\":\"Dictionary of brand-related properties.\",\"properties\":{\"color\":{\"description\":\"Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).\",\"type\":\"string\"},\"theme\":{\"description\":\"Complements the color; use dark for dark branding colors, or light for lighter branding colors.\",\"type\":\"string\",\"enum\":[\"dark\",\"light\"]}},\"title\":\"branding\",\"type\":\"object\"},\"categories\":{\"description\":\"Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include. Valid values: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plans, and Azure Artifacts.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"Azure Repos\",\"Azure Boards\",\"Azure Pipelines\",\"Azure Test Plans\",\"Azure Artifacts\"]},\"minItems\":1},\"constraints\":{\"description\":\"List of shared constraints defined by this extension\",\"items\":{\"$ref\":\"#/definitions/ContributionConstraint\"},\"type\":\"array\"},\"content\":{\"description\":\"Dictionary of content files that describe your extension to users.\",\"properties\":{\"details\":{\"$ref\":\"#/definitions/Content\"}},\"additionalProperties\":{\"$ref\":\"#/definitions/Content\"},\"title\":\"content\",\"type\":\"object\"},\"contributionTypes\":{\"description\":\"List of contribution types defined by this extension\",\"items\":{\"$ref\":\"#/definitions/ContributionType\"},\"type\":\"array\"},\"contributions\":{\"description\":\"List of contributions made by this extension\",\"items\":{\"$ref\":\"#/definitions/Contribution\"},\"type\":\"array\"},\"demands\":{\"description\":\"List of explicit demands required by this extension\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"description\":{\"description\":\"A few sentences describing the extensions. Limited to 200 characters.\",\"type\":\"string\",\"maxLength\":200},\"eventCallbacks\":{\"$ref\":\"#/definitions/ExtensionEventCallbackCollection\",\"description\":\"Collection of endpoints that get called when particular extension events occur\"},\"fallbackBaseUri\":{\"description\":\"Secondary location that can be used as base for other relative uri's defined in extension\",\"type\":\"string\"},\"files\":{\"description\":\"The files section is where you reference any files you wish to include in your extension.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/File\"}},\"icons\":{\"description\":\"Dictionary of icons representing the extension.\",\"type\":\"object\",\"properties\":{\"default\":{\"description\":\"128x128 pixels\",\"type\":\"string\"}},\"additionalProperties\":{\"type\":\"string\"}},\"id\":{\"description\":\"The extension's identifier.\",\"type\":\"string\"},\"language\":{\"description\":\"Language Culture Name set by the Gallery\",\"type\":\"string\"},\"licensing\":{\"$ref\":\"#/definitions/ExtensionLicensing\",\"description\":\"How this extension behaves with respect to licensing\"},\"manifestVersion\":{\"description\":\"Version of the extension manifest format/content. Should be 1.\",\"type\":\"number\"},\"name\":{\"description\":\"A short, human-readable name of the extension. Limited to 200 characters.\",\"type\":\"string\",\"maxLength\":200},\"links\":{\"description\":\"Dictionary of links that help users learn more about your extension, get support, and move.\",\"type\":\"object\",\"properties\":{\"getstarted\":{\"$ref\":\"#/definitions/Link\"},\"learn\":{\"$ref\":\"#/definitions/Link\"},\"license\":{\"$ref\":\"#/definitions/Link\"},\"privacypolicy\":{\"$ref\":\"#/definitions/Link\"},\"support\":{\"$ref\":\"#/definitions/Link\"}},\"additionalProperties\":{\"$ref\":\"#/definitions/Link\"}},\"publisher\":{\"description\":\"The identifier of the publisher. This identifier must match the identifier the extension is published under.\",\"type\":\"string\"},\"repository\":{\"description\":\"Dictionary of properties describing the source code repository for the extension.\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"Type of repository. Example: git.\",\"type\":\"string\"},\"uri\":{\"description\":\"Absolute URL of the repository.\",\"type\":\"string\"}}},\"restrictedTo\":{\"description\":\"Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"scopes\":{\"description\":\"List of all oauth scopes required by this extension\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"screenshots\":{\"description\":\"Array of images that couldn't be included in your content.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Content\"}},\"serviceInstanceType\":{\"description\":\"The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed\",\"type\":\"string\"},\"tags\":{\"description\":\"Array of string tags to help users find your extension.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"targets\":{\"description\":\"The products and services supported by your integration or extension.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Target\"},\"minItems\":1},\"version\":{\"description\":\"A string specifying the version of an extension. Should be in the format major.minor.patch.\",\"type\":\"string\"}},\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"azure-devops-extension-manifest-1.0\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/azure-devops-extension-manifest-1.0.json","definitions":{"Badge":{"description":"A link to external metadata badge.","properties":{"href":{"description":"Link the user navigates to when selecting the badge.","type":"string"},"uri":{"description":"The absolute URL of the badge image to be displayed.","type":"string"},"description":{"description":"Description of the badge, to be displayed on hover.","type":"string"}},"required":["uri"],"title":"badge","type":"object"},"Content":{"description":"A content file that describes the extension to users.","properties":{"path":{"description":"The path to the file in the extension.","type":"string"}},"required":["path"],"title":"content","type":"object"},"Contribution":{"description":"An individual contribution made by an extension","properties":{"constraints":{"description":"List of constraints (filters) that should be applied to the availability of this contribution","items":{"$ref":"#/definitions/ContributionConstraint"},"type":"array"},"description":{"description":"Description of the contribution/type","type":"string"},"id":{"description":"Fully qualified identifier of the contribution/type","type":"string"},"includes":{"description":"Includes is a set of contributions that should have this contribution included in their targets list.","items":{"type":"string"},"type":"array"},"properties":{"description":"Properties/attributes of this contribution"},"restrictedTo":{"description":"List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).","items":{"type":"string"},"type":"array"},"targets":{"description":"The ids of the contribution(s) that this contribution targets. (parent contributions)","items":{"type":"string"},"type":"array"},"type":{"description":"Id of the Contribution Type","type":"string"},"visibleTo":{"description":"VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: \"ms\" - Means only the \"ms\" publisher can reference this. \"ms.vss-web\" - Means only the \"vss-web\" extension from the \"ms\" publisher can reference this.","items":{"type":"string"},"type":"array"}},"required":["id","targets","type"],"title":"contribution","type":"object"},"ContributionConstraint":{"description":"Specifies a constraint that can be used to dynamically include/exclude a given contribution","properties":{"group":{"description":"An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).","type":"number"},"id":{"description":"Fully qualified identifier of a shared constraint","type":"string"},"inverse":{"description":"If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)","type":"boolean"},"name":{"description":"Name of the IContributionFilter plugin","type":"string"},"properties":{"description":"Properties that are fed to the contribution filter class"},"relationships":{"description":"Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.","items":{"type":"string"},"type":"array"}},"type":"object"},"ContributionLicensingBehaviorType":{"description":"Represents different ways of including contributions based on licensing","enum":[0,1,2],"type":"number"},"ContributionPropertyDescription":{"description":"Description about a property of a contribution type","properties":{"description":{"description":"Description of the property","type":"string"},"name":{"description":"Name of the property","type":"string"},"required":{"description":"True if this property is required","type":"boolean"},"type":{"$ref":"#/definitions/ContributionPropertyType","description":"The type of value used for this property"}},"type":"object"},"ContributionPropertyType":{"description":"The type of value used for a property","enum":[0,1,128,16,2,256,32,4,512,64,8],"type":"number"},"ContributionType":{"description":"A contribution type, given by a json schema","properties":{"description":{"description":"Description of the contribution/type","type":"string"},"id":{"description":"Fully qualified identifier of the contribution/type","type":"string"},"indexed":{"description":"Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type. NOTE: Only TrustedPartners are allowed to specify indexed contribution types.","type":"boolean"},"name":{"description":"Friendly name of the contribution/type","type":"string"},"properties":{"additionalProperties":{"$ref":"#/definitions/ContributionPropertyDescription"},"description":"Describes the allowed properties for this contribution type","type":"object"},"visibleTo":{"description":"VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too. Examples: \"ms\" - Means only the \"ms\" publisher can reference this. \"ms.vss-web\" - Means only the \"vss-web\" extension from the \"ms\" publisher can reference this.","items":{"type":"string"},"type":"array"}},"type":"object"},"ExtensionEventCallback":{"description":"Base class for an event callback for an extension","properties":{"uri":{"description":"The uri of the endpoint that is hit when an event occurs","type":"string"}},"type":"object"},"ExtensionEventCallbackCollection":{"description":"Collection of event callbacks - endpoints called when particular extension events occur.","properties":{"postDisable":{"$ref":"#/definitions/ExtensionEventCallback","description":"Optional. Defines an endpoint that gets called via a POST request to notify that an extension disable has occurred."},"postEnable":{"$ref":"#/definitions/ExtensionEventCallback","description":"Optional. Defines an endpoint that gets called via a POST request to notify that an extension enable has occurred."},"postInstall":{"$ref":"#/definitions/ExtensionEventCallback","description":"Optional. Defines an endpoint that gets called via a POST request to notify that an extension install has completed."},"postUninstall":{"$ref":"#/definitions/ExtensionEventCallback","description":"Optional. Defines an endpoint that gets called via a POST request to notify that an extension uninstall has occurred."},"postUpdate":{"$ref":"#/definitions/ExtensionEventCallback","description":"Optional. Defines an endpoint that gets called via a POST request to notify that an extension update has occurred."},"preInstall":{"$ref":"#/definitions/ExtensionEventCallback","description":"Optional. Defines an endpoint that gets called via a POST request to notify that an extension install is about to occur. Response indicates whether to proceed or abort."},"versionCheck":{"$ref":"#/definitions/ExtensionEventCallback","description":"For multi-version extensions, defines an endpoint that gets called via an OPTIONS request to determine the particular version of the extension to be used"}},"type":"object"},"ExtensionLicensing":{"description":"How an extension should handle including contributions based on licensing","properties":{"overrides":{"description":"A list of contributions which deviate from the default licensing behavior","items":{"$ref":"#/definitions/LicensingOverride"},"type":"array"}},"type":"object"},"File":{"properties":{"path":{"description":"Path to resource on disk, which can be relative to your root directory.","type":"string"},"addressable":{"description":"(optional) Set to true if you want your file to be URL-addressable. Defaults to false.","type":"boolean"},"packagePath":{"description":"(optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.","type":"string"},"contentType":{"description":"(optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.","type":"string"},"assetType":{"description":"(optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.","type":"string"},"lang":{"description":"(optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.","type":"string"}},"required":["path"],"title":"file","type":"object"},"LicensingOverride":{"description":"Maps a contribution to a licensing behavior","properties":{"behavior":{"$ref":"#/definitions/ContributionLicensingBehaviorType","description":"How the inclusion of this contribution should change based on licensing"},"id":{"description":"Fully qualified contribution id which we want to define licensing behavior for","type":"string"}},"type":"object"},"Link":{"properties":{"uri":{"description":"The absolute URL of the link.","type":"string"}},"title":"link","type":"object"},"Target":{"properties":{"id":{"type":"string","enum":["Microsoft.VisualStudio.Services","Microsoft.TeamFoundation.Server","Microsoft.VisualStudio.Services.Integration","Microsoft.TeamFoundation.Server.Integration"]}},"required":["id"],"title":"target","type":"object"}},"description":"Base class for extension properties which are shared by the extension manifest and the extension model","properties":{"badges":{"description":"Array of links to external metadata badges like TravisCI, Appveyor, and so on, from the approved badges sites.","type":"array","items":{"$ref":"#/definitions/Badge"}},"baseUri":{"description":"Uri used as base for other relative uri's defined in extension","type":"string"},"branding":{"description":"Dictionary of brand-related properties.","properties":{"color":{"description":"Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).","type":"string"},"theme":{"description":"Complements the color; use dark for dark branding colors, or light for lighter branding colors.","type":"string","enum":["dark","light"]}},"title":"branding","type":"object"},"categories":{"description":"Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include. Valid values: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plans, and Azure Artifacts.","type":"array","items":{"type":"string","enum":["Azure Repos","Azure Boards","Azure Pipelines","Azure Test Plans","Azure Artifacts"]},"minItems":1},"constraints":{"description":"List of shared constraints defined by this extension","items":{"$ref":"#/definitions/ContributionConstraint"},"type":"array"},"content":{"description":"Dictionary of content files that describe your extension to users.","properties":{"details":{"$ref":"#/definitions/Content"}},"additionalProperties":{"$ref":"#/definitions/Content"},"title":"content","type":"object"},"contributionTypes":{"description":"List of contribution types defined by this extension","items":{"$ref":"#/definitions/ContributionType"},"type":"array"},"contributions":{"description":"List of contributions made by this extension","items":{"$ref":"#/definitions/Contribution"},"type":"array"},"demands":{"description":"List of explicit demands required by this extension","items":{"type":"string"},"type":"array"},"description":{"description":"A few sentences describing the extensions. Limited to 200 characters.","type":"string","maxLength":200},"eventCallbacks":{"$ref":"#/definitions/ExtensionEventCallbackCollection","description":"Collection of endpoints that get called when particular extension events occur"},"fallbackBaseUri":{"description":"Secondary location that can be used as base for other relative uri's defined in extension","type":"string"},"files":{"description":"The files section is where you reference any files you wish to include in your extension.","type":"array","items":{"$ref":"#/definitions/File"}},"icons":{"description":"Dictionary of icons representing the extension.","type":"object","properties":{"default":{"description":"128x128 pixels","type":"string"}},"additionalProperties":{"type":"string"}},"id":{"description":"The extension's identifier.","type":"string"},"language":{"description":"Language Culture Name set by the Gallery","type":"string"},"licensing":{"$ref":"#/definitions/ExtensionLicensing","description":"How this extension behaves with respect to licensing"},"manifestVersion":{"description":"Version of the extension manifest format/content. Should be 1.","type":"number"},"name":{"description":"A short, human-readable name of the extension. Limited to 200 characters.","type":"string","maxLength":200},"links":{"description":"Dictionary of links that help users learn more about your extension, get support, and move.","type":"object","properties":{"getstarted":{"$ref":"#/definitions/Link"},"learn":{"$ref":"#/definitions/Link"},"license":{"$ref":"#/definitions/Link"},"privacypolicy":{"$ref":"#/definitions/Link"},"support":{"$ref":"#/definitions/Link"}},"additionalProperties":{"$ref":"#/definitions/Link"}},"publisher":{"description":"The identifier of the publisher. This identifier must match the identifier the extension is published under.","type":"string"},"repository":{"description":"Dictionary of properties describing the source code repository for the extension.","type":"object","properties":{"type":{"description":"Type of repository. Example: git.","type":"string"},"uri":{"description":"Absolute URL of the repository.","type":"string"}}},"restrictedTo":{"description":"Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.","items":{"type":"string"},"type":"array"},"scopes":{"description":"List of all oauth scopes required by this extension","items":{"type":"string"},"type":"array"},"screenshots":{"description":"Array of images that couldn't be included in your content.","type":"array","items":{"$ref":"#/definitions/Content"}},"serviceInstanceType":{"description":"The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed","type":"string"},"tags":{"description":"Array of string tags to help users find your extension.","type":"array","items":{"type":"string"}},"targets":{"description":"The products and services supported by your integration or extension.","type":"array","items":{"$ref":"#/definitions/Target"},"minItems":1},"version":{"description":"A string specifying the version of an extension. Should be in the format major.minor.patch.","type":"string"}},"type":"object"}
|
Provide a JSON object that satisfies the schema "azure-devops-extension-manifest-1.0". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
azure-devops-extension-manifest-1.0
|
schema-store
|
schema_store_76
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{\"moduleType\":{\"enum\":[\"docker\"]},\"status\":{\"enum\":[\"running\",\"stopped\"]},\"restartPolicy\":{\"enum\":[\"never\",\"on-failure\",\"on-unhealthy\",\"always\"]},\"imagePullPolicy\":{\"enum\":[\"never\",\"on-create\"]},\"startupOrder\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":4294967295},\"moduleSettings\":{\"type\":\"object\",\"required\":[\"image\"],\"properties\":{\"image\":{\"type\":\"string\",\"examples\":[\"mcr.microsoft.com/azureiotedge-agent:1.0\"]}},\"patternProperties\":{\"^(createoptions|createOptions)[0-9]*$\":{\"$ref\":\"#/definitions/createOptions\"}},\"additionalProperties\":false},\"env\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\+#$\\\\s\\\\.]+$\":{\"type\":\"object\",\"required\":[\"value\"],\"properties\":{\"value\":{\"type\":[\"number\",\"string\",\"boolean\"]}},\"additionalProperties\":false}},\"additionalProperties\":false},\"createOptions\":{\"type\":\"string\",\"contentMediaType\":\"application/json\"}},\"id\":\"https://json.schemastore.org/azure-iot-edge-deployment-2.0.json\",\"properties\":{\"modulesContent\":{\"type\":\"object\",\"title\":\"The configuration for all the modules.\",\"required\":[\"$edgeAgent\",\"$edgeHub\"],\"properties\":{\"$edgeAgent\":{\"type\":\"object\",\"title\":\"Configuration for the edgeAgent module\",\"required\":[\"properties.desired\"],\"properties\":{\"properties.desired\":{\"type\":\"object\",\"required\":[\"schemaVersion\",\"runtime\",\"systemModules\",\"modules\"],\"properties\":{\"schemaVersion\":{\"type\":\"string\",\"examples\":[\"1.0\",\"1.1\"]},\"runtime\":{\"type\":\"object\",\"required\":[\"type\",\"settings\"],\"properties\":{\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"settings\":{\"type\":\"object\",\"properties\":{\"minDockerVersion\":{\"type\":\"string\",\"examples\":[\"v1.25\"]},\"loggingOptions\":{\"type\":\"string\"},\"registryCredentials\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\.\\\\$# ]+$\":{\"type\":\"object\",\"required\":[\"username\",\"password\",\"address\"],\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"address\":{\"type\":\"string\",\"pattern\":\"^[^\\\\s]+$\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false},\"systemModules\":{\"type\":\"object\",\"required\":[\"edgeAgent\",\"edgeHub\"],\"properties\":{\"edgeAgent\":{\"type\":\"object\",\"required\":[\"type\",\"settings\"],\"properties\":{\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"imagePullPolicy\":{\"$ref\":\"#/definitions/imagePullPolicy\"}},\"additionalProperties\":false},\"edgeHub\":{\"type\":\"object\",\"title\":\"The Edgehub Schema\",\"required\":[\"type\",\"settings\",\"status\",\"restartPolicy\"],\"properties\":{\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"status\":{\"$ref\":\"#/definitions/status\"},\"restartPolicy\":{\"$ref\":\"#/definitions/restartPolicy\"},\"imagePullPolicy\":{\"$ref\":\"#/definitions/imagePullPolicy\"},\"startupOrder\":{\"$ref\":\"#/definitions/startupOrder\"}},\"additionalProperties\":false}},\"additionalProperties\":false},\"modules\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"required\":[\"type\",\"status\",\"restartPolicy\",\"settings\"],\"properties\":{\"version\":{\"type\":\"string\",\"examples\":[\"1.0\"]},\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"status\":{\"$ref\":\"#/definitions/status\"},\"restartPolicy\":{\"$ref\":\"#/definitions/restartPolicy\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"imagePullPolicy\":{\"$ref\":\"#/definitions/imagePullPolicy\"},\"startupOrder\":{\"$ref\":\"#/definitions/startupOrder\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false},\"$edgeHub\":{\"type\":\"object\",\"title\":\"Configuration for the edgeHub module\",\"required\":[\"properties.desired\"],\"properties\":{\"properties.desired\":{\"type\":\"object\",\"required\":[\"schemaVersion\",\"routes\"],\"properties\":{\"schemaVersion\":{\"type\":\"string\",\"examples\":[\"1.0\",\"1.1\"]},\"routes\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\.\\\\$# ]+$\":{\"anyOf\":[{\"type\":\"object\",\"required\":[\"route\"],\"properties\":{\"route\":{\"type\":\"string\",\"examples\":[\"FROM /* INTO $upstream\"],\"pattern\":\"^.+$\"},\"priority\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":9},\"timeToLiveSecs\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":4294967295}},\"additionalProperties\":false},{\"type\":\"string\",\"examples\":[\"FROM /* INTO $upstream\"],\"pattern\":\"^.+$\"}]}},\"additionalProperties\":false},\"storeAndForwardConfiguration\":{\"type\":\"object\",\"required\":[\"timeToLiveSecs\"],\"properties\":{\"timeToLiveSecs\":{\"type\":\"integer\",\"examples\":[7200]}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"required\":[\"properties.desired\"],\"properties\":{\"properties.desired\":{\"type\":\"object\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"required\":[\"modulesContent\"],\"title\":\"JSON schema for Azure IoT Edge Deployment version 2.0\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Azure IoT Edge Deployment version 2.0\". Here are the required top‑level fields: modulesContent. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"moduleType":{"enum":["docker"]},"status":{"enum":["running","stopped"]},"restartPolicy":{"enum":["never","on-failure","on-unhealthy","always"]},"imagePullPolicy":{"enum":["never","on-create"]},"startupOrder":{"type":"integer","minimum":0,"maximum":4294967295},"moduleSettings":{"type":"object","required":["image"],"properties":{"image":{"type":"string","examples":["mcr.microsoft.com/azureiotedge-agent:1.0"]}},"patternProperties":{"^(createoptions|createOptions)[0-9]*$":{"$ref":"#/definitions/createOptions"}},"additionalProperties":false},"env":{"type":"object","patternProperties":{"^[^\\+#$\\s\\.]+$":{"type":"object","required":["value"],"properties":{"value":{"type":["number","string","boolean"]}},"additionalProperties":false}},"additionalProperties":false},"createOptions":{"type":"string","contentMediaType":"application/json"}},"id":"https://json.schemastore.org/azure-iot-edge-deployment-2.0.json","properties":{"modulesContent":{"type":"object","title":"The configuration for all the modules.","required":["$edgeAgent","$edgeHub"],"properties":{"$edgeAgent":{"type":"object","title":"Configuration for the edgeAgent module","required":["properties.desired"],"properties":{"properties.desired":{"type":"object","required":["schemaVersion","runtime","systemModules","modules"],"properties":{"schemaVersion":{"type":"string","examples":["1.0","1.1"]},"runtime":{"type":"object","required":["type","settings"],"properties":{"type":{"$ref":"#/definitions/moduleType"},"settings":{"type":"object","properties":{"minDockerVersion":{"type":"string","examples":["v1.25"]},"loggingOptions":{"type":"string"},"registryCredentials":{"type":"object","patternProperties":{"^[^\\.\\$# ]+$":{"type":"object","required":["username","password","address"],"properties":{"username":{"type":"string"},"password":{"type":"string"},"address":{"type":"string","pattern":"^[^\\s]+$"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"systemModules":{"type":"object","required":["edgeAgent","edgeHub"],"properties":{"edgeAgent":{"type":"object","required":["type","settings"],"properties":{"type":{"$ref":"#/definitions/moduleType"},"settings":{"$ref":"#/definitions/moduleSettings"},"env":{"$ref":"#/definitions/env"},"imagePullPolicy":{"$ref":"#/definitions/imagePullPolicy"}},"additionalProperties":false},"edgeHub":{"type":"object","title":"The Edgehub Schema","required":["type","settings","status","restartPolicy"],"properties":{"type":{"$ref":"#/definitions/moduleType"},"settings":{"$ref":"#/definitions/moduleSettings"},"env":{"$ref":"#/definitions/env"},"status":{"$ref":"#/definitions/status"},"restartPolicy":{"$ref":"#/definitions/restartPolicy"},"imagePullPolicy":{"$ref":"#/definitions/imagePullPolicy"},"startupOrder":{"$ref":"#/definitions/startupOrder"}},"additionalProperties":false}},"additionalProperties":false},"modules":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","required":["type","status","restartPolicy","settings"],"properties":{"version":{"type":"string","examples":["1.0"]},"type":{"$ref":"#/definitions/moduleType"},"status":{"$ref":"#/definitions/status"},"restartPolicy":{"$ref":"#/definitions/restartPolicy"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/moduleSettings"},"imagePullPolicy":{"$ref":"#/definitions/imagePullPolicy"},"startupOrder":{"$ref":"#/definitions/startupOrder"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"$edgeHub":{"type":"object","title":"Configuration for the edgeHub module","required":["properties.desired"],"properties":{"properties.desired":{"type":"object","required":["schemaVersion","routes"],"properties":{"schemaVersion":{"type":"string","examples":["1.0","1.1"]},"routes":{"type":"object","patternProperties":{"^[^\\.\\$# ]+$":{"anyOf":[{"type":"object","required":["route"],"properties":{"route":{"type":"string","examples":["FROM /* INTO $upstream"],"pattern":"^.+$"},"priority":{"type":"integer","minimum":0,"maximum":9},"timeToLiveSecs":{"type":"integer","minimum":0,"maximum":4294967295}},"additionalProperties":false},{"type":"string","examples":["FROM /* INTO $upstream"],"pattern":"^.+$"}]}},"additionalProperties":false},"storeAndForwardConfiguration":{"type":"object","required":["timeToLiveSecs"],"properties":{"timeToLiveSecs":{"type":"integer","examples":[7200]}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","required":["properties.desired"],"properties":{"properties.desired":{"type":"object"}},"additionalProperties":false}},"additionalProperties":false}},"required":["modulesContent"],"title":"JSON schema for Azure IoT Edge Deployment version 2.0","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Azure IoT Edge Deployment version 2.0". Here are the required top‑level fields: modulesContent. Return only the valid JSON object.
|
JSON schema for Azure IoT Edge Deployment version 2.0
|
schema-store
|
schema_store_77
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"moduleSettings\":{\"type\":\"object\",\"required\":[\"image\"],\"properties\":{\"image\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleSettings/properties/image\"}},\"patternProperties\":{\"^(createoptions|createOptions)[0-9]*$\":{\"$ref\":\"#/definitions/createOptions\"}}},\"createOptions\":{\"type\":[\"object\",\"string\"],\"contentMediaType\":\"application/json\"}},\"id\":\"https://json.schemastore.org/azure-iot-edge-deployment-template-4.0.json\",\"properties\":{\"modulesContent\":{\"type\":\"object\",\"title\":\"The configuration for all the modules.\",\"required\":[\"$edgeAgent\"],\"properties\":{\"$edgeAgent\":{\"type\":\"object\",\"title\":\"Configuration for the edgeAgent module\",\"required\":[\"properties.desired\"],\"properties\":{\"properties.desired\":{\"type\":\"object\",\"required\":[\"schemaVersion\",\"runtime\",\"systemModules\",\"modules\"],\"properties\":{\"schemaVersion\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/properties/$edgeAgent/properties/properties.desired/properties/schemaVersion\"},\"runtime\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/properties/$edgeAgent/properties/properties.desired/properties/runtime\"},\"systemModules\":{\"type\":\"object\",\"required\":[\"edgeAgent\",\"edgeHub\"],\"properties\":{\"edgeAgent\":{\"type\":\"object\",\"required\":[\"type\",\"settings\"],\"properties\":{\"type\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"env\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env\"},\"imagePullPolicy\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy\"}}},\"edgeHub\":{\"type\":\"object\",\"title\":\"The Edgehub Schema\",\"required\":[\"type\",\"settings\",\"status\",\"restartPolicy\"],\"properties\":{\"type\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"env\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env\"},\"status\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/status\"},\"restartPolicy\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/restartPolicy\"},\"imagePullPolicy\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy\"},\"startupOrder\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/startupOrder\"}}}}},\"modules\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"required\":[\"type\",\"status\",\"restartPolicy\",\"settings\"],\"properties\":{\"version\":{\"type\":\"string\",\"examples\":[\"1.0\"]},\"type\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType\"},\"status\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/status\"},\"restartPolicy\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/restartPolicy\"},\"env\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"imagePullPolicy\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy\"},\"startupOrder\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/startupOrder\"}}}}}}}}},\"$edgeHub\":{\"$ref\":\"https://json.schemastore.org/azure-iot-edgehub-deployment-1.2.json#/properties/$edgeHub\"}}}},\"required\":[\"modulesContent\"],\"title\":\"JSON schema for Azure IoT Edge Deployment Template version 4.0 (Edge Agent schema v1.1 + Edge Hub schema v1.2 )\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Azure IoT Edge Deployment Template version 4.0 (Edge Agent schema v1.1 + Edge Hub schema v1.2 )\". Here are the required top‑level fields: modulesContent. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"moduleSettings":{"type":"object","required":["image"],"properties":{"image":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleSettings/properties/image"}},"patternProperties":{"^(createoptions|createOptions)[0-9]*$":{"$ref":"#/definitions/createOptions"}}},"createOptions":{"type":["object","string"],"contentMediaType":"application/json"}},"id":"https://json.schemastore.org/azure-iot-edge-deployment-template-4.0.json","properties":{"modulesContent":{"type":"object","title":"The configuration for all the modules.","required":["$edgeAgent"],"properties":{"$edgeAgent":{"type":"object","title":"Configuration for the edgeAgent module","required":["properties.desired"],"properties":{"properties.desired":{"type":"object","required":["schemaVersion","runtime","systemModules","modules"],"properties":{"schemaVersion":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/properties/$edgeAgent/properties/properties.desired/properties/schemaVersion"},"runtime":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/properties/$edgeAgent/properties/properties.desired/properties/runtime"},"systemModules":{"type":"object","required":["edgeAgent","edgeHub"],"properties":{"edgeAgent":{"type":"object","required":["type","settings"],"properties":{"type":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType"},"settings":{"$ref":"#/definitions/moduleSettings"},"env":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env"},"imagePullPolicy":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy"}}},"edgeHub":{"type":"object","title":"The Edgehub Schema","required":["type","settings","status","restartPolicy"],"properties":{"type":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType"},"settings":{"$ref":"#/definitions/moduleSettings"},"env":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env"},"status":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/status"},"restartPolicy":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/restartPolicy"},"imagePullPolicy":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy"},"startupOrder":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/startupOrder"}}}}},"modules":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","required":["type","status","restartPolicy","settings"],"properties":{"version":{"type":"string","examples":["1.0"]},"type":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/moduleType"},"status":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/status"},"restartPolicy":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/restartPolicy"},"env":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/env"},"settings":{"$ref":"#/definitions/moduleSettings"},"imagePullPolicy":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/imagePullPolicy"},"startupOrder":{"$ref":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json#/definitions/startupOrder"}}}}}}}}},"$edgeHub":{"$ref":"https://json.schemastore.org/azure-iot-edgehub-deployment-1.2.json#/properties/$edgeHub"}}}},"required":["modulesContent"],"title":"JSON schema for Azure IoT Edge Deployment Template version 4.0 (Edge Agent schema v1.1 + Edge Hub schema v1.2 )","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Azure IoT Edge Deployment Template version 4.0 (Edge Agent schema v1.1 + Edge Hub schema v1.2 )". Here are the required top‑level fields: modulesContent. Return only the valid JSON object.
|
JSON schema for Azure IoT Edge Deployment Template version 4.0 (Edge Agent schema v1.1 + Edge Hub schema v1.2 )
|
schema-store
|
schema_store_78
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{\"moduleType\":{\"enum\":[\"docker\"]},\"status\":{\"enum\":[\"running\",\"stopped\"]},\"restartPolicy\":{\"enum\":[\"never\",\"on-failure\",\"on-unhealthy\",\"always\"]},\"imagePullPolicy\":{\"enum\":[\"never\",\"on-create\"]},\"startupOrder\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":4294967295},\"moduleSettings\":{\"type\":\"object\",\"required\":[\"image\"],\"properties\":{\"image\":{\"type\":\"string\",\"examples\":[\"mcr.microsoft.com/azureiotedge-agent:1.0\"]}},\"patternProperties\":{\"^(createoptions|createOptions)[0-9]*$\":{\"$ref\":\"#/definitions/createOptions\"}},\"additionalProperties\":false},\"env\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\+#$\\\\s\\\\.]+$\":{\"type\":\"object\",\"required\":[\"value\"],\"properties\":{\"value\":{\"type\":[\"number\",\"string\",\"boolean\"]}},\"additionalProperties\":false}},\"additionalProperties\":false},\"createOptions\":{\"type\":\"string\",\"contentMediaType\":\"application/json\"}},\"id\":\"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json\",\"properties\":{\"$edgeAgent\":{\"type\":\"object\",\"title\":\"Configuration for the edgeAgent module\",\"required\":[\"properties.desired\"],\"properties\":{\"properties.desired\":{\"type\":\"object\",\"required\":[\"schemaVersion\",\"runtime\",\"systemModules\",\"modules\"],\"properties\":{\"schemaVersion\":{\"type\":\"string\",\"pattern\":\"1.1\"},\"runtime\":{\"type\":\"object\",\"required\":[\"type\",\"settings\"],\"properties\":{\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"settings\":{\"type\":\"object\",\"properties\":{\"minDockerVersion\":{\"type\":\"string\",\"examples\":[\"v1.25\"]},\"loggingOptions\":{\"type\":\"string\"},\"registryCredentials\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\.\\\\$# ]+$\":{\"type\":\"object\",\"required\":[\"username\",\"password\",\"address\"],\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"address\":{\"type\":\"string\",\"pattern\":\"^[^\\\\s]+$\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false},\"systemModules\":{\"type\":\"object\",\"required\":[\"edgeAgent\",\"edgeHub\"],\"properties\":{\"edgeAgent\":{\"type\":\"object\",\"required\":[\"type\",\"settings\"],\"properties\":{\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"imagePullPolicy\":{\"$ref\":\"#/definitions/imagePullPolicy\"}},\"additionalProperties\":false},\"edgeHub\":{\"type\":\"object\",\"title\":\"The Edgehub Schema\",\"required\":[\"type\",\"settings\",\"status\",\"restartPolicy\"],\"properties\":{\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"status\":{\"$ref\":\"#/definitions/status\"},\"restartPolicy\":{\"$ref\":\"#/definitions/restartPolicy\"},\"imagePullPolicy\":{\"$ref\":\"#/definitions/imagePullPolicy\"},\"startupOrder\":{\"$ref\":\"#/definitions/startupOrder\"}},\"additionalProperties\":false}},\"additionalProperties\":false},\"modules\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9_-]+$\":{\"type\":\"object\",\"required\":[\"type\",\"status\",\"restartPolicy\",\"settings\"],\"properties\":{\"version\":{\"type\":\"string\",\"examples\":[\"1.0\"]},\"type\":{\"$ref\":\"#/definitions/moduleType\"},\"status\":{\"$ref\":\"#/definitions/status\"},\"restartPolicy\":{\"$ref\":\"#/definitions/restartPolicy\"},\"env\":{\"$ref\":\"#/definitions/env\"},\"settings\":{\"$ref\":\"#/definitions/moduleSettings\"},\"imagePullPolicy\":{\"$ref\":\"#/definitions/imagePullPolicy\"},\"startupOrder\":{\"$ref\":\"#/definitions/startupOrder\"}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"required\":[\"$edgeAgent\"],\"title\":\"JSON schema for Azure IoT EdgeAgent Deployment version 1.1\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Azure IoT EdgeAgent Deployment version 1.1\". Here are the required top‑level fields: $edgeAgent. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"moduleType":{"enum":["docker"]},"status":{"enum":["running","stopped"]},"restartPolicy":{"enum":["never","on-failure","on-unhealthy","always"]},"imagePullPolicy":{"enum":["never","on-create"]},"startupOrder":{"type":"integer","minimum":0,"maximum":4294967295},"moduleSettings":{"type":"object","required":["image"],"properties":{"image":{"type":"string","examples":["mcr.microsoft.com/azureiotedge-agent:1.0"]}},"patternProperties":{"^(createoptions|createOptions)[0-9]*$":{"$ref":"#/definitions/createOptions"}},"additionalProperties":false},"env":{"type":"object","patternProperties":{"^[^\\+#$\\s\\.]+$":{"type":"object","required":["value"],"properties":{"value":{"type":["number","string","boolean"]}},"additionalProperties":false}},"additionalProperties":false},"createOptions":{"type":"string","contentMediaType":"application/json"}},"id":"https://json.schemastore.org/azure-iot-edgeagent-deployment-1.1.json","properties":{"$edgeAgent":{"type":"object","title":"Configuration for the edgeAgent module","required":["properties.desired"],"properties":{"properties.desired":{"type":"object","required":["schemaVersion","runtime","systemModules","modules"],"properties":{"schemaVersion":{"type":"string","pattern":"1.1"},"runtime":{"type":"object","required":["type","settings"],"properties":{"type":{"$ref":"#/definitions/moduleType"},"settings":{"type":"object","properties":{"minDockerVersion":{"type":"string","examples":["v1.25"]},"loggingOptions":{"type":"string"},"registryCredentials":{"type":"object","patternProperties":{"^[^\\.\\$# ]+$":{"type":"object","required":["username","password","address"],"properties":{"username":{"type":"string"},"password":{"type":"string"},"address":{"type":"string","pattern":"^[^\\s]+$"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"systemModules":{"type":"object","required":["edgeAgent","edgeHub"],"properties":{"edgeAgent":{"type":"object","required":["type","settings"],"properties":{"type":{"$ref":"#/definitions/moduleType"},"settings":{"$ref":"#/definitions/moduleSettings"},"env":{"$ref":"#/definitions/env"},"imagePullPolicy":{"$ref":"#/definitions/imagePullPolicy"}},"additionalProperties":false},"edgeHub":{"type":"object","title":"The Edgehub Schema","required":["type","settings","status","restartPolicy"],"properties":{"type":{"$ref":"#/definitions/moduleType"},"settings":{"$ref":"#/definitions/moduleSettings"},"env":{"$ref":"#/definitions/env"},"status":{"$ref":"#/definitions/status"},"restartPolicy":{"$ref":"#/definitions/restartPolicy"},"imagePullPolicy":{"$ref":"#/definitions/imagePullPolicy"},"startupOrder":{"$ref":"#/definitions/startupOrder"}},"additionalProperties":false}},"additionalProperties":false},"modules":{"type":"object","patternProperties":{"^[a-zA-Z0-9_-]+$":{"type":"object","required":["type","status","restartPolicy","settings"],"properties":{"version":{"type":"string","examples":["1.0"]},"type":{"$ref":"#/definitions/moduleType"},"status":{"$ref":"#/definitions/status"},"restartPolicy":{"$ref":"#/definitions/restartPolicy"},"env":{"$ref":"#/definitions/env"},"settings":{"$ref":"#/definitions/moduleSettings"},"imagePullPolicy":{"$ref":"#/definitions/imagePullPolicy"},"startupOrder":{"$ref":"#/definitions/startupOrder"}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"required":["$edgeAgent"],"title":"JSON schema for Azure IoT EdgeAgent Deployment version 1.1","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Azure IoT EdgeAgent Deployment version 1.1". Here are the required top‑level fields: $edgeAgent. Return only the valid JSON object.
|
JSON schema for Azure IoT EdgeAgent Deployment version 1.1
|
schema-store
|
schema_store_79
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":false,\"definitions\":{\"policy\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"operations\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^mqtt:connect$|^mqtt:subscribe$|^mqtt:publish$\"}},\"resources\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^.+$\",\"examples\":[\"$iothub/clients/+/twin/res/#\",\"events/alerts\"]}}},\"additionalProperties\":false}}},\"id\":\"https://json.schemastore.org/azure-iot-edgehub-deployment-1.2.json\",\"properties\":{\"$edgeHub\":{\"type\":\"object\",\"title\":\"Configuration for the edgeHub module\",\"required\":[\"properties.desired\"],\"properties\":{\"properties.desired\":{\"type\":\"object\",\"required\":[\"schemaVersion\",\"routes\"],\"properties\":{\"schemaVersion\":{\"type\":\"string\",\"pattern\":\"1.2\"},\"routes\":{\"type\":\"object\",\"patternProperties\":{\"^[^\\\\.\\\\$# ]+$\":{\"anyOf\":[{\"type\":\"object\",\"required\":[\"route\"],\"properties\":{\"route\":{\"type\":\"string\",\"examples\":[\"FROM /* INTO $upstream\"],\"pattern\":\"^.+$\"},\"priority\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":9},\"timeToLiveSecs\":{\"type\":\"integer\",\"minimum\":0,\"maximum\":4294967295}},\"additionalProperties\":false},{\"type\":\"string\",\"examples\":[\"FROM /* INTO $upstream\"],\"pattern\":\"^.+$\"}]}},\"additionalProperties\":false},\"storeAndForwardConfiguration\":{\"type\":\"object\",\"required\":[\"timeToLiveSecs\"],\"properties\":{\"timeToLiveSecs\":{\"type\":\"integer\",\"examples\":[7200]}},\"additionalProperties\":false},\"mqttBroker\":{\"type\":\"object\",\"properties\":{\"bridges\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"endpoint\":{\"type\":\"string\",\"pattern\":\"\\\\$upstream\"},\"settings\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"direction\":{\"type\":\"string\",\"pattern\":\"^in$|^out$\"},\"topic\":{\"type\":\"string\",\"pattern\":\"^.*$\"},\"inPrefix\":{\"type\":\"string\",\"pattern\":\"^.*$\"},\"outPrefix\":{\"type\":\"string\",\"pattern\":\"^.*$\"}},\"additionalProperties\":false}}},\"additionalProperties\":false}},\"authorizations\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"identities\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"pattern\":\"^.+$\",\"examples\":[\"{{iot:identity}}\",\"contoso.azure-devices.net/MyLeafDevice1\",\"contoso.azure-devices.net/MyEdgeDevice/MyModule\"]}},\"allow\":{\"$ref\":\"#/definitions/policy\"},\"deny\":{\"$ref\":\"#/definitions/policy\"}},\"additionalProperties\":false}}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"additionalProperties\":false}},\"required\":[\"$edgeHub\"],\"title\":\"JSON schema for Azure IoT EdgeHub Deployment version 1.2\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Azure IoT EdgeHub Deployment version 1.2\". Here are the required top‑level fields: $edgeHub. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"policy":{"type":"array","items":{"type":"object","properties":{"operations":{"type":"array","items":{"type":"string","pattern":"^mqtt:connect$|^mqtt:subscribe$|^mqtt:publish$"}},"resources":{"type":"array","items":{"type":"string","pattern":"^.+$","examples":["$iothub/clients/+/twin/res/#","events/alerts"]}}},"additionalProperties":false}}},"id":"https://json.schemastore.org/azure-iot-edgehub-deployment-1.2.json","properties":{"$edgeHub":{"type":"object","title":"Configuration for the edgeHub module","required":["properties.desired"],"properties":{"properties.desired":{"type":"object","required":["schemaVersion","routes"],"properties":{"schemaVersion":{"type":"string","pattern":"1.2"},"routes":{"type":"object","patternProperties":{"^[^\\.\\$# ]+$":{"anyOf":[{"type":"object","required":["route"],"properties":{"route":{"type":"string","examples":["FROM /* INTO $upstream"],"pattern":"^.+$"},"priority":{"type":"integer","minimum":0,"maximum":9},"timeToLiveSecs":{"type":"integer","minimum":0,"maximum":4294967295}},"additionalProperties":false},{"type":"string","examples":["FROM /* INTO $upstream"],"pattern":"^.+$"}]}},"additionalProperties":false},"storeAndForwardConfiguration":{"type":"object","required":["timeToLiveSecs"],"properties":{"timeToLiveSecs":{"type":"integer","examples":[7200]}},"additionalProperties":false},"mqttBroker":{"type":"object","properties":{"bridges":{"type":"array","items":{"type":"object","properties":{"endpoint":{"type":"string","pattern":"\\$upstream"},"settings":{"type":"array","items":{"type":"object","properties":{"direction":{"type":"string","pattern":"^in$|^out$"},"topic":{"type":"string","pattern":"^.*$"},"inPrefix":{"type":"string","pattern":"^.*$"},"outPrefix":{"type":"string","pattern":"^.*$"}},"additionalProperties":false}}},"additionalProperties":false}},"authorizations":{"type":"array","items":{"type":"object","properties":{"identities":{"type":"array","items":{"type":"string","pattern":"^.+$","examples":["{{iot:identity}}","contoso.azure-devices.net/MyLeafDevice1","contoso.azure-devices.net/MyEdgeDevice/MyModule"]}},"allow":{"$ref":"#/definitions/policy"},"deny":{"$ref":"#/definitions/policy"}},"additionalProperties":false}}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false}},"required":["$edgeHub"],"title":"JSON schema for Azure IoT EdgeHub Deployment version 1.2","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Azure IoT EdgeHub Deployment version 1.2". Here are the required top‑level fields: $edgeHub. Return only the valid JSON object.
|
JSON schema for Azure IoT EdgeHub Deployment version 1.2
|
schema-store
|
schema_store_80
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"allOf\":[{\"$ref\":\"#/definitions/Options\"},{\"properties\":{\"env\":{\"description\":\"This is an object of keys that represent different environments. For example, you may have: `{ env: { production: { /* specific options */ } } }` which will use those options when the environment variable BABEL_ENV is set to \\\"production\\\". If BABEL_ENV isn't set then NODE_ENV will be used, if it's not set then it defaults to \\\"development\\\"\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/Options\"},\"default\":{}}}}],\"definitions\":{\"Options\":{\"type\":\"object\",\"properties\":{\"ast\":{\"description\":\"Include the AST in the returned object\",\"type\":\"boolean\",\"default\":true},\"auxiliaryCommentAfter\":{\"description\":\"Attach a comment after all non-user injected code.\",\"type\":\"string\"},\"auxiliaryCommentBefore\":{\"description\":\"Attach a comment before all non-user injected code.\",\"type\":\"string\"},\"code\":{\"description\":\"Enable code generation\",\"type\":\"boolean\",\"default\":true},\"comments\":{\"description\":\"Output comments in generated output.\",\"type\":\"boolean\",\"default\":true},\"compact\":{\"description\":\"Do not include superfluous whitespace characters and line terminators. When set to \\\"auto\\\" compact is set to true on input sizes of >500KB.\",\"type\":[\"string\",\"boolean\"],\"enum\":[\"auto\",true,false],\"default\":\"auto\"},\"extends\":{\"description\":\"A path to a .babelrc file to extend\",\"type\":\"string\"},\"filename\":{\"description\":\"Filename for use in errors etc.\",\"type\":\"string\",\"default\":\"unknown\"},\"filenameRelative\":{\"description\":\"Filename relative to sourceRoot (defaults to \\\"filename\\\")\",\"type\":\"string\"},\"highlightCode\":{\"description\":\"ANSI highlight syntax error code frames\",\"type\":\"boolean\"},\"ignore\":{\"description\":\"Opposite of the \\\"only\\\" option\",\"type\":[\"string\",\"array\"],\"items\":{\"type\":\"string\"}},\"inputSourceMap\":{\"description\":\"If true, attempt to load an input sourcemap from the file itself. If an object is provided, it will be treated as the source map object itself.\",\"type\":[\"boolean\",\"object\"],\"default\":true},\"keepModuleIdExtensions\":{\"description\":\"Keep extensions in module ids\",\"type\":\"boolean\",\"default\":false},\"moduleId\":{\"description\":\"Specify a custom name for module ids.\",\"type\":\"string\"},\"moduleIds\":{\"description\":\"If truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)\",\"type\":\"string\",\"default\":false},\"moduleRoot\":{\"description\":\"Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions. (defaults to \\\"sourceRoot\\\")\",\"type\":\"string\"},\"only\":{\"description\":\"A glob, regex, or mixed array of both, matching paths to only compile. Can also be an array of arrays containing paths to explicitly match. When attempting to compile a non-matching file it's returned verbatim.\",\"type\":[\"string\",\"array\"],\"items\":{\"type\":\"string\"}},\"plugins\":{\"description\":\"List of plugins to load and use\",\"type\":\"array\",\"items\":{\"type\":[\"string\",\"array\"],\"items\":[{\"description\":\"The name of the plugin.\",\"type\":\"string\"},{\"description\":\"The options of the plugin.\",\"type\":\"object\"}]}},\"presets\":{\"description\":\"List of presets (a set of plugins) to load and use\",\"type\":\"array\",\"items\":{\"type\":[\"string\",\"array\"],\"items\":[{\"description\":\"The name of the preset.\",\"type\":\"string\"},{\"description\":\"The options of the preset.\",\"type\":\"object\"}]}},\"retainLines\":{\"default\":false,\"description\":\"Retain line numbers. This will lead to wacky code but is handy for scenarios where you can't use source maps. NOTE: This will obviously not retain the columns.\",\"type\":\"boolean\"},\"sourceFileName\":{\"description\":\"Set sources[0] on returned source map. (defaults to \\\"filenameRelative\\\")\",\"type\":\"string\"},\"sourceMaps\":{\"default\":false,\"description\":\"If truthy, adds a map property to returned output. If set to \\\"inline\\\", a comment with a sourceMappingURL directive is added to the bottom of the returned code. If set to \\\"both\\\" then a map property is returned as well as a source map comment appended.\",\"type\":[\"string\",\"boolean\"],\"enum\":[\"both\",\"inline\",true,false]},\"sourceMapTarget\":{\"description\":\"Set file on returned source map. (defaults to \\\"filenameRelative\\\")\",\"type\":\"string\"},\"sourceRoot\":{\"description\":\"The root from which all sources are relative. (defaults to \\\"moduleRoot\\\")\",\"type\":\"string\"}}}},\"id\":\"https://json.schemastore.org/babelrc.json\",\"title\":\"JSON schema for Babel 6+ configuration files\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Babel 6+ configuration files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","allOf":[{"$ref":"#/definitions/Options"},{"properties":{"env":{"description":"This is an object of keys that represent different environments. For example, you may have: `{ env: { production: { /* specific options */ } } }` which will use those options when the environment variable BABEL_ENV is set to \"production\". If BABEL_ENV isn't set then NODE_ENV will be used, if it's not set then it defaults to \"development\"","type":"object","additionalProperties":{"$ref":"#/definitions/Options"},"default":{}}}}],"definitions":{"Options":{"type":"object","properties":{"ast":{"description":"Include the AST in the returned object","type":"boolean","default":true},"auxiliaryCommentAfter":{"description":"Attach a comment after all non-user injected code.","type":"string"},"auxiliaryCommentBefore":{"description":"Attach a comment before all non-user injected code.","type":"string"},"code":{"description":"Enable code generation","type":"boolean","default":true},"comments":{"description":"Output comments in generated output.","type":"boolean","default":true},"compact":{"description":"Do not include superfluous whitespace characters and line terminators. When set to \"auto\" compact is set to true on input sizes of >500KB.","type":["string","boolean"],"enum":["auto",true,false],"default":"auto"},"extends":{"description":"A path to a .babelrc file to extend","type":"string"},"filename":{"description":"Filename for use in errors etc.","type":"string","default":"unknown"},"filenameRelative":{"description":"Filename relative to sourceRoot (defaults to \"filename\")","type":"string"},"highlightCode":{"description":"ANSI highlight syntax error code frames","type":"boolean"},"ignore":{"description":"Opposite of the \"only\" option","type":["string","array"],"items":{"type":"string"}},"inputSourceMap":{"description":"If true, attempt to load an input sourcemap from the file itself. If an object is provided, it will be treated as the source map object itself.","type":["boolean","object"],"default":true},"keepModuleIdExtensions":{"description":"Keep extensions in module ids","type":"boolean","default":false},"moduleId":{"description":"Specify a custom name for module ids.","type":"string"},"moduleIds":{"description":"If truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)","type":"string","default":false},"moduleRoot":{"description":"Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions. (defaults to \"sourceRoot\")","type":"string"},"only":{"description":"A glob, regex, or mixed array of both, matching paths to only compile. Can also be an array of arrays containing paths to explicitly match. When attempting to compile a non-matching file it's returned verbatim.","type":["string","array"],"items":{"type":"string"}},"plugins":{"description":"List of plugins to load and use","type":"array","items":{"type":["string","array"],"items":[{"description":"The name of the plugin.","type":"string"},{"description":"The options of the plugin.","type":"object"}]}},"presets":{"description":"List of presets (a set of plugins) to load and use","type":"array","items":{"type":["string","array"],"items":[{"description":"The name of the preset.","type":"string"},{"description":"The options of the preset.","type":"object"}]}},"retainLines":{"default":false,"description":"Retain line numbers. This will lead to wacky code but is handy for scenarios where you can't use source maps. NOTE: This will obviously not retain the columns.","type":"boolean"},"sourceFileName":{"description":"Set sources[0] on returned source map. (defaults to \"filenameRelative\")","type":"string"},"sourceMaps":{"default":false,"description":"If truthy, adds a map property to returned output. If set to \"inline\", a comment with a sourceMappingURL directive is added to the bottom of the returned code. If set to \"both\" then a map property is returned as well as a source map comment appended.","type":["string","boolean"],"enum":["both","inline",true,false]},"sourceMapTarget":{"description":"Set file on returned source map. (defaults to \"filenameRelative\")","type":"string"},"sourceRoot":{"description":"The root from which all sources are relative. (defaults to \"moduleRoot\")","type":"string"}}}},"id":"https://json.schemastore.org/babelrc.json","title":"JSON schema for Babel 6+ configuration files","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Babel 6+ configuration files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Babel 6+ configuration files
|
schema-store
|
schema_store_81
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/backportrc.json\",\"additionalProperties\":false,\"description\":\"A Backport config schema\",\"properties\":{\"repoName\":{\"description\":\"A repo name for the current project\\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#reponame-required\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"kibana\"]},\"repoOwner\":{\"description\":\"A repo owner for the current project\\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#repoowner-required\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"elastic\"]},\"targetBranchChoices\":{\"description\":\"Target branches for the current project\\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"description\":\"A target branch for the current project\\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required\",\"oneOf\":[{\"type\":\"string\",\"minLength\":1,\"examples\":[\"6.2\"]},{\"title\":\"target branch\",\"type\":\"object\",\"required\":[\"name\",\"checked\"],\"properties\":{\"name\":{\"description\":\"A target branch for the current project\\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"6.3\"]},\"checked\":{\"description\":\"Whether to pre-select a target branch for the current project\\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required\",\"type\":\"boolean\"}},\"additionalProperties\":false}]}},\"upstream\":{\"description\":\"Identifier for the GitHub project as `{owner}/{repoName}` (deprecated)\",\"type\":\"string\"},\"branches\":{\"description\":\"Branches to backport to\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"checked\":{\"type\":\"boolean\"}},\"required\":[\"name\",\"checked\"]}]}},\"labels\":{\"description\":\"Labels that will be added to the pull request\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"all\":{\"description\":\"Whether to only show the current user's commits or commits from anyone\",\"type\":\"boolean\"}},\"required\":[\"repoName\",\"repoOwner\",\"targetBranchChoices\"],\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"backportrc\". Here are the required top‑level fields: repoName, repoOwner, targetBranchChoices. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/backportrc.json","additionalProperties":false,"description":"A Backport config schema","properties":{"repoName":{"description":"A repo name for the current project\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#reponame-required","type":"string","minLength":1,"examples":["kibana"]},"repoOwner":{"description":"A repo owner for the current project\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#repoowner-required","type":"string","minLength":1,"examples":["elastic"]},"targetBranchChoices":{"description":"Target branches for the current project\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required","type":"array","uniqueItems":true,"items":{"description":"A target branch for the current project\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required","oneOf":[{"type":"string","minLength":1,"examples":["6.2"]},{"title":"target branch","type":"object","required":["name","checked"],"properties":{"name":{"description":"A target branch for the current project\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required","type":"string","minLength":1,"examples":["6.3"]},"checked":{"description":"Whether to pre-select a target branch for the current project\nhttps://github.com/sqren/backport/blob/main/docs/config-file-options.md#targetbranchchoices-required","type":"boolean"}},"additionalProperties":false}]}},"upstream":{"description":"Identifier for the GitHub project as `{owner}/{repoName}` (deprecated)","type":"string"},"branches":{"description":"Branches to backport to","type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"name":{"type":"string"},"checked":{"type":"boolean"}},"required":["name","checked"]}]}},"labels":{"description":"Labels that will be added to the pull request","type":"array","items":{"type":"string"}},"all":{"description":"Whether to only show the current user's commits or commits from anyone","type":"boolean"}},"required":["repoName","repoOwner","targetBranchChoices"],"type":"object"}
|
Provide a JSON object that satisfies the schema "backportrc". Here are the required top‑level fields: repoName, repoOwner, targetBranchChoices. Return only the valid JSON object.
|
backportrc
|
schema-store
|
schema_store_82
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"additionalProperties\":{\"$ref\":\"#/definitions/job\"},\"definitions\":{\"deployment\":{\"type\":\"object\",\"title\":\"Deployment projects\",\"description\":\"A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed\",\"properties\":{\"name\":{\"type\":\"string\"},\"source-plan\":{\"type\":\"string\"}}},\"docker\":{\"title\":\"Docker\",\"description\":\"Builds and deployments are normally run on the Bamboo agent's native operating system\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"image\":{\"type\":\"string\"},\"volumes\":{\"type\":\"object\",\"default\":{}},\"use-default-volumes\":{\"type\":\"boolean\",\"default\":false},\"docker-run-arguments\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[\"image\"]}]},\"events\":{\"type\":\"string\",\"enum\":[\"plan-failed\",\"plan-completed\",\"plan-status-changed\",\"plan-comment-added\",\"plan-responsibility-changed\",\"job-completed\",\"job-status-changed\",\"job-failed\",\"job-error\",\"job-first-failed\",\"job-hung\",\"job-queue-timeout\",\"job-queued-without-capable-agents\"]},\"job\":{\"title\":\"Job\",\"description\":\"A job is a single build unit within a plan and is made up of one or more tasks.\",\"definitions\":{\"artifact\":{\"type\":\"object\",\"title\":\"Artifact\",\"description\":\"Artifacts are files created by a job build (e.g. JAR files)\",\"properties\":{\"location\":{\"description\":\"The relative path to find your artifact; it's a path relative to the workspace directory; do not use absolute paths.\",\"type\":\"string\"},\"name\":{\"description\":\"Name of the artifact; in case artifact is shared, name must be unique within the plan.\",\"type\":\"string\"},\"pattern\":{\"description\":\"Name or Ant pattern of file(s) to keep.\",\"type\":\"string\"},\"required\":{\"type\":\"boolean\"},\"shared\":{\"type\":\"boolean\",\"description\":\"You can share an artifact among other jobs or plans.\",\"default\":false}}},\"task\":{\"description\":\"A task is a small unit of work, such as source code checkout, or running a script\",\"type\":\"object\",\"properties\":{\"interpreter\":{\"type\":\"string\"},\"clean\":{\"type\":\"object\"},\"checkout\":{\"type\":\"object\",\"properties\":{\"repository\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"force-clean-build\":{\"type\":\"string\",\"default\":false}}},\"inject-variables\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"file\":{\"type\":\"string\"},\"scope\":{\"type\":\"string\"},\"namespace\":{\"type\":\"string\"}}}]},\"test-parser\":{\"description\":\"The Test Results Parser task in Bamboo parses test data\",\"anyOf\":[{\"$ref\":\"#/definitions/testParser\"},{\"type\":\"object\",\"properties\":{\"type\":{\"$ref\":\"#/definitions/testParser\"},\"ignore-time\":{\"type\":\"boolean\"},\"test-results\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[\"type\"]}]},\"scripts\":{\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/script\"}}}}},\"type\":\"object\",\"properties\":{\"docker\":{\"$ref\":\"#/definitions/docker\"},\"final-tasks\":{\"type\":\"array\"},\"key\":{\"type\":\"string\"},\"other\":{\"type\":\"object\",\"properties\":{\"clean-working-dir\":{\"type\":\"boolean\"}}},\"requirements\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"patternProperties\":{\".\":{\"type\":\"string\"}}}]}},\"tasks\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/predefinedTask\"},{\"$ref\":\"#/definitions/script\"},{\"$ref\":\"#/definitions/job/definitions/task\"}]}}}},\"keyValue\":{\"description\":\"Variables can be used to make values available when building plans in Bamboo.\",\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9_]\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"boolean\"},{\"type\":\"number\"}]}}},\"notification\":{\"type\":\"object\",\"properties\":{\"recipients\":{\"type\":\"array\",\"anyOf\":[{\"type\":\"object\",\"properties\":{\"users\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},{\"type\":\"object\",\"properties\":{\"groups\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}]},\"events\":{\"type\":\"array\",\"minLength\":1,\"items\":{\"$ref\":\"#/definitions/events\"}}}},\"permission\":{\"type\":\"object\",\"description\":\"Plan permissions allow a user to control access to the functions of the build plan.\",\"definitions\":{\"permission\":{\"description\":\"Plan permissions allow a user to control access to the functions of the build plan\",\"type\":\"string\",\"enum\":[\"view\",\"edit\",\"build\",\"admin\",\"clone\",\"deploy\"]}},\"properties\":{\"groups\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"permissions\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/permission/definitions/permission\"}},{\"$ref\":\"#/definitions/permission/definitions/permission\"}]},\"roles\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"users\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"plan\":{\"description\":\"A plan defines everything about your continuous integration build process in Bamboo.\",\"type\":\"object\",\"properties\":{\"project-key\":{\"type\":\"string\"},\"key\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}}},\"predefinedTask\":{\"type\":\"string\",\"enum\":[\"inject-variables\",\"clean\",\"checkout\",\"artifact-download\"]},\"releaseNaming\":{\"type\":\"object\",\"properties\":{\"next-version-name\":{\"type\":\"string\"},\"applies-to-branches\":{\"type\":\"boolean\"},\"auto-increment\":{\"type\":\"boolean\"},\"auto-increment-variables\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]}}},\"script\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"script\":{\"type\":\"string\"}}}]},\"stage\":{\"title\":\"Stage\",\"description\":\"Stages group jobs to individual steps within a plan's build process.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"manual\":{\"description\":\"Will await for execution by user\",\"type\":\"boolean\"},\"final\":{\"description\":\"Will be executed regardless of other stages state (pass or fail)\",\"type\":\"boolean\"},\"jobs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"task\":{\"description\":\"A task is a small unit of work, such as source code checkout, or running a script.\",\"type\":\"object\",\"definitions\":{\"trigger\":{\"anyOf\":[{\"type\":\"object\",\"properties\":{\"stage\":{\"type\":\"string\"},\"branch\":{\"type\":\"string\"}}},{\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9\\\\s+_-]\":{\"type\":\"string\"}}}]}},\"properties\":{\"source-plan\":{\"type\":\"string\"},\"artifacts\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/job/definitions/artifact\"}},\"triggers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"patternProperties\":{\"(build|stage|environment)-success\":{\"$ref\":\"#/definitions/task/definitions/trigger\"}}}},\"notifications\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/notification\"}}}},\"testParser\":{\"type\":\"string\",\"enum\":[\"junit\",\"mstest\",\"nunit\",\"mocha\",\"testng\"]},\"triggers\":{\"type\":\"array\",\"definitions\":{\"polling\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"polling\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"period\":{\"type\":\"integer\"},\"conditions\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9\\\\s+_-]\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"boolean\"}}}}}}}]}}},\"remote\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"remote\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"ip\":{\"type\":\"string\"}}}]}}},\"cron\":{\"type\":\"object\",\"description\":\"Execute deployment by schedule.\",\"additionalProperties\":false,\"properties\":{\"cron\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"expression\":{\"type\":\"string\"}}}]}}}},\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/triggers/definitions/polling\"},{\"$ref\":\"#/definitions/triggers/definitions/cron\"},{\"$ref\":\"#/definitions/triggers/definitions/remote\"},{\"type\":\"string\"}]}}},\"description\":\"Full spec reference: https://docs.atlassian.com/bamboo-specs-docs/7.2.4/specs.html\",\"id\":\"https://json.schemastore.org/bamboo-spec.json\",\"properties\":{\"default-environment-permissions\":{\"title\":\"Default Environment Permissions\",\"description\":\"These permissions apply to all environments defined in this deployment project\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/permission\"}},\"deployment\":{\"title\":\"Deployment\",\"anyOf\":[{\"type\":\"string\"},{\"$ref\":\"#/definitions/deployment\"}]},\"deployment-permissions\":{\"title\":\"Deployment Permissions\",\"description\":\"These permissions apply to the deployment project\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/permission\"}},\"docker\":{\"$ref\":\"#/definitions/docker\"},\"environment-permissions\":{\"title\":\"Environment Permissions\",\"description\":\"Permissions specific to an environment\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9\\\\s+_-]\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/permission\"}}}}},\"environments\":{\"description\":\"An environment represents the servers or groups of servers where the software release has been deployed to, and the tasks that are needed for the deployment to work smoothly\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"labels\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"notifications\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"recipients\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"users\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"emails\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}]}},\"events\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/events\"},{\"type\":\"object\"}]}}}}},\"plan\":{\"$ref\":\"#/definitions/plan\"},\"plan-permissions\":{\"title\":\"Plan Permissions\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/permission\"}},\"release-naming\":{\"description\":\"You can define how releases should be named when they are created by Bamboo\",\"anyOf\":[{\"$ref\":\"#/definitions/releaseNaming\"},{\"type\":\"string\"}]},\"repositories\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9_]\":{\"type\":\"object\",\"properties\":{\"scope\":{\"type\":\"string\",\"enum\":[\"project\",\"global\"]},\"type\":{\"type\":\"string\"},\"slug\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"branch\":{\"type\":\"string\"},\"viewer\":{\"type\":\"string\"},\"ssh-key\":{\"type\":\"string\"},\"ssh-key-passphrase\":{\"type\":\"string\"},\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"shared-credentials\":{\"type\":\"string\"},\"lfs\":{\"type\":\"boolean\"},\"use-shallow-clones\":{\"type\":\"boolean\"},\"submodules\":{\"type\":\"boolean\"},\"change-detection\":{\"type\":\"object\",\"properties\":{\"quiet-period\":{\"type\":\"object\",\"properties\":{\"quiet-period-seconds\":{\"type\":\"integer\"},\"max-retries\":{\"type\":\"integer\"}}},\"exclude-changeset-pattern\":{\"type\":\"string\"},\"file-filter-type\":{\"type\":\"string\"},\"file-filter-pattern\":{\"type\":\"string\"}}}}}}}]}},\"stages\":{\"description\":\"Stages group jobs to individual steps within a plan's build process.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9\\\\s+_-]\":{\"anyOf\":[{\"type\":\"array\",\"items\":{\"type\":\"string\"}},{\"$ref\":\"#/definitions/stage\"}]}}}},\"triggers\":{\"$ref\":\"#/definitions/triggers\"},\"variables\":{\"$ref\":\"#/definitions/keyValue\"},\"version\":{\"type\":\"integer\",\"default\":2},\"branch-overrides\":{\"description\":\"Overrides for specific branches in the plan\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z0-9\\\\s+_-]\":{\"$ref\":\"#\"}}}},\"other\":{\"type\":\"object\"}},\"title\":\"Bamboo CI Specification\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Bamboo CI Specification\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":{"$ref":"#/definitions/job"},"definitions":{"deployment":{"type":"object","title":"Deployment projects","description":"A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed","properties":{"name":{"type":"string"},"source-plan":{"type":"string"}}},"docker":{"title":"Docker","description":"Builds and deployments are normally run on the Bamboo agent's native operating system","anyOf":[{"type":"string"},{"type":"object","properties":{"image":{"type":"string"},"volumes":{"type":"object","default":{}},"use-default-volumes":{"type":"boolean","default":false},"docker-run-arguments":{"type":"array","items":{"type":"string"}}},"required":["image"]}]},"events":{"type":"string","enum":["plan-failed","plan-completed","plan-status-changed","plan-comment-added","plan-responsibility-changed","job-completed","job-status-changed","job-failed","job-error","job-first-failed","job-hung","job-queue-timeout","job-queued-without-capable-agents"]},"job":{"title":"Job","description":"A job is a single build unit within a plan and is made up of one or more tasks.","definitions":{"artifact":{"type":"object","title":"Artifact","description":"Artifacts are files created by a job build (e.g. JAR files)","properties":{"location":{"description":"The relative path to find your artifact; it's a path relative to the workspace directory; do not use absolute paths.","type":"string"},"name":{"description":"Name of the artifact; in case artifact is shared, name must be unique within the plan.","type":"string"},"pattern":{"description":"Name or Ant pattern of file(s) to keep.","type":"string"},"required":{"type":"boolean"},"shared":{"type":"boolean","description":"You can share an artifact among other jobs or plans.","default":false}}},"task":{"description":"A task is a small unit of work, such as source code checkout, or running a script","type":"object","properties":{"interpreter":{"type":"string"},"clean":{"type":"object"},"checkout":{"type":"object","properties":{"repository":{"type":"string"},"path":{"type":"string"},"force-clean-build":{"type":"string","default":false}}},"inject-variables":{"anyOf":[{"type":"string"},{"type":"object","additionalProperties":false,"properties":{"file":{"type":"string"},"scope":{"type":"string"},"namespace":{"type":"string"}}}]},"test-parser":{"description":"The Test Results Parser task in Bamboo parses test data","anyOf":[{"$ref":"#/definitions/testParser"},{"type":"object","properties":{"type":{"$ref":"#/definitions/testParser"},"ignore-time":{"type":"boolean"},"test-results":{"type":"array","items":{"type":"string"}}},"required":["type"]}]},"scripts":{"type":"array","minItems":1,"items":{"$ref":"#/definitions/script"}}}}},"type":"object","properties":{"docker":{"$ref":"#/definitions/docker"},"final-tasks":{"type":"array"},"key":{"type":"string"},"other":{"type":"object","properties":{"clean-working-dir":{"type":"boolean"}}},"requirements":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","patternProperties":{".":{"type":"string"}}}]}},"tasks":{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/predefinedTask"},{"$ref":"#/definitions/script"},{"$ref":"#/definitions/job/definitions/task"}]}}}},"keyValue":{"description":"Variables can be used to make values available when building plans in Bamboo.","type":"object","patternProperties":{"[a-zA-Z0-9_]":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"},{"type":"number"}]}}},"notification":{"type":"object","properties":{"recipients":{"type":"array","anyOf":[{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"}}}},{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"}}}}]},"events":{"type":"array","minLength":1,"items":{"$ref":"#/definitions/events"}}}},"permission":{"type":"object","description":"Plan permissions allow a user to control access to the functions of the build plan.","definitions":{"permission":{"description":"Plan permissions allow a user to control access to the functions of the build plan","type":"string","enum":["view","edit","build","admin","clone","deploy"]}},"properties":{"groups":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"permissions":{"anyOf":[{"type":"array","items":{"$ref":"#/definitions/permission/definitions/permission"}},{"$ref":"#/definitions/permission/definitions/permission"}]},"roles":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}}}},"plan":{"description":"A plan defines everything about your continuous integration build process in Bamboo.","type":"object","properties":{"project-key":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"}}},"predefinedTask":{"type":"string","enum":["inject-variables","clean","checkout","artifact-download"]},"releaseNaming":{"type":"object","properties":{"next-version-name":{"type":"string"},"applies-to-branches":{"type":"boolean"},"auto-increment":{"type":"boolean"},"auto-increment-variables":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}}},"script":{"anyOf":[{"type":"string"},{"type":"object","properties":{"script":{"type":"string"}}}]},"stage":{"title":"Stage","description":"Stages group jobs to individual steps within a plan's build process.","type":"object","additionalProperties":false,"properties":{"manual":{"description":"Will await for execution by user","type":"boolean"},"final":{"description":"Will be executed regardless of other stages state (pass or fail)","type":"boolean"},"jobs":{"type":"array","items":{"type":"string"}}}},"task":{"description":"A task is a small unit of work, such as source code checkout, or running a script.","type":"object","definitions":{"trigger":{"anyOf":[{"type":"object","properties":{"stage":{"type":"string"},"branch":{"type":"string"}}},{"type":"object","patternProperties":{"[a-zA-Z0-9\\s+_-]":{"type":"string"}}}]}},"properties":{"source-plan":{"type":"string"},"artifacts":{"type":"array","items":{"$ref":"#/definitions/job/definitions/artifact"}},"triggers":{"type":"array","items":{"type":"object","patternProperties":{"(build|stage|environment)-success":{"$ref":"#/definitions/task/definitions/trigger"}}}},"notifications":{"type":"array","items":{"$ref":"#/definitions/notification"}}}},"testParser":{"type":"string","enum":["junit","mstest","nunit","mocha","testng"]},"triggers":{"type":"array","definitions":{"polling":{"type":"object","additionalProperties":false,"properties":{"polling":{"anyOf":[{"type":"integer"},{"type":"object","additionalProperties":false,"properties":{"period":{"type":"integer"},"conditions":{"type":"array","items":{"type":"object","patternProperties":{"[a-zA-Z0-9\\s+_-]":{"type":"object","additionalProperties":{"type":"boolean"}}}}}}}]}}},"remote":{"type":"object","additionalProperties":false,"properties":{"remote":{"anyOf":[{"type":"string"},{"type":"object","properties":{"ip":{"type":"string"}}}]}}},"cron":{"type":"object","description":"Execute deployment by schedule.","additionalProperties":false,"properties":{"cron":{"oneOf":[{"type":"string"},{"type":"object","properties":{"expression":{"type":"string"}}}]}}}},"items":{"anyOf":[{"$ref":"#/definitions/triggers/definitions/polling"},{"$ref":"#/definitions/triggers/definitions/cron"},{"$ref":"#/definitions/triggers/definitions/remote"},{"type":"string"}]}}},"description":"Full spec reference: https://docs.atlassian.com/bamboo-specs-docs/7.2.4/specs.html","id":"https://json.schemastore.org/bamboo-spec.json","properties":{"default-environment-permissions":{"title":"Default Environment Permissions","description":"These permissions apply to all environments defined in this deployment project","type":"array","items":{"$ref":"#/definitions/permission"}},"deployment":{"title":"Deployment","anyOf":[{"type":"string"},{"$ref":"#/definitions/deployment"}]},"deployment-permissions":{"title":"Deployment Permissions","description":"These permissions apply to the deployment project","type":"array","items":{"$ref":"#/definitions/permission"}},"docker":{"$ref":"#/definitions/docker"},"environment-permissions":{"title":"Environment Permissions","description":"Permissions specific to an environment","type":"array","items":{"type":"object","patternProperties":{"[a-zA-Z0-9\\s+_-]":{"type":"array","items":{"$ref":"#/definitions/permission"}}}}},"environments":{"description":"An environment represents the servers or groups of servers where the software release has been deployed to, and the tasks that are needed for the deployment to work smoothly","type":"array","items":{"type":"string"}},"labels":{"type":"array","items":{"type":"string"}},"notifications":{"type":"array","items":{"type":"object","properties":{"recipients":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"users":{"type":"array","items":{"type":"string"}},"emails":{"type":"array","items":{"type":"string"}}}}]}},"events":{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/events"},{"type":"object"}]}}}}},"plan":{"$ref":"#/definitions/plan"},"plan-permissions":{"title":"Plan Permissions","type":"array","items":{"$ref":"#/definitions/permission"}},"release-naming":{"description":"You can define how releases should be named when they are created by Bamboo","anyOf":[{"$ref":"#/definitions/releaseNaming"},{"type":"string"}]},"repositories":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"object","patternProperties":{"[a-zA-Z0-9_]":{"type":"object","properties":{"scope":{"type":"string","enum":["project","global"]},"type":{"type":"string"},"slug":{"type":"string"},"url":{"type":"string"},"branch":{"type":"string"},"viewer":{"type":"string"},"ssh-key":{"type":"string"},"ssh-key-passphrase":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"shared-credentials":{"type":"string"},"lfs":{"type":"boolean"},"use-shallow-clones":{"type":"boolean"},"submodules":{"type":"boolean"},"change-detection":{"type":"object","properties":{"quiet-period":{"type":"object","properties":{"quiet-period-seconds":{"type":"integer"},"max-retries":{"type":"integer"}}},"exclude-changeset-pattern":{"type":"string"},"file-filter-type":{"type":"string"},"file-filter-pattern":{"type":"string"}}}}}}}]}},"stages":{"description":"Stages group jobs to individual steps within a plan's build process.","type":"array","items":{"type":"object","patternProperties":{"[a-zA-Z0-9\\s+_-]":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/stage"}]}}}},"triggers":{"$ref":"#/definitions/triggers"},"variables":{"$ref":"#/definitions/keyValue"},"version":{"type":"integer","default":2},"branch-overrides":{"description":"Overrides for specific branches in the plan","type":"array","items":{"type":"object","patternProperties":{"[a-zA-Z0-9\\s+_-]":{"$ref":"#"}}}},"other":{"type":"object"}},"title":"Bamboo CI Specification","type":"object"}
|
Provide a JSON object that satisfies the schema "Bamboo CI Specification". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Bamboo CI Specification
|
schema-store
|
schema_store_83
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"icon\":{\"type\":\"string\",\"pattern\":\"\\\\.png$\"},\"color\":{\"description\":\"The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.\",\"type\":\"string\",\"pattern\":\"^[A-Fa-f0-9]{6}$\"},\"elementId\":{\"description\":\"The numeric id of the icon layout element based on the predefined layout selected.\",\"enum\":[\"1\",\"2\",\"3\",\"11\",\"12\",\"21\",\"22\",\"31\",\"32\"]},\"condition\":{\"description\":\"If set, then must be set to 'true' for this release\",\"enum\":[\"true\"]},\"resource\":{\"type\":\"object\",\"required\":[\"url\",\"style\",\"content\"],\"properties\":{\"url\":{\"description\":\"The URL to be referenced. For resources that require authentication, the URL must be HTTPS.\",\"type\":\"string\",\"format\":\"uri\"},\"style\":{\"description\":\"Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.\",\"type\":\"string\",\"pattern\":\"^([sS]imple|[fF]eed)$\",\"default\":\"Simple\"},\"content\":{\"description\":\"This member specifies how to extract content from the web response.\",\"type\":\"object\",\"minProperties\":1,\"additionalProperties\":{\"type\":\"string\"}}}},\"page\":{\"required\":[\"layout\"],\"properties\":{\"layout\":{\"description\":\"The name of the layout for the page. The layout name should refer to one of the predefined page layouts.\",\"enum\":[\"MSBand_ScrollingText\",\"MSBand_NoScrollingText\",\"MSBand_SingleMetric\",\"MSBand_SingleMetricWithIcon\",\"MSBand_MetricsWithIcons\",\"MSBand_SingleMetricWithSecondary\"]},\"condition\":{\"$ref\":\"#/definitions/condition\"},\"iconBindings\":{\"description\":\"Similar to textBindings, but used to select one of the web tile icons in icons list for each icon in the page. If there are no icon elements on the page, this member may be omitted.\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/iconBinding\"}},\"textBindings\":{\"description\":\"An array of objects corresponding to each page element that contains string content. Each binding object provides the numeric id of the page element based on the predefined layout selected, and the string value that it should contain.\",\"type\":\"array\",\"minItems\":1,\"items\":{\"$ref\":\"#/definitions/textBinding\"}}}},\"iconBinding\":{\"required\":[\"conditions\",\"elementId\"],\"type\":\"object\",\"properties\":{\"elementId\":{\"$ref\":\"#/definitions/elementId\"},\"conditions\":{\"description\":\"For this release, this must contain an array with a single 'condition' object whose 'condition' is true, and whose 'icon' member specifies the name of the icon to be used.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"condition\":{\"$ref\":\"#/definitions/condition\"},\"icon\":{\"description\":\"The name of the icon as specified in the 'icons' node.\",\"type\":\"string\"}}}}}},\"textBinding\":{\"required\":[\"elementId\",\"value\"],\"properties\":{\"elementId\":{\"$ref\":\"#/definitions/elementId\"},\"value\":{\"type\":\"string\"}}},\"notification\":{\"type\":\"object\",\"required\":[\"condition\",\"title\"],\"properties\":{\"condition\":{\"description\":\"The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax '<Operand1> <Operator> <Operand2>' or 'true'.\",\"type\":\"string\"},\"title\":{\"description\":\"The text to use for the notification title. If longer than 20 characters, it will be truncated.\",\"type\":\"string\"},\"body\":{\"description\":\"The text to use for the notification body. If longer than 20 characters, it will be truncated.\",\"type\":\"string\"}}}},\"id\":\"https://json.schemastore.org/band-manifest.json\",\"properties\":{\"manifestVersion\":{\"description\":\"Defines the contract between the web tile developer and the Microsoft Health app. It must be set to 1 for the current release.\",\"enum\":[1]},\"name\":{\"description\":\"Defines the name of the web tile.\",\"type\":\"string\",\"maxLength\":21},\"description\":{\"description\":\"Provides description about the web tile.\",\"type\":\"string\",\"maxLength\":100},\"version\":{\"description\":\"Indicates the version number of the web tile which will not be shown to users.\",\"type\":\"number\"},\"versionString\":{\"description\":\"Indicates the web tile version as shown to users. If not provided, it displays the version.\",\"type\":\"string\",\"maxLength\":10},\"author\":{\"description\":\"Specifies the author of the web tile.\",\"type\":\"string\",\"maxLength\":50},\"organization\":{\"description\":\"Specifies the organization associated with the web tile.\",\"type\":\"string\",\"maxLength\":100},\"contactEmail\":{\"description\":\"Provides contact info of the web tile author. Used for administrative purposes and analytics by Microsoft Band team.\",\"type\":\"string\",\"format\":\"email\",\"maxLength\":100},\"tileIcon\":{\"description\":\"Specifies the location of the large tile icon.\",\"type\":\"object\",\"required\":[\"46\"],\"properties\":{\"46\":{\"$ref\":\"#/definitions/icon\"}}},\"badgeIcon\":{\"description\":\"Specifies the location of the small tile icon. If not provided, the badging functionality is not enabled.\",\"type\":\"object\",\"required\":[\"24\"],\"properties\":{\"24\":{\"$ref\":\"#/definitions/icon\"}}},\"tileTheme\":{\"description\":\"Specifies the custom theme colors for the web tile.\",\"type\":\"object\",\"properties\":{\"base\":{\"$ref\":\"#/definitions/color\"},\"highlight\":{\"$ref\":\"#/definitions/color\"},\"lowlight\":{\"$ref\":\"#/definitions/color\"},\"secondary\":{\"$ref\":\"#/definitions/color\"},\"highcontrast\":{\"$ref\":\"#/definitions/color\"},\"muted\":{\"$ref\":\"#/definitions/color\"}}},\"refreshIntervalMinutes\":{\"description\":\"Specifies the desired data refresh interval, in minutes. Refresh intervals shorter than 15 will not be honored. If not provided, it defaults to 30.\",\"type\":\"integer\",\"default\":30,\"minimum\":15},\"resources\":{\"description\":\"Each web tile must refer to one or more web resources. Each resource object describes a web data from which content for the tile will be extracted.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/resource\"}},\"icons\":{\"description\":\"All PNG icons used by the tile within its pages must be provided here.\",\"type\":\"object\",\"maxProperties\":8,\"additionalProperties\":{\"$ref\":\"#/definitions/icon\"}},\"pages\":{\"description\":\"Each tile consists of one or more pages, as described by the objects in this array. Each page object specifies the layout and content of the page.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/page\"}},\"notifications\":{\"description\":\"Creates notification that gets delivered when certain conditions are detected in the new web data.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/notification\"}}},\"required\":[\"manifestVersion\",\"name\",\"tileIcon\",\"resources\",\"pages\"],\"title\":\"JSON schema for Microsoft Band manifests\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Microsoft Band manifests\". Here are the required top‑level fields: manifestVersion, name, tileIcon, resources, pages. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","definitions":{"icon":{"type":"string","pattern":"\\.png$"},"color":{"description":"The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.","type":"string","pattern":"^[A-Fa-f0-9]{6}$"},"elementId":{"description":"The numeric id of the icon layout element based on the predefined layout selected.","enum":["1","2","3","11","12","21","22","31","32"]},"condition":{"description":"If set, then must be set to 'true' for this release","enum":["true"]},"resource":{"type":"object","required":["url","style","content"],"properties":{"url":{"description":"The URL to be referenced. For resources that require authentication, the URL must be HTTPS.","type":"string","format":"uri"},"style":{"description":"Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.","type":"string","pattern":"^([sS]imple|[fF]eed)$","default":"Simple"},"content":{"description":"This member specifies how to extract content from the web response.","type":"object","minProperties":1,"additionalProperties":{"type":"string"}}}},"page":{"required":["layout"],"properties":{"layout":{"description":"The name of the layout for the page. The layout name should refer to one of the predefined page layouts.","enum":["MSBand_ScrollingText","MSBand_NoScrollingText","MSBand_SingleMetric","MSBand_SingleMetricWithIcon","MSBand_MetricsWithIcons","MSBand_SingleMetricWithSecondary"]},"condition":{"$ref":"#/definitions/condition"},"iconBindings":{"description":"Similar to textBindings, but used to select one of the web tile icons in icons list for each icon in the page. If there are no icon elements on the page, this member may be omitted.","type":"array","minItems":1,"items":{"$ref":"#/definitions/iconBinding"}},"textBindings":{"description":"An array of objects corresponding to each page element that contains string content. Each binding object provides the numeric id of the page element based on the predefined layout selected, and the string value that it should contain.","type":"array","minItems":1,"items":{"$ref":"#/definitions/textBinding"}}}},"iconBinding":{"required":["conditions","elementId"],"type":"object","properties":{"elementId":{"$ref":"#/definitions/elementId"},"conditions":{"description":"For this release, this must contain an array with a single 'condition' object whose 'condition' is true, and whose 'icon' member specifies the name of the icon to be used.","type":"array","items":{"type":"object","properties":{"condition":{"$ref":"#/definitions/condition"},"icon":{"description":"The name of the icon as specified in the 'icons' node.","type":"string"}}}}}},"textBinding":{"required":["elementId","value"],"properties":{"elementId":{"$ref":"#/definitions/elementId"},"value":{"type":"string"}}},"notification":{"type":"object","required":["condition","title"],"properties":{"condition":{"description":"The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax '<Operand1> <Operator> <Operand2>' or 'true'.","type":"string"},"title":{"description":"The text to use for the notification title. If longer than 20 characters, it will be truncated.","type":"string"},"body":{"description":"The text to use for the notification body. If longer than 20 characters, it will be truncated.","type":"string"}}}},"id":"https://json.schemastore.org/band-manifest.json","properties":{"manifestVersion":{"description":"Defines the contract between the web tile developer and the Microsoft Health app. It must be set to 1 for the current release.","enum":[1]},"name":{"description":"Defines the name of the web tile.","type":"string","maxLength":21},"description":{"description":"Provides description about the web tile.","type":"string","maxLength":100},"version":{"description":"Indicates the version number of the web tile which will not be shown to users.","type":"number"},"versionString":{"description":"Indicates the web tile version as shown to users. If not provided, it displays the version.","type":"string","maxLength":10},"author":{"description":"Specifies the author of the web tile.","type":"string","maxLength":50},"organization":{"description":"Specifies the organization associated with the web tile.","type":"string","maxLength":100},"contactEmail":{"description":"Provides contact info of the web tile author. Used for administrative purposes and analytics by Microsoft Band team.","type":"string","format":"email","maxLength":100},"tileIcon":{"description":"Specifies the location of the large tile icon.","type":"object","required":["46"],"properties":{"46":{"$ref":"#/definitions/icon"}}},"badgeIcon":{"description":"Specifies the location of the small tile icon. If not provided, the badging functionality is not enabled.","type":"object","required":["24"],"properties":{"24":{"$ref":"#/definitions/icon"}}},"tileTheme":{"description":"Specifies the custom theme colors for the web tile.","type":"object","properties":{"base":{"$ref":"#/definitions/color"},"highlight":{"$ref":"#/definitions/color"},"lowlight":{"$ref":"#/definitions/color"},"secondary":{"$ref":"#/definitions/color"},"highcontrast":{"$ref":"#/definitions/color"},"muted":{"$ref":"#/definitions/color"}}},"refreshIntervalMinutes":{"description":"Specifies the desired data refresh interval, in minutes. Refresh intervals shorter than 15 will not be honored. If not provided, it defaults to 30.","type":"integer","default":30,"minimum":15},"resources":{"description":"Each web tile must refer to one or more web resources. Each resource object describes a web data from which content for the tile will be extracted.","type":"array","items":{"$ref":"#/definitions/resource"}},"icons":{"description":"All PNG icons used by the tile within its pages must be provided here.","type":"object","maxProperties":8,"additionalProperties":{"$ref":"#/definitions/icon"}},"pages":{"description":"Each tile consists of one or more pages, as described by the objects in this array. Each page object specifies the layout and content of the page.","type":"array","items":{"$ref":"#/definitions/page"}},"notifications":{"description":"Creates notification that gets delivered when certain conditions are detected in the new web data.","type":"array","items":{"$ref":"#/definitions/notification"}}},"required":["manifestVersion","name","tileIcon","resources","pages"],"title":"JSON schema for Microsoft Band manifests","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Microsoft Band manifests". Here are the required top‑level fields: manifestVersion, name, tileIcon, resources, pages. Return only the valid JSON object.
|
JSON schema for Microsoft Band manifests
|
schema-store
|
schema_store_84
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema\",\"definitions\":{\"argument\":{\"title\":\"argument\",\"description\":\"A positional argument of the current script or sub-command\\nhttps://bashly.dev/configuration/argument/\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"title\":\"name\",\"description\":\"A name of the current positional argument\\nhttps://bashly.dev/configuration/argument/#name\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"user\"]},\"help\":{\"title\":\"help\",\"description\":\"A description of the current positional argument\\nhttps://bashly.dev/configuration/argument/#help\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"AWS Username\"]},\"default\":{\"title\":\"default\",\"description\":\"A default value of the current positional argument\\nhttps://bashly.dev/configuration/argument/#default\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"minItems\":1,\"items\":{\"type\":\"string\"}}],\"examples\":[\"*.jpg\"]},\"required\":{\"title\":\"required\",\"description\":\"Whether the current positional argument is required\\nhttps://bashly.dev/configuration/argument/#required\",\"type\":\"boolean\",\"default\":true},\"allowed\":{\"title\":\"allowed\",\"description\":\"Valid values of the current positional argument\\nhttps://bashly.dev/configuration/argument/#allowed\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A valid value of the current positional argument\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"eu\"]}},\"repeatable\":{\"title\":\"repeatable\",\"description\":\"Whether the current positional argument can be repeated\\nhttps://bashly.dev/configuration/argument/#repeatable\",\"type\":\"boolean\",\"default\":false},\"validate\":{\"title\":\"validate\",\"description\":\"A validation function of the current positional argument\\nhttps://bashly.dev/configuration/argument/#validate\",\"type\":\"string\",\"examples\":[\"file_exists\",\"dir_exists\",\"integer\",\"non_empty\"]},\"unique\":{\"title\":\"unique\",\"description\":\"Whether the current positional argument is unique\\nhttps://bashly.dev/configuration/argument/#unique\",\"type\":\"boolean\",\"default\":false}},\"dependencies\":{\"unique\":{\"properties\":{\"repeatable\":{\"const\":true}}}},\"patternProperties\":{\"^x_.\":{\"title\":\"custom property\",\"description\":\"A custom property of any type\",\"examples\":[\"Anything\"]}},\"additionalProperties\":false},\"flag\":{\"title\":\"flag\",\"description\":\"A flag of the current script or sub-command\\nhttps://bashly.dev/configuration/flag/\",\"type\":\"object\",\"anyOf\":[{\"required\":[\"long\"]},{\"required\":[\"short\"]}],\"properties\":{\"long\":{\"title\":\"long\",\"description\":\"A long form of the current flag\\nhttps://bashly.dev/configuration/flag/#long\",\"type\":\"string\",\"pattern\":\"^--\",\"examples\":[\"--ssh\"]},\"short\":{\"title\":\"short\",\"description\":\"A short form of the current flag\\nhttps://bashly.dev/configuration/flag/#short\",\"type\":\"string\",\"pattern\":\"^-[^-]\",\"examples\":[\"-s\"]},\"help\":{\"title\":\"help\",\"description\":\"A description of the current flag\\nhttps://bashly.dev/configuration/flag/#help\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"Clone using SSH\"]},\"arg\":{\"title\":\"arg\",\"description\":\"An argument name of the current flag\\nhttps://bashly.dev/configuration/flag/#arg\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"user\"]},\"default\":{\"title\":\"default\",\"description\":\"A default value of the current flag\\nhttps://bashly.dev/configuration/flag/#default\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"minItems\":1,\"items\":{\"type\":\"string\"}}],\"examples\":[\"*.jpg\"]},\"required\":{\"title\":\"required\",\"description\":\"Whether the current flag is required\\nhttps://bashly.dev/configuration/flag/#required\",\"type\":\"boolean\",\"default\":true},\"allowed\":{\"title\":\"allowed\",\"description\":\"Valid values of the current flag\\nhttps://bashly.dev/configuration/flag/#allowed\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A valid value of the current positional argument\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"user\"]}},\"conflicts\":{\"title\":\"conflicts\",\"description\":\"Mutually exclusive flags of the current flag\\nhttps://bashly.dev/configuration/flag/#conflicts\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"The long form of the required flag\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"--no-cache\"]}},\"needs\":{\"title\":\"needs\",\"description\":\"Additional flags required by the current flag\\nhttps://bashly.dev/configuration/flag/#needs\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"The long form of the required flag\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"--command\"]}},\"completions\":{\"title\":\"completions\",\"description\":\"Completions of the current flag\\nhttps://bashly.dev/configuration/flag/#completions\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A completion of the current flag\",\"type\":\"string\",\"minLength\":1}},\"private\":{\"title\":\"private\",\"description\":\"Whether the current flag is hidden from help\\nhttps://bashly.dev/configuration/flag/#private\",\"type\":\"boolean\",\"default\":false},\"repeatable\":{\"title\":\"repeatable\",\"description\":\"Whether the current flag can be repeated\\nhttps://bashly.dev/configuration/flag/#repeatable\",\"type\":\"boolean\",\"default\":false},\"validate\":{\"title\":\"validate\",\"description\":\"A validation function of the current flag\\nhttps://bashly.dev/configuration/flag/#validate\",\"type\":\"string\",\"examples\":[\"file_exists\",\"dir_exists\",\"integer\",\"non_empty\"]},\"unique\":{\"title\":\"unique\",\"description\":\"Whether the current flag is unique\\nhttps://bashly.dev/configuration/flag/#unique\",\"type\":\"boolean\",\"default\":false}},\"dependencies\":{\"unique\":{\"properties\":{\"repeatable\":{\"const\":true}}}},\"patternProperties\":{\"^x_.\":{\"title\":\"custom property\",\"description\":\"A custom property of any type\",\"examples\":[\"Anything\"]}},\"additionalProperties\":false},\"environment-variable\":{\"title\":\"environment variable\",\"description\":\"An environment variable of the current application\\nhttps://bashly.dev/configuration/environment-variable/#environment-variable\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"title\":\"name\",\"description\":\"A name of the current environment variable\\nhttps://bashly.dev/configuration/environment-variable/#name\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"config_path\"]},\"help\":{\"title\":\"help\",\"description\":\"A description of the current environment variable\\nhttps://bashly.dev/configuration/environment-variable/#help\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"Location of the config file\"]},\"private\":{\"title\":\"private\",\"description\":\"Whether the current environment variable is hidden from help\\nhttps://bashly.dev/configuration/environment-variable/#private\",\"type\":\"boolean\",\"default\":false},\"required\":{\"title\":\"required\",\"description\":\"Whether the current environment variable is required\\nhttps://bashly.dev/configuration/environment-variable/#required\",\"type\":\"boolean\",\"default\":true},\"validate\":{\"title\":\"validate\",\"description\":\"A validation function for the current environment variable\\nhttps://bashly.dev/configuration/environment-variable/#validate\",\"type\":\"string\",\"examples\":[\"file_exists\",\"dir_exists\",\"integer\",\"non_empty\"]},\"allowed\":{\"title\":\"allowed\",\"description\":\"Valid values of the current environment variable\\nhttps://bashly.dev/configuration/environment-variable/#allowed\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A valid value of the current environment variable\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"production\"]}},\"default\":{\"title\":\"default\",\"description\":\"A default value of the current environment variable\\nhttps://bashly.dev/configuration/environment-variable/#default\",\"type\":\"string\",\"examples\":[\"~/config.ini\"]}},\"patternProperties\":{\"^x_.\":{\"title\":\"custom property\",\"description\":\"A custom property of any type\",\"examples\":[\"Anything\"]}},\"additionalProperties\":false},\"variable\":{\"title\":\"variable\",\"description\":\"A global bash variable\\nhttps://bashly.dev/configuration/variable/#variable\",\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"title\":\"name\",\"description\":\"A name for the current variable\\nhttps://bashly.dev/configuration/variable/#name\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"output_dir\"]},\"value\":{\"title\":\"value\",\"description\":\"A value for the current variable\\nhttps://bashly.dev/configuration/variable/#value\",\"examples\":[\"./output\",[\"development\",\"production\"],{\"verbosity\":3,\"debug\":true}]}},\"patternProperties\":{\"^x_.\":{\"title\":\"custom property\",\"description\":\"A custom property of any type\",\"examples\":[\"Anything\"]}},\"additionalProperties\":false},\"name-property\":{\"title\":\"name\",\"description\":\"A name of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#name\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"source\"]},\"sub-command-alias-property\":{\"$comment\":\"'sub-command-' prefix is used as this property is marked with 'Sub-Commands Only' badge\",\"title\":\"alias\",\"oneOf\":[{\"description\":\"An alias of the current sub-command\\nhttps://bashly.dev/configuration/command/#alias\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"s\"]},{\"description\":\"Aliases of the current sub-command\\nhttps://bashly.dev/configuration/command/#alias\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"An alias of the current sub-command\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"s\"]}}]},\"help-property\":{\"title\":\"help\",\"description\":\"A description of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#help\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"URL to download from\"]},\"help-header-override-property\":{\"title\":\"help_header_override\",\"description\":\"Bash code (or function call) that will be executed at the beginning of the help message\\nhttps://bashly.dev/configuration/command/#help-header-override\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"generate_ascii_art_logo\"]},\"args-property\":{\"title\":\"args\",\"description\":\"Arguments of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#args\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/argument\"}},\"flags-property\":{\"title\":\"flags\",\"description\":\"Flags of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#flags\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/flag\"}},\"commands-property\":{\"title\":\"commands\",\"description\":\"Subcommands of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#commands\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/command-property\"}},\"root-version-property\":{\"$comment\":\"'root-' prefix is used as this property is marked with 'Root Command Only' badge\",\"title\":\"version\",\"description\":\"A version of the current script\\nhttps://bashly.dev/configuration/command/#version\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"0.1.0\"]},\"sub-command-default-property\":{\"title\":\"default\",\"description\":\"Whether to use the current command as a fallback when CLI used incorrectly\\nhttps://bashly.dev/configuration/command/#default\",\"oneOf\":[{\"type\":\"boolean\",\"default\":false},{\"type\":\"string\",\"enum\":[\"force\"]}]},\"environment-variables-property\":{\"title\":\"environment variables\",\"description\":\"Environment variables of the current application\\nhttps://bashly.dev/configuration/environment-variable/#environment-variable\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/environment-variable\"}},\"variables-property\":{\"title\":\"variables\",\"description\":\"Bash variables for the current application\\nhttps://bashly.dev/configuration/command/#variables\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/variable\"}},\"examples-property\":{\"title\":\"examples\",\"oneOf\":[{\"description\":\"An example of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#examples\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"cli upload profile.png -u admin -p s3cr3t\"]},{\"description\":\"Examples of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#examples\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"An example of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#examples\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"cli upload profile.png -u admin -p s3cr3t\"]}}]},\"footer-property\":{\"title\":\"footer\",\"description\":\"A description footer for the current script or sub-command\\nhttps://bashly.dev/configuration/command/#footer\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"This will appear at the end of the --help message\"]},\"sub-command-group-property\":{\"title\":\"group\",\"description\":\"A group of the current sub-command\\nhttps://bashly.dev/configuration/command/#group\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"File\"]},\"catch-all-property\":{\"title\":\"catch all\",\"description\":\"Whether to allow additional arguments or flags for the current command\\nhttps://bashly.dev/configuration/command/#catch_all\",\"oneOf\":[{\"type\":\"boolean\",\"default\":false},{\"type\":\"string\",\"minLength\":1,\"examples\":[\"Additional arguments or flags for AWS CLI\"]},{\"type\":\"object\",\"properties\":{\"label\":{\"description\":\"A label for the current argument or flag\\nhttps://bashly.dev/configuration/command/#catch_all\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"AWS Params\"]},\"help\":{\"description\":\"A description for the current argument or flag\\nhttps://bashly.dev/configuration/command/#catch_all\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"Additional arguments or flags for AWS CLI\"]},\"required\":{\"description\":\"Whether the current argument or flag is required\\nhttps://bashly.dev/configuration/command/#catch_all\",\"type\":\"boolean\",\"default\":false}},\"additionalProperties\":false}]},\"completions-property\":{\"title\":\"completions\",\"description\":\"Completions of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#completions\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A completion of the current script or sub-command\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"<alias>\",\"<arrayvar>\",\"<binding>\",\"<builtin>\",\"<command>\",\"<directory>\",\"<disabled>\",\"<enabled>\",\"<export>\",\"<file>\",\"<function>\",\"<group>\",\"<helptopic>\",\"<hostname>\",\"<job>\",\"<keyword>\",\"<running>\",\"<service>\",\"<setopt>\",\"<shopt>\",\"<signal>\",\"<stopped>\",\"<user>\",\"<variable>\"]}},\"dependencies-command-property\":{\"title\":\"command\",\"description\":\"Dependencies of the current script or sub-command\\nhttps://bashly.dev/configuration/dependency/#command\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A dependency of the current script or sub-command\\nhttps://bashly.dev/configuration/dependency/#command\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"git\"]}},\"dependencies-help-property\":{\"title\":\"help\",\"description\":\"A help for the current dependency\\nhttps://bashly.dev/configuration/dependency/#help\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"Run 'sudo apt install git'\"]},\"dependencies-property\":{\"title\":\"dependencies\",\"oneOf\":[{\"description\":\"Dependencies of the current script or sub-command\\nhttps://bashly.dev/configuration/dependency/#dependency\",\"type\":\"array\",\"minItems\":1,\"uniqueItems\":true,\"items\":{\"description\":\"A dependency of the current script or sub-command\\nhttps://bashly.dev/configuration/dependency/#dependency\",\"oneOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"}]}},{\"description\":\"Dependencies of the current script or sub-command\\nhttps://bashly.dev/configuration/dependency/#dependency\",\"type\":\"object\",\"patternProperties\":{\".\":{\"description\":\"A dependency of the current script or sub-command\\nhttps://bashly.dev/configuration/dependency/#dependency\",\"oneOf\":[{\"type\":\"string\",\"minLength\":1},{\"type\":\"null\"},{\"type\":\"object\",\"required\":[\"command\"],\"properties\":{\"command\":{\"$ref\":\"#/definitions/dependencies-command-property\"},\"help\":{\"$ref\":\"#/definitions/dependencies-help-property\"}},\"additionalProperties\":false}]}},\"additionalProperties\":false}]},\"sub-command-expose-property\":{\"title\":\"expose\",\"description\":\"Whether to expose the current sub-command if it has sub-commands\\nhttps://bashly.dev/configuration/command/#expose\",\"oneOf\":[{\"type\":\"boolean\",\"default\":false},{\"type\":\"string\",\"enum\":[\"always\"]}]},\"root-extensible-property\":{\"title\":\"extensible\",\"description\":\"Whether to delegate the current unknown command to an external executable\\nhttps://bashly.dev/configuration/command/#extensible\",\"oneOf\":[{\"type\":\"boolean\",\"default\":false},{\"type\":\"string\",\"examples\":[\"git\"]}]},\"filename-property\":{\"title\":\"filename\",\"description\":\"A partial file path of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#filename\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"dir_commands/list.sh\"]},\"filters-property\":{\"title\":\"filters\",\"description\":\"Filters of the current script or sub-command\\nhttps://bashly.dev/configuration/command/#filters\",\"type\":\"array\",\"minItems\":1,\"items\":{\"description\":\"A filter of the current script or sub-command\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"docker_running\"]}},\"function-property\":{\"title\":\"function\",\"description\":\"An internal function for the current script or sub-command\\nhttps://bashly.dev/configuration/command/#function\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"deprecated_container_start\"]},\"sub-command-private-property\":{\"title\":\"private\",\"description\":\"Whether hide the current sub-command from help\\nhttps://bashly.dev/configuration/command/#private\",\"type\":\"boolean\",\"default\":false},\"sub-command-import-property\":{\"title\":\"import\",\"description\":\"A file import for the current sub-command\\nhttps://bashly.dev/configuration/command/#import\",\"type\":\"string\",\"minLength\":1,\"examples\":[\"src/download_command.sh\"]},\"command-property\":{\"title\":\"command\",\"description\":\"A command of the current application\\nhttps://bashly.dev/configuration/command/#command\",\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/name-property\"},\"alias\":{\"$ref\":\"#/definitions/sub-command-alias-property\"},\"help\":{\"$ref\":\"#/definitions/help-property\"},\"help_header_override\":{\"$ref\":\"#/definitions/help-header-override-property\"},\"args\":{\"$ref\":\"#/definitions/args-property\"},\"flags\":{\"$ref\":\"#/definitions/flags-property\"},\"commands\":{\"$ref\":\"#/definitions/commands-property\"},\"default\":{\"$ref\":\"#/definitions/sub-command-default-property\"},\"environment_variables\":{\"$ref\":\"#/definitions/environment-variables-property\"},\"variables\":{\"$ref\":\"#/definitions/variables-property\"},\"examples\":{\"$ref\":\"#/definitions/examples-property\"},\"footer\":{\"$ref\":\"#/definitions/footer-property\"},\"group\":{\"$ref\":\"#/definitions/sub-command-group-property\"},\"catch_all\":{\"$ref\":\"#/definitions/catch-all-property\"},\"completions\":{\"$ref\":\"#/definitions/completions-property\"},\"dependencies\":{\"$ref\":\"#/definitions/dependencies-property\"},\"expose\":{\"$ref\":\"#/definitions/sub-command-expose-property\"},\"filename\":{\"$ref\":\"#/definitions/filename-property\"},\"filters\":{\"$ref\":\"#/definitions/filters-property\"},\"function\":{\"$ref\":\"#/definitions/function-property\"},\"private\":{\"$ref\":\"#/definitions/sub-command-private-property\"},\"import\":{\"$ref\":\"#/definitions/sub-command-import-property\"}},\"patternProperties\":{\"^x_.\":{\"title\":\"custom property\",\"description\":\"A custom property of any type\",\"examples\":[\"Anything\"]}},\"additionalProperties\":false}},\"title\":\"cli\",\"description\":\"A CLI of the current application\\nhttps://bashly.dev/usage/getting-started/\",\"type\":\"object\",\"properties\":{\"name\":{\"$ref\":\"#/definitions/name-property\"},\"help\":{\"$ref\":\"#/definitions/help-property\"},\"help_header_override\":{\"$ref\":\"#/definitions/help-header-override-property\"},\"args\":{\"$ref\":\"#/definitions/args-property\"},\"flags\":{\"$ref\":\"#/definitions/flags-property\"},\"commands\":{\"$ref\":\"#/definitions/commands-property\"},\"version\":{\"$ref\":\"#/definitions/root-version-property\"},\"environment_variables\":{\"$ref\":\"#/definitions/environment-variables-property\"},\"variables\":{\"$ref\":\"#/definitions/variables-property\"},\"examples\":{\"$ref\":\"#/definitions/examples-property\"},\"footer\":{\"$ref\":\"#/definitions/footer-property\"},\"catch_all\":{\"$ref\":\"#/definitions/catch-all-property\"},\"completions\":{\"$ref\":\"#/definitions/completions-property\"},\"dependencies\":{\"$ref\":\"#/definitions/dependencies-property\"},\"extensible\":{\"$ref\":\"#/definitions/root-extensible-property\"},\"filename\":{\"$ref\":\"#/definitions/filename-property\"},\"filters\":{\"$ref\":\"#/definitions/filters-property\"},\"function\":{\"$ref\":\"#/definitions/function-property\"}},\"patternProperties\":{\"^x_.\":{\"title\":\"custom property\",\"description\":\"A custom property of any type\",\"examples\":[\"Anything\"]}},\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"cli\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema","definitions":{"argument":{"title":"argument","description":"A positional argument of the current script or sub-command\nhttps://bashly.dev/configuration/argument/","type":"object","required":["name"],"properties":{"name":{"title":"name","description":"A name of the current positional argument\nhttps://bashly.dev/configuration/argument/#name","type":"string","minLength":1,"examples":["user"]},"help":{"title":"help","description":"A description of the current positional argument\nhttps://bashly.dev/configuration/argument/#help","type":"string","minLength":1,"examples":["AWS Username"]},"default":{"title":"default","description":"A default value of the current positional argument\nhttps://bashly.dev/configuration/argument/#default","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}],"examples":["*.jpg"]},"required":{"title":"required","description":"Whether the current positional argument is required\nhttps://bashly.dev/configuration/argument/#required","type":"boolean","default":true},"allowed":{"title":"allowed","description":"Valid values of the current positional argument\nhttps://bashly.dev/configuration/argument/#allowed","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A valid value of the current positional argument","type":"string","minLength":1,"examples":["eu"]}},"repeatable":{"title":"repeatable","description":"Whether the current positional argument can be repeated\nhttps://bashly.dev/configuration/argument/#repeatable","type":"boolean","default":false},"validate":{"title":"validate","description":"A validation function of the current positional argument\nhttps://bashly.dev/configuration/argument/#validate","type":"string","examples":["file_exists","dir_exists","integer","non_empty"]},"unique":{"title":"unique","description":"Whether the current positional argument is unique\nhttps://bashly.dev/configuration/argument/#unique","type":"boolean","default":false}},"dependencies":{"unique":{"properties":{"repeatable":{"const":true}}}},"patternProperties":{"^x_.":{"title":"custom property","description":"A custom property of any type","examples":["Anything"]}},"additionalProperties":false},"flag":{"title":"flag","description":"A flag of the current script or sub-command\nhttps://bashly.dev/configuration/flag/","type":"object","anyOf":[{"required":["long"]},{"required":["short"]}],"properties":{"long":{"title":"long","description":"A long form of the current flag\nhttps://bashly.dev/configuration/flag/#long","type":"string","pattern":"^--","examples":["--ssh"]},"short":{"title":"short","description":"A short form of the current flag\nhttps://bashly.dev/configuration/flag/#short","type":"string","pattern":"^-[^-]","examples":["-s"]},"help":{"title":"help","description":"A description of the current flag\nhttps://bashly.dev/configuration/flag/#help","type":"string","minLength":1,"examples":["Clone using SSH"]},"arg":{"title":"arg","description":"An argument name of the current flag\nhttps://bashly.dev/configuration/flag/#arg","type":"string","minLength":1,"examples":["user"]},"default":{"title":"default","description":"A default value of the current flag\nhttps://bashly.dev/configuration/flag/#default","oneOf":[{"type":"string"},{"type":"array","minItems":1,"items":{"type":"string"}}],"examples":["*.jpg"]},"required":{"title":"required","description":"Whether the current flag is required\nhttps://bashly.dev/configuration/flag/#required","type":"boolean","default":true},"allowed":{"title":"allowed","description":"Valid values of the current flag\nhttps://bashly.dev/configuration/flag/#allowed","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A valid value of the current positional argument","type":"string","minLength":1,"examples":["user"]}},"conflicts":{"title":"conflicts","description":"Mutually exclusive flags of the current flag\nhttps://bashly.dev/configuration/flag/#conflicts","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"The long form of the required flag","type":"string","minLength":1,"examples":["--no-cache"]}},"needs":{"title":"needs","description":"Additional flags required by the current flag\nhttps://bashly.dev/configuration/flag/#needs","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"The long form of the required flag","type":"string","minLength":1,"examples":["--command"]}},"completions":{"title":"completions","description":"Completions of the current flag\nhttps://bashly.dev/configuration/flag/#completions","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A completion of the current flag","type":"string","minLength":1}},"private":{"title":"private","description":"Whether the current flag is hidden from help\nhttps://bashly.dev/configuration/flag/#private","type":"boolean","default":false},"repeatable":{"title":"repeatable","description":"Whether the current flag can be repeated\nhttps://bashly.dev/configuration/flag/#repeatable","type":"boolean","default":false},"validate":{"title":"validate","description":"A validation function of the current flag\nhttps://bashly.dev/configuration/flag/#validate","type":"string","examples":["file_exists","dir_exists","integer","non_empty"]},"unique":{"title":"unique","description":"Whether the current flag is unique\nhttps://bashly.dev/configuration/flag/#unique","type":"boolean","default":false}},"dependencies":{"unique":{"properties":{"repeatable":{"const":true}}}},"patternProperties":{"^x_.":{"title":"custom property","description":"A custom property of any type","examples":["Anything"]}},"additionalProperties":false},"environment-variable":{"title":"environment variable","description":"An environment variable of the current application\nhttps://bashly.dev/configuration/environment-variable/#environment-variable","type":"object","required":["name"],"properties":{"name":{"title":"name","description":"A name of the current environment variable\nhttps://bashly.dev/configuration/environment-variable/#name","type":"string","minLength":1,"examples":["config_path"]},"help":{"title":"help","description":"A description of the current environment variable\nhttps://bashly.dev/configuration/environment-variable/#help","type":"string","minLength":1,"examples":["Location of the config file"]},"private":{"title":"private","description":"Whether the current environment variable is hidden from help\nhttps://bashly.dev/configuration/environment-variable/#private","type":"boolean","default":false},"required":{"title":"required","description":"Whether the current environment variable is required\nhttps://bashly.dev/configuration/environment-variable/#required","type":"boolean","default":true},"validate":{"title":"validate","description":"A validation function for the current environment variable\nhttps://bashly.dev/configuration/environment-variable/#validate","type":"string","examples":["file_exists","dir_exists","integer","non_empty"]},"allowed":{"title":"allowed","description":"Valid values of the current environment variable\nhttps://bashly.dev/configuration/environment-variable/#allowed","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A valid value of the current environment variable","type":"string","minLength":1,"examples":["production"]}},"default":{"title":"default","description":"A default value of the current environment variable\nhttps://bashly.dev/configuration/environment-variable/#default","type":"string","examples":["~/config.ini"]}},"patternProperties":{"^x_.":{"title":"custom property","description":"A custom property of any type","examples":["Anything"]}},"additionalProperties":false},"variable":{"title":"variable","description":"A global bash variable\nhttps://bashly.dev/configuration/variable/#variable","type":"object","required":["name"],"properties":{"name":{"title":"name","description":"A name for the current variable\nhttps://bashly.dev/configuration/variable/#name","type":"string","minLength":1,"examples":["output_dir"]},"value":{"title":"value","description":"A value for the current variable\nhttps://bashly.dev/configuration/variable/#value","examples":["./output",["development","production"],{"verbosity":3,"debug":true}]}},"patternProperties":{"^x_.":{"title":"custom property","description":"A custom property of any type","examples":["Anything"]}},"additionalProperties":false},"name-property":{"title":"name","description":"A name of the current script or sub-command\nhttps://bashly.dev/configuration/command/#name","type":"string","minLength":1,"examples":["source"]},"sub-command-alias-property":{"$comment":"'sub-command-' prefix is used as this property is marked with 'Sub-Commands Only' badge","title":"alias","oneOf":[{"description":"An alias of the current sub-command\nhttps://bashly.dev/configuration/command/#alias","type":"string","minLength":1,"examples":["s"]},{"description":"Aliases of the current sub-command\nhttps://bashly.dev/configuration/command/#alias","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"An alias of the current sub-command","type":"string","minLength":1,"examples":["s"]}}]},"help-property":{"title":"help","description":"A description of the current script or sub-command\nhttps://bashly.dev/configuration/command/#help","type":"string","minLength":1,"examples":["URL to download from"]},"help-header-override-property":{"title":"help_header_override","description":"Bash code (or function call) that will be executed at the beginning of the help message\nhttps://bashly.dev/configuration/command/#help-header-override","type":"string","minLength":1,"examples":["generate_ascii_art_logo"]},"args-property":{"title":"args","description":"Arguments of the current script or sub-command\nhttps://bashly.dev/configuration/command/#args","type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/argument"}},"flags-property":{"title":"flags","description":"Flags of the current script or sub-command\nhttps://bashly.dev/configuration/command/#flags","type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/flag"}},"commands-property":{"title":"commands","description":"Subcommands of the current script or sub-command\nhttps://bashly.dev/configuration/command/#commands","type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/command-property"}},"root-version-property":{"$comment":"'root-' prefix is used as this property is marked with 'Root Command Only' badge","title":"version","description":"A version of the current script\nhttps://bashly.dev/configuration/command/#version","type":"string","minLength":1,"examples":["0.1.0"]},"sub-command-default-property":{"title":"default","description":"Whether to use the current command as a fallback when CLI used incorrectly\nhttps://bashly.dev/configuration/command/#default","oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["force"]}]},"environment-variables-property":{"title":"environment variables","description":"Environment variables of the current application\nhttps://bashly.dev/configuration/environment-variable/#environment-variable","type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/environment-variable"}},"variables-property":{"title":"variables","description":"Bash variables for the current application\nhttps://bashly.dev/configuration/command/#variables","type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/variable"}},"examples-property":{"title":"examples","oneOf":[{"description":"An example of the current script or sub-command\nhttps://bashly.dev/configuration/command/#examples","type":"string","minLength":1,"examples":["cli upload profile.png -u admin -p s3cr3t"]},{"description":"Examples of the current script or sub-command\nhttps://bashly.dev/configuration/command/#examples","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"An example of the current script or sub-command\nhttps://bashly.dev/configuration/command/#examples","type":"string","minLength":1,"examples":["cli upload profile.png -u admin -p s3cr3t"]}}]},"footer-property":{"title":"footer","description":"A description footer for the current script or sub-command\nhttps://bashly.dev/configuration/command/#footer","type":"string","minLength":1,"examples":["This will appear at the end of the --help message"]},"sub-command-group-property":{"title":"group","description":"A group of the current sub-command\nhttps://bashly.dev/configuration/command/#group","type":"string","minLength":1,"examples":["File"]},"catch-all-property":{"title":"catch all","description":"Whether to allow additional arguments or flags for the current command\nhttps://bashly.dev/configuration/command/#catch_all","oneOf":[{"type":"boolean","default":false},{"type":"string","minLength":1,"examples":["Additional arguments or flags for AWS CLI"]},{"type":"object","properties":{"label":{"description":"A label for the current argument or flag\nhttps://bashly.dev/configuration/command/#catch_all","type":"string","minLength":1,"examples":["AWS Params"]},"help":{"description":"A description for the current argument or flag\nhttps://bashly.dev/configuration/command/#catch_all","type":"string","minLength":1,"examples":["Additional arguments or flags for AWS CLI"]},"required":{"description":"Whether the current argument or flag is required\nhttps://bashly.dev/configuration/command/#catch_all","type":"boolean","default":false}},"additionalProperties":false}]},"completions-property":{"title":"completions","description":"Completions of the current script or sub-command\nhttps://bashly.dev/configuration/command/#completions","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A completion of the current script or sub-command","type":"string","minLength":1,"examples":["<alias>","<arrayvar>","<binding>","<builtin>","<command>","<directory>","<disabled>","<enabled>","<export>","<file>","<function>","<group>","<helptopic>","<hostname>","<job>","<keyword>","<running>","<service>","<setopt>","<shopt>","<signal>","<stopped>","<user>","<variable>"]}},"dependencies-command-property":{"title":"command","description":"Dependencies of the current script or sub-command\nhttps://bashly.dev/configuration/dependency/#command","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A dependency of the current script or sub-command\nhttps://bashly.dev/configuration/dependency/#command","type":"string","minLength":1,"examples":["git"]}},"dependencies-help-property":{"title":"help","description":"A help for the current dependency\nhttps://bashly.dev/configuration/dependency/#help","type":"string","minLength":1,"examples":["Run 'sudo apt install git'"]},"dependencies-property":{"title":"dependencies","oneOf":[{"description":"Dependencies of the current script or sub-command\nhttps://bashly.dev/configuration/dependency/#dependency","type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A dependency of the current script or sub-command\nhttps://bashly.dev/configuration/dependency/#dependency","oneOf":[{"type":"string","minLength":1},{"type":"null"}]}},{"description":"Dependencies of the current script or sub-command\nhttps://bashly.dev/configuration/dependency/#dependency","type":"object","patternProperties":{".":{"description":"A dependency of the current script or sub-command\nhttps://bashly.dev/configuration/dependency/#dependency","oneOf":[{"type":"string","minLength":1},{"type":"null"},{"type":"object","required":["command"],"properties":{"command":{"$ref":"#/definitions/dependencies-command-property"},"help":{"$ref":"#/definitions/dependencies-help-property"}},"additionalProperties":false}]}},"additionalProperties":false}]},"sub-command-expose-property":{"title":"expose","description":"Whether to expose the current sub-command if it has sub-commands\nhttps://bashly.dev/configuration/command/#expose","oneOf":[{"type":"boolean","default":false},{"type":"string","enum":["always"]}]},"root-extensible-property":{"title":"extensible","description":"Whether to delegate the current unknown command to an external executable\nhttps://bashly.dev/configuration/command/#extensible","oneOf":[{"type":"boolean","default":false},{"type":"string","examples":["git"]}]},"filename-property":{"title":"filename","description":"A partial file path of the current script or sub-command\nhttps://bashly.dev/configuration/command/#filename","type":"string","minLength":1,"examples":["dir_commands/list.sh"]},"filters-property":{"title":"filters","description":"Filters of the current script or sub-command\nhttps://bashly.dev/configuration/command/#filters","type":"array","minItems":1,"items":{"description":"A filter of the current script or sub-command","type":"string","minLength":1,"examples":["docker_running"]}},"function-property":{"title":"function","description":"An internal function for the current script or sub-command\nhttps://bashly.dev/configuration/command/#function","type":"string","minLength":1,"examples":["deprecated_container_start"]},"sub-command-private-property":{"title":"private","description":"Whether hide the current sub-command from help\nhttps://bashly.dev/configuration/command/#private","type":"boolean","default":false},"sub-command-import-property":{"title":"import","description":"A file import for the current sub-command\nhttps://bashly.dev/configuration/command/#import","type":"string","minLength":1,"examples":["src/download_command.sh"]},"command-property":{"title":"command","description":"A command of the current application\nhttps://bashly.dev/configuration/command/#command","type":"object","properties":{"name":{"$ref":"#/definitions/name-property"},"alias":{"$ref":"#/definitions/sub-command-alias-property"},"help":{"$ref":"#/definitions/help-property"},"help_header_override":{"$ref":"#/definitions/help-header-override-property"},"args":{"$ref":"#/definitions/args-property"},"flags":{"$ref":"#/definitions/flags-property"},"commands":{"$ref":"#/definitions/commands-property"},"default":{"$ref":"#/definitions/sub-command-default-property"},"environment_variables":{"$ref":"#/definitions/environment-variables-property"},"variables":{"$ref":"#/definitions/variables-property"},"examples":{"$ref":"#/definitions/examples-property"},"footer":{"$ref":"#/definitions/footer-property"},"group":{"$ref":"#/definitions/sub-command-group-property"},"catch_all":{"$ref":"#/definitions/catch-all-property"},"completions":{"$ref":"#/definitions/completions-property"},"dependencies":{"$ref":"#/definitions/dependencies-property"},"expose":{"$ref":"#/definitions/sub-command-expose-property"},"filename":{"$ref":"#/definitions/filename-property"},"filters":{"$ref":"#/definitions/filters-property"},"function":{"$ref":"#/definitions/function-property"},"private":{"$ref":"#/definitions/sub-command-private-property"},"import":{"$ref":"#/definitions/sub-command-import-property"}},"patternProperties":{"^x_.":{"title":"custom property","description":"A custom property of any type","examples":["Anything"]}},"additionalProperties":false}},"title":"cli","description":"A CLI of the current application\nhttps://bashly.dev/usage/getting-started/","type":"object","properties":{"name":{"$ref":"#/definitions/name-property"},"help":{"$ref":"#/definitions/help-property"},"help_header_override":{"$ref":"#/definitions/help-header-override-property"},"args":{"$ref":"#/definitions/args-property"},"flags":{"$ref":"#/definitions/flags-property"},"commands":{"$ref":"#/definitions/commands-property"},"version":{"$ref":"#/definitions/root-version-property"},"environment_variables":{"$ref":"#/definitions/environment-variables-property"},"variables":{"$ref":"#/definitions/variables-property"},"examples":{"$ref":"#/definitions/examples-property"},"footer":{"$ref":"#/definitions/footer-property"},"catch_all":{"$ref":"#/definitions/catch-all-property"},"completions":{"$ref":"#/definitions/completions-property"},"dependencies":{"$ref":"#/definitions/dependencies-property"},"extensible":{"$ref":"#/definitions/root-extensible-property"},"filename":{"$ref":"#/definitions/filename-property"},"filters":{"$ref":"#/definitions/filters-property"},"function":{"$ref":"#/definitions/function-property"}},"patternProperties":{"^x_.":{"title":"custom property","description":"A custom property of any type","examples":["Anything"]}},"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "cli". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
cli
|
schema-store
|
schema_store_85
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/behat.json\",\"additionalProperties\":{\"$ref\":\"#/definitions/profile\",\"title\":\"Profile name\"},\"definitions\":{\"profile\":{\"title\":\"Profile\",\"type\":\"object\",\"properties\":{\"autoload\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}},\"formatters\":{\"title\":\"How to format tests output\",\"default\":\"pretty\",\"type\":\"object\",\"properties\":{\"pretty\":{\"title\":\"Prints the feature as is\",\"type\":\"boolean\"},\"progress\":{\"title\":\"Prints one character per step\",\"type\":\"boolean\"},\"junit\":{\"title\":\"Outputs the failures in JUnit compatible files.\",\"type\":\"boolean\"}},\"additionalProperties\":false},\"suites\":{\"title\":\"Test suites\",\"type\":\"object\",\"additionalProperties\":{\"$ref\":\"#/definitions/suite\"}},\"extensions\":{\"title\":\"Behat extensions\",\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\"}}}},\"suite\":{\"title\":\"Test suite\",\"type\":\"object\",\"properties\":{\"paths\":{\"title\":\"Paths to execute\",\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"contexts\":{\"title\":\"Suite contexts\",\"type\":\"array\",\"items\":{\"type\":[\"string\",\"object\"]},\"uniqueItems\":true},\"filters\":{\"title\":\"Suite filters\",\"type\":\"object\",\"properties\":{\"tags\":{\"type\":\"string\"},\"role\":{\"type\":\"string\"}}}}}},\"properties\":{\"default\":{\"$ref\":\"#/definitions/profile\",\"title\":\"Default profile\"},\"imports\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true}},\"title\":\"JSON schema for Behat configuration files\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Behat configuration files\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/behat.json","additionalProperties":{"$ref":"#/definitions/profile","title":"Profile name"},"definitions":{"profile":{"title":"Profile","type":"object","properties":{"autoload":{"type":"object","additionalProperties":{"type":"string"}},"formatters":{"title":"How to format tests output","default":"pretty","type":"object","properties":{"pretty":{"title":"Prints the feature as is","type":"boolean"},"progress":{"title":"Prints one character per step","type":"boolean"},"junit":{"title":"Outputs the failures in JUnit compatible files.","type":"boolean"}},"additionalProperties":false},"suites":{"title":"Test suites","type":"object","additionalProperties":{"$ref":"#/definitions/suite"}},"extensions":{"title":"Behat extensions","type":"object","additionalProperties":{"type":"object"}}}},"suite":{"title":"Test suite","type":"object","properties":{"paths":{"title":"Paths to execute","type":"array","items":{"type":"string"},"uniqueItems":true},"contexts":{"title":"Suite contexts","type":"array","items":{"type":["string","object"]},"uniqueItems":true},"filters":{"title":"Suite filters","type":"object","properties":{"tags":{"type":"string"},"role":{"type":"string"}}}}}},"properties":{"default":{"$ref":"#/definitions/profile","title":"Default profile"},"imports":{"type":"array","items":{"type":"string"},"uniqueItems":true}},"title":"JSON schema for Behat configuration files","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Behat configuration files". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Behat configuration files
|
schema-store
|
schema_store_86
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/bettercodehub.json\",\"$comment\":\"https://www.bettercodehub.com/docs/configuration-manual\",\"additionalProperties\":false,\"definitions\":{\"supportedProgrammingLanguage\":{\"type\":\"string\",\"enum\":[\"csharp\",\"cpp\",\"go\",\"groovy\",\"java\",\"javascript\",\"objectivec\",\"perl\",\"php\",\"python\",\"ruby\",\"scala\",\"script\",\"solidity\",\"swift\",\"typescript\",\"kotlin\"]},\"excludeFileFilter\":{\"title\":\"Exclude\",\"type\":\"array\",\"items\":{\"title\":\"Pattern\",\"description\":\"A regular expression for the path(s) to exclude.\",\"type\":\"string\"}},\"fileFilter\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"include\":{\"title\":\"Include\",\"type\":\"array\",\"items\":{\"title\":\"Pattern\",\"description\":\"A regular expression for the path(s) to include.\",\"type\":\"string\"}},\"exclude\":{\"$ref\":\"#/definitions/excludeFileFilter\"}}}},\"description\":\"Configuration file for Better Code Hub to override the default configuration.\",\"properties\":{\"component_depth\":{\"title\":\"Component Depth\",\"type\":\"integer\",\"default\":1},\"languages\":{\"title\":\"Languages\",\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/supportedProgrammingLanguage\"},{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"$ref\":\"#/definitions/supportedProgrammingLanguage\",\"title\":\"Name\"},\"production\":{\"$ref\":\"#/definitions/fileFilter\",\"title\":\"Production\"},\"test\":{\"$ref\":\"#/definitions/fileFilter\",\"title\":\"Test\"}}}]}},\"exclude\":{\"$ref\":\"#/definitions/excludeFileFilter\"}},\"title\":\"Better Code Hub\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Better Code Hub\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/bettercodehub.json","$comment":"https://www.bettercodehub.com/docs/configuration-manual","additionalProperties":false,"definitions":{"supportedProgrammingLanguage":{"type":"string","enum":["csharp","cpp","go","groovy","java","javascript","objectivec","perl","php","python","ruby","scala","script","solidity","swift","typescript","kotlin"]},"excludeFileFilter":{"title":"Exclude","type":"array","items":{"title":"Pattern","description":"A regular expression for the path(s) to exclude.","type":"string"}},"fileFilter":{"type":"object","additionalProperties":false,"properties":{"include":{"title":"Include","type":"array","items":{"title":"Pattern","description":"A regular expression for the path(s) to include.","type":"string"}},"exclude":{"$ref":"#/definitions/excludeFileFilter"}}}},"description":"Configuration file for Better Code Hub to override the default configuration.","properties":{"component_depth":{"title":"Component Depth","type":"integer","default":1},"languages":{"title":"Languages","type":"array","items":{"anyOf":[{"$ref":"#/definitions/supportedProgrammingLanguage"},{"type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/definitions/supportedProgrammingLanguage","title":"Name"},"production":{"$ref":"#/definitions/fileFilter","title":"Production"},"test":{"$ref":"#/definitions/fileFilter","title":"Test"}}}]}},"exclude":{"$ref":"#/definitions/excludeFileFilter"}},"title":"Better Code Hub","type":"object"}
|
Provide a JSON object that satisfies the schema "Better Code Hub". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Better Code Hub
|
schema-store
|
schema_store_87
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/metaschema-draft-07-unofficial-strict.json\",\"additionalProperties\":true,\"properties\":{\"type\":{\"title\":\"Type\",\"type\":\"string\",\"default\":\"BIGCONFIG_FILE\",\"anyOf\":[{\"const\":\"BIGCONFIG_FILE\"}]},\"auto_apply_on_indexing\":{\"title\":\"Auto Apply On Indexing\",\"default\":true,\"type\":\"boolean\"},\"tag_definitions\":{\"title\":\"Tag Definitions\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/TagDefinition\"}},\"row_creation_times\":{\"title\":\"Row Creation Times\",\"default\":{\"tag_ids\":[],\"column_selectors\":[]},\"allOf\":[{\"$ref\":\"#/definitions/RowCreationTimes\"}]},\"saved_metric_definitions\":{\"$ref\":\"#/definitions/SavedMetricDefinitions\"},\"tag_deployments\":{\"title\":\"Tag Deployments\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/TagDeploymentSuite\"}},\"table_deployments\":{\"title\":\"Table Deployments\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/TableDeploymentSuite\"}}},\"type\":\"object\",\"title\":\"Bigconfig\",\"description\":\"Bigconfig is a yaml-based declarative monitoring as code solution. Data engineers can deploy Bigeye metrics from the command-line for convenient and scalable data quality monitoring.\",\"required\":[\"type\"],\"definitions\":{\"SimpleFieldType\":{\"title\":\"SimpleFieldType\",\"enum\":[\"UNSPECIFIED\",\"STRING\",\"UUID\",\"BINARY\",\"NUMERIC\",\"DATE_LIKE\",\"TIMESTAMP_LIKE\",\"ANY\",\"BOOLEAN\",\"UNKNOWN\",\"ARRAY\",\"STRUCT\"],\"type\":\"string\"},\"ColumnSelector\":{\"title\":\"ColumnSelector\",\"type\":\"object\",\"default\":{\"name\":\"*.*.*.*\"},\"properties\":{\"name\":{\"title\":\"Name\",\"type\":\"string\",\"default\":\"*.*.*.*\"},\"type\":{\"$ref\":\"#/definitions/SimpleFieldType\"},\"exclude\":{\"title\":\"Exclude\",\"type\":\"string\"},\"regex\":{\"title\":\"Regex\",\"type\":\"string\"}}},\"TagDefinition\":{\"title\":\"TagDefinition\",\"type\":\"object\",\"default\":{\"tag_id\":\"TAG_ID\"},\"properties\":{\"tag_id\":{\"title\":\"Tag Id\",\"type\":\"string\"},\"column_selectors\":{\"title\":\"Column Selectors\",\"type\":\"array\",\"default\":[{\"name\":\"*.*.*.*\"}],\"items\":{\"$ref\":\"#/definitions/ColumnSelector\"}}},\"required\":[\"tag_id\",\"column_selectors\"]},\"RowCreationTimes\":{\"title\":\"RowCreationTimes\",\"type\":\"object\",\"properties\":{\"tag_ids\":{\"title\":\"Tag Ids\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"column_selectors\":{\"title\":\"Column Selectors\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ColumnSelector\"}}}},\"NotificationChannels\":{\"title\":\"Notification Channels\",\"type\":\"object\",\"properties\":{\"slack\":{\"type\":\"string\"},\"email\":{\"type\":\"string\"},\"webhook\":{\"type\":\"string\"},\"webhook_header_key\":{\"type\":\"string\"},\"webhook_header_value\":{\"type\":\"string\"}}},\"MetricParameters\":{\"title\":\"Metric Parameters\",\"type\":\"object\",\"properties\":{\"key\":{\"type\":\"string\"},\"string_value\":{\"type\":\"string\"},\"column_name\":{\"type\":\"string\"},\"number_value\":{\"type\":\"number\"}}},\"SimpleMetricDefinition\":{\"title\":\"SimpleMetricDefinition\",\"type\":\"object\",\"properties\":{\"saved_metric_id\":{\"title\":\"Saved Metric id\",\"type\":\"string\"},\"metric_type\":{\"title\":\"Metric Type\",\"type\":\"object\",\"properties\":{\"predefined_metric\":{\"title\":\"Predefined Metric\",\"enum\":[\"PERCENT_NULL\",\"COUNT_NULL\",\"PERCENT_EMPTY_STRING\",\"COUNT_EMPTY_STRING\",\"PERCENT_UNIQUE\",\"PERCENT_VALUE_IN_LIST\",\"AVERAGE\",\"MIN\",\"MAX\",\"SUM\",\"COUNT_ROWS\",\"COUNT_DISTINCT\",\"HOURS_SINCE_MAX_DATE\",\"HOURS_SINCE_MAX_TIMESTAMP\",\"COUNT_TRUE\",\"PERCENT_TRUE\",\"COUNT_FALSE\",\"PERCENT_FALSE\",\"COUNT_USA_PHONE\",\"PERCENT_USA_PHONE\",\"COUNT_USA_ZIP_CODE\",\"PERCENT_USA_ZIP_CODE\",\"PERCENT_UUID\",\"COUNT_TIMESTAMP_STRING\",\"PERCENT_TIMESTAMP_STRING\",\"COUNT_DUPLICATES\",\"COUNT_USA_STATE_CODE\",\"PERCENT_USA_STATE_CODE\",\"VARIANCE\",\"SKEW\",\"KURTOSIS\",\"GEOMETRIC_MEAN\",\"HARMONIC_MEAN\",\"COUNT_UUID\",\"COUNT_CUSIP\",\"PERCENT_CUSIP\",\"COUNT_SEDOL\",\"PERCENT_SEDOL\",\"COUNT_ISIN\",\"PERCENT_ISIN\",\"COUNT_LEI\",\"PERCENT_LEI\",\"COUNT_FIGI\",\"PERCENT_FIGI\",\"COUNT_PERM_ID\",\"PERCENT_PERM_ID\",\"COUNT_NAN\",\"PERCENT_NAN\",\"COUNT_LONGITUDE\",\"PERCENT_LONGITUDE\",\"COUNT_LATITUDE\",\"PERCENT_LATITUDE\",\"COUNT_NOT_IN_FUTURE\",\"PERCENT_NOT_IN_FUTURE\",\"COUNT_DATE_NOT_IN_FUTURE\",\"PERCENT_DATE_NOT_IN_FUTURE\",\"MEDIAN\",\"PERCENTILE\",\"COUNT_NOT_NULL\",\"STRING_LENGTH_AVERAGE\",\"STRING_LENGTH_MIN\",\"STRING_LENGTH_MAX\",\"COUNT_SSN\",\"PERCENT_SSN\",\"COUNT_EMAIL\",\"PERCENT_EMAIL\",\"ROWS_INSERTED\",\"HOURS_SINCE_LAST_LOAD\",\"COUNT_READ_QUERIES\",\"PERCENT_NOT_NULL\",\"FRESHNESS\",\"VOLUME\"]},\"type\":{\"type\":\"string\",\"enum\":[\"PREDEFINED\",\"TEMPLATE\"]},\"template_id\":{\"type\":\"number\"},\"aggregation_type\":{\"type\":\"string\",\"enum\":[\"COUNT\",\"PERCENT\"]}},\"required\":[\"predefined_metric\"]},\"metric_name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"schedule_frequency\":{\"type\":\"object\",\"default\":{\"interval_type\":\"HOURS\",\"interval_value\":24},\"properties\":{\"interval_type\":{\"enum\":[\"HOURS\",\"MINUTES\"],\"default\":\"HOURS\"},\"interval_value\":{\"type\":\"number\",\"default\":24}},\"required\":[\"interval_type\",\"interval_value\"]},\"conditions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"group_by\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"threshold\":{\"type\":\"object\",\"properties\":{\"type\":{\"enum\":[\"AUTO\",\"RELATIVE\",\"STDDEV\",\"CONSTANT\"]},\"sensitivity\":{\"description\":\"Only valid for autothreshold metrics\",\"enum\":[\"NARROW\",\"MEDIUM\",\"WIDE\",\"XWIDE\"]},\"upper_bound\":{\"description\":\"Only valid for constant, relative, and standard deviation metrics\",\"type\":\"number\"},\"lower_bound\":{\"description\":\"Only valid for constant, relative, and standard deviation metrics\",\"type\":\"number\"},\"upper_bound_only\":{\"description\":\"Only valid for autothreshold metrics\",\"type\":\"boolean\"},\"lower_bound_only\":{\"description\":\"Only valid for autothreshold metrics\",\"type\":\"boolean\"},\"reference_point\":{\"type\":\"object\",\"description\":\"Only valid for relative and standard deviation metrics\",\"properties\":{\"interval_type\":{\"enum\":[\"DAYS\"]},\"interval_value\":{\"type\":\"number\"}},\"required\":[\"interval_type\",\"interval_value\"]}},\"required\":[\"type\"]},\"notification_channels\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/NotificationChannels\"}},\"parameters\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/MetricParameters\"}},\"lookback\":{\"type\":\"object\",\"properties\":{\"lookback_type\":{\"enum\":[\"DATA_TIME\",\"METRIC_TIME\",\"CLOCK_TIME\"]},\"lookback_window\":{\"type\":\"object\",\"properties\":{\"interval_type\":{\"enum\":[\"DAYS\"]},\"interval_value\":{\"type\":\"number\"}},\"required\":[\"interval_type\",\"interval_value\"]},\"bucket_size\":{\"description\":\"Only valid for data time window metrics\",\"enum\":[\"DAY\",\"HOUR\"]}},\"required\":[\"lookback_type\",\"lookback_window\"]},\"metric_schedule\":{\"type\":\"object\",\"properties\":{\"named_schedule\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"cron\":{\"type\":\"string\"},\"id\":{\"type\":\"number\"}},\"required\":[\"name\"]}},\"required\":[\"named_schedule\"]}}},\"SavedMetricDefinitions\":{\"title\":\"SavedMetricDefinitions\",\"type\":\"object\",\"properties\":{\"metrics\":{\"title\":\"Metrics\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/SimpleMetricDefinition\"}}},\"required\":[\"metrics\"]},\"TagDeployment\":{\"title\":\"TagDeployment\",\"type\":\"object\",\"properties\":{\"column_selectors\":{\"title\":\"Column Selectors\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ColumnSelector\"}},\"metrics\":{\"title\":\"Metrics\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/SimpleMetricDefinition\"}},\"tag_id\":{\"title\":\"Tag Id\",\"type\":\"string\"}},\"required\":[\"metrics\"]},\"SimpleCollection\":{\"title\":\"SimpleCollection\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"notification_channels\":{\"$ref\":\"#/definitions/NotificationChannels\"}},\"required\":[\"name\",\"description\"]},\"TagDeploymentSuite\":{\"title\":\"TagDeploymentSuite\",\"type\":\"object\",\"properties\":{\"collection\":{\"$ref\":\"#/definitions/SimpleCollection\"},\"deployments\":{\"title\":\"Deployments\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/TagDeployment\"}}}},\"ColumnMetricDeployment\":{\"title\":\"ColumnMetricDeployment\",\"type\":\"object\",\"properties\":{\"column_name\":{\"title\":\"Column Name\",\"type\":\"string\"},\"metrics\":{\"title\":\"Metrics\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/SimpleMetricDefinition\"}}},\"required\":[\"column_name\",\"metrics\"]},\"TableDeployment\":{\"title\":\"TableDeployment\",\"type\":\"object\",\"properties\":{\"fq_table_name\":{\"title\":\"Fq Table Name\",\"type\":\"string\"},\"columns\":{\"title\":\"Columns\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ColumnMetricDeployment\"}},\"table_metrics\":{\"title\":\"Table Metrics\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/SimpleMetricDefinition\"}},\"row_creation_time\":{\"title\":\"Row Creation Time\",\"type\":\"string\"}},\"required\":[\"fq_table_name\"]},\"TableDeploymentSuite\":{\"title\":\"TableDeploymentSuite\",\"type\":\"object\",\"properties\":{\"collection\":{\"$ref\":\"#/definitions/SimpleMetricDefinition\"},\"deployments\":{\"title\":\"Deployments\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/TableDeployment\"}}},\"required\":[\"deployments\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Bigconfig\". Here are the required top‑level fields: type. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/metaschema-draft-07-unofficial-strict.json","additionalProperties":true,"properties":{"type":{"title":"Type","type":"string","default":"BIGCONFIG_FILE","anyOf":[{"const":"BIGCONFIG_FILE"}]},"auto_apply_on_indexing":{"title":"Auto Apply On Indexing","default":true,"type":"boolean"},"tag_definitions":{"title":"Tag Definitions","type":"array","items":{"$ref":"#/definitions/TagDefinition"}},"row_creation_times":{"title":"Row Creation Times","default":{"tag_ids":[],"column_selectors":[]},"allOf":[{"$ref":"#/definitions/RowCreationTimes"}]},"saved_metric_definitions":{"$ref":"#/definitions/SavedMetricDefinitions"},"tag_deployments":{"title":"Tag Deployments","type":"array","items":{"$ref":"#/definitions/TagDeploymentSuite"}},"table_deployments":{"title":"Table Deployments","type":"array","items":{"$ref":"#/definitions/TableDeploymentSuite"}}},"type":"object","title":"Bigconfig","description":"Bigconfig is a yaml-based declarative monitoring as code solution. Data engineers can deploy Bigeye metrics from the command-line for convenient and scalable data quality monitoring.","required":["type"],"definitions":{"SimpleFieldType":{"title":"SimpleFieldType","enum":["UNSPECIFIED","STRING","UUID","BINARY","NUMERIC","DATE_LIKE","TIMESTAMP_LIKE","ANY","BOOLEAN","UNKNOWN","ARRAY","STRUCT"],"type":"string"},"ColumnSelector":{"title":"ColumnSelector","type":"object","default":{"name":"*.*.*.*"},"properties":{"name":{"title":"Name","type":"string","default":"*.*.*.*"},"type":{"$ref":"#/definitions/SimpleFieldType"},"exclude":{"title":"Exclude","type":"string"},"regex":{"title":"Regex","type":"string"}}},"TagDefinition":{"title":"TagDefinition","type":"object","default":{"tag_id":"TAG_ID"},"properties":{"tag_id":{"title":"Tag Id","type":"string"},"column_selectors":{"title":"Column Selectors","type":"array","default":[{"name":"*.*.*.*"}],"items":{"$ref":"#/definitions/ColumnSelector"}}},"required":["tag_id","column_selectors"]},"RowCreationTimes":{"title":"RowCreationTimes","type":"object","properties":{"tag_ids":{"title":"Tag Ids","type":"array","items":{"type":"string"}},"column_selectors":{"title":"Column Selectors","type":"array","items":{"$ref":"#/definitions/ColumnSelector"}}}},"NotificationChannels":{"title":"Notification Channels","type":"object","properties":{"slack":{"type":"string"},"email":{"type":"string"},"webhook":{"type":"string"},"webhook_header_key":{"type":"string"},"webhook_header_value":{"type":"string"}}},"MetricParameters":{"title":"Metric Parameters","type":"object","properties":{"key":{"type":"string"},"string_value":{"type":"string"},"column_name":{"type":"string"},"number_value":{"type":"number"}}},"SimpleMetricDefinition":{"title":"SimpleMetricDefinition","type":"object","properties":{"saved_metric_id":{"title":"Saved Metric id","type":"string"},"metric_type":{"title":"Metric Type","type":"object","properties":{"predefined_metric":{"title":"Predefined Metric","enum":["PERCENT_NULL","COUNT_NULL","PERCENT_EMPTY_STRING","COUNT_EMPTY_STRING","PERCENT_UNIQUE","PERCENT_VALUE_IN_LIST","AVERAGE","MIN","MAX","SUM","COUNT_ROWS","COUNT_DISTINCT","HOURS_SINCE_MAX_DATE","HOURS_SINCE_MAX_TIMESTAMP","COUNT_TRUE","PERCENT_TRUE","COUNT_FALSE","PERCENT_FALSE","COUNT_USA_PHONE","PERCENT_USA_PHONE","COUNT_USA_ZIP_CODE","PERCENT_USA_ZIP_CODE","PERCENT_UUID","COUNT_TIMESTAMP_STRING","PERCENT_TIMESTAMP_STRING","COUNT_DUPLICATES","COUNT_USA_STATE_CODE","PERCENT_USA_STATE_CODE","VARIANCE","SKEW","KURTOSIS","GEOMETRIC_MEAN","HARMONIC_MEAN","COUNT_UUID","COUNT_CUSIP","PERCENT_CUSIP","COUNT_SEDOL","PERCENT_SEDOL","COUNT_ISIN","PERCENT_ISIN","COUNT_LEI","PERCENT_LEI","COUNT_FIGI","PERCENT_FIGI","COUNT_PERM_ID","PERCENT_PERM_ID","COUNT_NAN","PERCENT_NAN","COUNT_LONGITUDE","PERCENT_LONGITUDE","COUNT_LATITUDE","PERCENT_LATITUDE","COUNT_NOT_IN_FUTURE","PERCENT_NOT_IN_FUTURE","COUNT_DATE_NOT_IN_FUTURE","PERCENT_DATE_NOT_IN_FUTURE","MEDIAN","PERCENTILE","COUNT_NOT_NULL","STRING_LENGTH_AVERAGE","STRING_LENGTH_MIN","STRING_LENGTH_MAX","COUNT_SSN","PERCENT_SSN","COUNT_EMAIL","PERCENT_EMAIL","ROWS_INSERTED","HOURS_SINCE_LAST_LOAD","COUNT_READ_QUERIES","PERCENT_NOT_NULL","FRESHNESS","VOLUME"]},"type":{"type":"string","enum":["PREDEFINED","TEMPLATE"]},"template_id":{"type":"number"},"aggregation_type":{"type":"string","enum":["COUNT","PERCENT"]}},"required":["predefined_metric"]},"metric_name":{"type":"string"},"description":{"type":"string"},"schedule_frequency":{"type":"object","default":{"interval_type":"HOURS","interval_value":24},"properties":{"interval_type":{"enum":["HOURS","MINUTES"],"default":"HOURS"},"interval_value":{"type":"number","default":24}},"required":["interval_type","interval_value"]},"conditions":{"type":"array","items":{"type":"string"}},"group_by":{"type":"array","items":{"type":"string"}},"threshold":{"type":"object","properties":{"type":{"enum":["AUTO","RELATIVE","STDDEV","CONSTANT"]},"sensitivity":{"description":"Only valid for autothreshold metrics","enum":["NARROW","MEDIUM","WIDE","XWIDE"]},"upper_bound":{"description":"Only valid for constant, relative, and standard deviation metrics","type":"number"},"lower_bound":{"description":"Only valid for constant, relative, and standard deviation metrics","type":"number"},"upper_bound_only":{"description":"Only valid for autothreshold metrics","type":"boolean"},"lower_bound_only":{"description":"Only valid for autothreshold metrics","type":"boolean"},"reference_point":{"type":"object","description":"Only valid for relative and standard deviation metrics","properties":{"interval_type":{"enum":["DAYS"]},"interval_value":{"type":"number"}},"required":["interval_type","interval_value"]}},"required":["type"]},"notification_channels":{"type":"array","items":{"$ref":"#/definitions/NotificationChannels"}},"parameters":{"type":"array","items":{"$ref":"#/definitions/MetricParameters"}},"lookback":{"type":"object","properties":{"lookback_type":{"enum":["DATA_TIME","METRIC_TIME","CLOCK_TIME"]},"lookback_window":{"type":"object","properties":{"interval_type":{"enum":["DAYS"]},"interval_value":{"type":"number"}},"required":["interval_type","interval_value"]},"bucket_size":{"description":"Only valid for data time window metrics","enum":["DAY","HOUR"]}},"required":["lookback_type","lookback_window"]},"metric_schedule":{"type":"object","properties":{"named_schedule":{"type":"object","properties":{"name":{"type":"string"},"cron":{"type":"string"},"id":{"type":"number"}},"required":["name"]}},"required":["named_schedule"]}}},"SavedMetricDefinitions":{"title":"SavedMetricDefinitions","type":"object","properties":{"metrics":{"title":"Metrics","type":"array","items":{"$ref":"#/definitions/SimpleMetricDefinition"}}},"required":["metrics"]},"TagDeployment":{"title":"TagDeployment","type":"object","properties":{"column_selectors":{"title":"Column Selectors","type":"array","items":{"$ref":"#/definitions/ColumnSelector"}},"metrics":{"title":"Metrics","type":"array","items":{"$ref":"#/definitions/SimpleMetricDefinition"}},"tag_id":{"title":"Tag Id","type":"string"}},"required":["metrics"]},"SimpleCollection":{"title":"SimpleCollection","type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"notification_channels":{"$ref":"#/definitions/NotificationChannels"}},"required":["name","description"]},"TagDeploymentSuite":{"title":"TagDeploymentSuite","type":"object","properties":{"collection":{"$ref":"#/definitions/SimpleCollection"},"deployments":{"title":"Deployments","type":"array","items":{"$ref":"#/definitions/TagDeployment"}}}},"ColumnMetricDeployment":{"title":"ColumnMetricDeployment","type":"object","properties":{"column_name":{"title":"Column Name","type":"string"},"metrics":{"title":"Metrics","type":"array","items":{"$ref":"#/definitions/SimpleMetricDefinition"}}},"required":["column_name","metrics"]},"TableDeployment":{"title":"TableDeployment","type":"object","properties":{"fq_table_name":{"title":"Fq Table Name","type":"string"},"columns":{"title":"Columns","type":"array","items":{"$ref":"#/definitions/ColumnMetricDeployment"}},"table_metrics":{"title":"Table Metrics","type":"array","items":{"$ref":"#/definitions/SimpleMetricDefinition"}},"row_creation_time":{"title":"Row Creation Time","type":"string"}},"required":["fq_table_name"]},"TableDeploymentSuite":{"title":"TableDeploymentSuite","type":"object","properties":{"collection":{"$ref":"#/definitions/SimpleMetricDefinition"},"deployments":{"title":"Deployments","type":"array","items":{"$ref":"#/definitions/TableDeployment"}}},"required":["deployments"]}}}
|
Provide a JSON object that satisfies the schema "Bigconfig". Here are the required top‑level fields: type. Return only the valid JSON object.
|
Bigconfig
|
schema-store
|
schema_store_88
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/bigquery-table\",\"definitions\":{\"field_name\":{\"type\":\"string\"},\"field_type\":{\"type\":\"string\",\"enum\":[\"INT64\",\"INTEGER\",\"FLOAT64\",\"FLOAT\",\"NUMERIC\",\"BIGNUMERIC\",\"BOOL\",\"BOOLEAN\",\"STRING\",\"BYTES\",\"DATE\",\"DATETIME\",\"TIME\",\"TIMESTAMP\",\"STRUCT\",\"RECORD\",\"JSON\",\"GEOGRAPHY\"]},\"field_mode\":{\"type\":\"string\",\"enum\":[\"NULLABLE\",\"REQUIRED\",\"REPEATED\"]},\"field_description\":{\"type\":\"string\"},\"field\":{\"type\":\"object\",\"required\":[\"name\",\"type\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/field_name\"},\"type\":{\"$ref\":\"#/definitions/field_type\"},\"mode\":{\"$ref\":\"#/definitions/field_mode\"},\"description\":{\"$ref\":\"#/definitions/field_description\"}},\"if\":{\"properties\":{\"type\":{\"enum\":[\"STRUCT\",\"RECORD\"]}}},\"then\":{\"required\":[\"fields\",\"type\",\"name\"],\"properties\":{\"name\":{\"$ref\":\"#/definitions/field_name\"},\"type\":{\"$ref\":\"#/definitions/field_type\"},\"mode\":{\"$ref\":\"#/definitions/field_mode\"},\"description\":{\"$ref\":\"#/definitions/field_description\"},\"fields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/field\"}}}}}},\"description\":\"BigQuery lets you specify a table's schema when you load data into a table or when you create an empty table. A table schema is a JSON file.\",\"items\":{\"$ref\":\"#/definitions/field\"},\"type\":\"array\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"bigquery-table\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/bigquery-table","definitions":{"field_name":{"type":"string"},"field_type":{"type":"string","enum":["INT64","INTEGER","FLOAT64","FLOAT","NUMERIC","BIGNUMERIC","BOOL","BOOLEAN","STRING","BYTES","DATE","DATETIME","TIME","TIMESTAMP","STRUCT","RECORD","JSON","GEOGRAPHY"]},"field_mode":{"type":"string","enum":["NULLABLE","REQUIRED","REPEATED"]},"field_description":{"type":"string"},"field":{"type":"object","required":["name","type"],"properties":{"name":{"$ref":"#/definitions/field_name"},"type":{"$ref":"#/definitions/field_type"},"mode":{"$ref":"#/definitions/field_mode"},"description":{"$ref":"#/definitions/field_description"}},"if":{"properties":{"type":{"enum":["STRUCT","RECORD"]}}},"then":{"required":["fields","type","name"],"properties":{"name":{"$ref":"#/definitions/field_name"},"type":{"$ref":"#/definitions/field_type"},"mode":{"$ref":"#/definitions/field_mode"},"description":{"$ref":"#/definitions/field_description"},"fields":{"type":"array","items":{"$ref":"#/definitions/field"}}}}}},"description":"BigQuery lets you specify a table's schema when you load data into a table or when you create an empty table. A table schema is a JSON file.","items":{"$ref":"#/definitions/field"},"type":"array"}
|
Provide a JSON object that satisfies the schema "bigquery-table". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
bigquery-table
|
schema-store
|
schema_store_89
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$defs\":{\"ArchitectureFromFileDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"Architecture source file\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"callable\":{\"description\":\"Identifier of the callable that returns a torch.nn.Module instance.\",\"examples\":[\"MyNetworkClass\",\"get_my_model\"],\"minLength\":1,\"title\":\"Identifier\",\"type\":\"string\"},\"kwargs\":{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"description\":\"key word arguments for the `callable`\",\"title\":\"Kwargs\",\"type\":\"object\"}},\"required\":[\"source\",\"callable\"],\"title\":\"model.v0_5.ArchitectureFromFileDescr\",\"type\":\"object\"},\"ArchitectureFromLibraryDescr\":{\"additionalProperties\":false,\"properties\":{\"callable\":{\"description\":\"Identifier of the callable that returns a torch.nn.Module instance.\",\"examples\":[\"MyNetworkClass\",\"get_my_model\"],\"minLength\":1,\"title\":\"Identifier\",\"type\":\"string\"},\"kwargs\":{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"description\":\"key word arguments for the `callable`\",\"title\":\"Kwargs\",\"type\":\"object\"},\"import_from\":{\"description\":\"Where to import the callable from, i.e. `from <import_from> import <callable>`\",\"title\":\"Import From\",\"type\":\"string\"}},\"required\":[\"callable\",\"import_from\"],\"title\":\"model.v0_5.ArchitectureFromLibraryDescr\",\"type\":\"object\"},\"AttachmentsDescr\":{\"additionalProperties\":true,\"properties\":{\"files\":{\"description\":\"File attachments\",\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Files\",\"type\":\"array\"}},\"title\":\"generic.v0_2.AttachmentsDescr\",\"type\":\"object\"},\"BadgeDescr\":{\"additionalProperties\":false,\"description\":\"A custom badge\",\"properties\":{\"label\":{\"description\":\"badge label to display on hover\",\"examples\":[\"Open in Colab\"],\"title\":\"Label\",\"type\":\"string\"},\"icon\":{\"anyOf\":[{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"badge icon (included in bioimage.io package if not a URL)\",\"examples\":[\"https://colab.research.google.com/assets/colab-badge.svg\"],\"title\":\"Icon\"},\"url\":{\"description\":\"target URL\",\"examples\":[\"https://colab.research.google.com/github/HenriquesLab/ZeroCostDL4Mic/blob/master/Colab_notebooks/U-net_2D_ZeroCostDL4Mic.ipynb\"],\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"}},\"required\":[\"label\",\"url\"],\"title\":\"generic.v0_2.BadgeDescr\",\"type\":\"object\"},\"BatchAxis\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"default\":\"batch\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"batch\",\"title\":\"Type\",\"type\":\"string\"},\"size\":{\"anyOf\":[{\"const\":1,\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The batch size may be fixed to 1,\\notherwise (the default) it may be chosen arbitrarily depending on available memory\",\"title\":\"Size\"}},\"required\":[\"type\"],\"title\":\"model.v0_5.BatchAxis\",\"type\":\"object\"},\"BinarizeAlongAxisKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `BinarizeDescr`\",\"properties\":{\"threshold\":{\"description\":\"The fixed threshold values along `axis`\",\"items\":{\"type\":\"number\"},\"minItems\":1,\"title\":\"Threshold\",\"type\":\"array\"},\"axis\":{\"description\":\"The `threshold` axis\",\"examples\":[\"channel\"],\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"}},\"required\":[\"threshold\",\"axis\"],\"title\":\"model.v0_5.BinarizeAlongAxisKwargs\",\"type\":\"object\"},\"ChannelAxis\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"default\":\"channel\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"channel\",\"title\":\"Type\",\"type\":\"string\"},\"channel_names\":{\"items\":{\"minLength\":1,\"title\":\"Identifier\",\"type\":\"string\"},\"minItems\":1,\"title\":\"Channel Names\",\"type\":\"array\"}},\"required\":[\"type\",\"channel_names\"],\"title\":\"model.v0_5.ChannelAxis\",\"type\":\"object\"},\"ClipKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ClipDescr`\",\"properties\":{\"min\":{\"description\":\"minimum value for clipping\",\"title\":\"Min\",\"type\":\"number\"},\"max\":{\"description\":\"maximum value for clipping\",\"title\":\"Max\",\"type\":\"number\"}},\"required\":[\"min\",\"max\"],\"title\":\"model.v0_4.ClipKwargs\",\"type\":\"object\"},\"DataDependentSize\":{\"additionalProperties\":false,\"properties\":{\"min\":{\"default\":1,\"exclusiveMinimum\":0,\"title\":\"Min\",\"type\":\"integer\"},\"max\":{\"anyOf\":[{\"exclusiveMinimum\":1,\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Max\"}},\"title\":\"model.v0_5.DataDependentSize\",\"type\":\"object\"},\"Datetime\":{\"description\":\"Timestamp in [ISO 8601](#https://en.wikipedia.org/wiki/ISO_8601) format\\nwith a few restrictions listed [here](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat).\",\"format\":\"date-time\",\"title\":\"Datetime\",\"type\":\"string\"},\"EnsureDtypeDescr\":{\"additionalProperties\":false,\"description\":\"Cast the tensor data type to `EnsureDtypeKwargs.dtype` (if not matching).\\n\\nThis can for example be used to ensure the inner neural network model gets a\\ndifferent input tensor data type than the fully described bioimage.io model does.\\n\\nExamples:\\n The described bioimage.io model (incl. preprocessing) accepts any\\n float32-compatible tensor, normalizes it with percentiles and clipping and then\\n casts it to uint8, which is what the neural network in this example expects.\\n - in YAML\\n ```yaml\\n inputs:\\n - data:\\n type: float32 # described bioimage.io model is compatible with any float32 input tensor\\n preprocessing:\\n - id: scale_range\\n kwargs:\\n axes: ['y', 'x']\\n max_percentile: 99.8\\n min_percentile: 5.0\\n - id: clip\\n kwargs:\\n min: 0.0\\n max: 1.0\\n - id: ensure_dtype # the neural network of the model requires uint8\\n kwargs:\\n dtype: uint8\\n ```\\n - in Python:\\n >>> preprocessing = [\\n ... ScaleRangeDescr(\\n ... kwargs=ScaleRangeKwargs(\\n ... axes= (AxisId('y'), AxisId('x')),\\n ... max_percentile= 99.8,\\n ... min_percentile= 5.0,\\n ... )\\n ... ),\\n ... ClipDescr(kwargs=ClipKwargs(min=0.0, max=1.0)),\\n ... EnsureDtypeDescr(kwargs=EnsureDtypeKwargs(dtype=\\\"uint8\\\")),\\n ... ]\",\"properties\":{\"id\":{\"const\":\"ensure_dtype\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/EnsureDtypeKwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.EnsureDtypeDescr\",\"type\":\"object\"},\"EnsureDtypeKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `EnsureDtypeDescr`\",\"properties\":{\"dtype\":{\"enum\":[\"float32\",\"float64\",\"uint8\",\"int8\",\"uint16\",\"int16\",\"uint32\",\"int32\",\"uint64\",\"int64\",\"bool\"],\"title\":\"Dtype\",\"type\":\"string\"}},\"required\":[\"dtype\"],\"title\":\"model.v0_5.EnsureDtypeKwargs\",\"type\":\"object\"},\"FileDescr\":{\"additionalProperties\":false,\"description\":\"A file description\",\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"File source\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"}},\"required\":[\"source\"],\"title\":\"_internal.io.FileDescr\",\"type\":\"object\"},\"FixedZeroMeanUnitVarianceAlongAxisKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `FixedZeroMeanUnitVarianceDescr`\",\"properties\":{\"mean\":{\"description\":\"The mean value(s) to normalize with.\",\"items\":{\"type\":\"number\"},\"minItems\":1,\"title\":\"Mean\",\"type\":\"array\"},\"std\":{\"description\":\"The standard deviation value(s) to normalize with.\\nSize must match `mean` values.\",\"items\":{\"minimum\":1e-06,\"type\":\"number\"},\"minItems\":1,\"title\":\"Std\",\"type\":\"array\"},\"axis\":{\"description\":\"The axis of the mean/std values to normalize each entry along that dimension\\nseparately.\",\"examples\":[\"channel\",\"index\"],\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"}},\"required\":[\"mean\",\"std\",\"axis\"],\"title\":\"model.v0_5.FixedZeroMeanUnitVarianceAlongAxisKwargs\",\"type\":\"object\"},\"FixedZeroMeanUnitVarianceDescr\":{\"additionalProperties\":false,\"description\":\"Subtract a given mean and divide by the standard deviation.\\n\\nNormalize with fixed, precomputed values for\\n`FixedZeroMeanUnitVarianceKwargs.mean` and `FixedZeroMeanUnitVarianceKwargs.std`\\nUse `FixedZeroMeanUnitVarianceAlongAxisKwargs` for independent scaling along given\\naxes.\\n\\nExamples:\\n1. scalar value for whole tensor\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: fixed_zero_mean_unit_variance\\n kwargs:\\n mean: 103.5\\n std: 13.7\\n ```\\n - in Python\\n >>> preprocessing = [FixedZeroMeanUnitVarianceDescr(\\n ... kwargs=FixedZeroMeanUnitVarianceKwargs(mean=103.5, std=13.7)\\n ... )]\\n\\n2. independently along an axis\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: fixed_zero_mean_unit_variance\\n kwargs:\\n axis: channel\\n mean: [101.5, 102.5, 103.5]\\n std: [11.7, 12.7, 13.7]\\n ```\\n - in Python\\n >>> preprocessing = [FixedZeroMeanUnitVarianceDescr(\\n ... kwargs=FixedZeroMeanUnitVarianceAlongAxisKwargs(\\n ... axis=AxisId(\\\"channel\\\"),\\n ... mean=[101.5, 102.5, 103.5],\\n ... std=[11.7, 12.7, 13.7],\\n ... )\\n ... )]\",\"properties\":{\"id\":{\"const\":\"fixed_zero_mean_unit_variance\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"anyOf\":[{\"$ref\":\"#/$defs/FixedZeroMeanUnitVarianceKwargs\"},{\"$ref\":\"#/$defs/FixedZeroMeanUnitVarianceAlongAxisKwargs\"}],\"title\":\"Kwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.FixedZeroMeanUnitVarianceDescr\",\"type\":\"object\"},\"FixedZeroMeanUnitVarianceKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `FixedZeroMeanUnitVarianceDescr`\",\"properties\":{\"mean\":{\"description\":\"The mean value to normalize with.\",\"title\":\"Mean\",\"type\":\"number\"},\"std\":{\"description\":\"The standard deviation value to normalize with.\",\"minimum\":1e-06,\"title\":\"Std\",\"type\":\"number\"}},\"required\":[\"mean\",\"std\"],\"title\":\"model.v0_5.FixedZeroMeanUnitVarianceKwargs\",\"type\":\"object\"},\"ImplicitOutputShape\":{\"additionalProperties\":false,\"description\":\"Output tensor shape depending on an input tensor shape.\\n`shape(output_tensor) = shape(input_tensor) * scale + 2 * offset`\",\"properties\":{\"reference_tensor\":{\"description\":\"Name of the reference tensor.\",\"minLength\":1,\"title\":\"TensorName\",\"type\":\"string\"},\"scale\":{\"description\":\"output_pix/input_pix for each dimension.\\n'null' values indicate new dimensions, whose length is defined by 2*`offset`\",\"items\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}]},\"minItems\":1,\"title\":\"Scale\",\"type\":\"array\"},\"offset\":{\"description\":\"Position of origin wrt to input.\",\"items\":{\"anyOf\":[{\"type\":\"integer\"},{\"multipleOf\":0.5,\"type\":\"number\"}]},\"minItems\":1,\"title\":\"Offset\",\"type\":\"array\"}},\"required\":[\"reference_tensor\",\"scale\",\"offset\"],\"title\":\"model.v0_4.ImplicitOutputShape\",\"type\":\"object\"},\"IndexInputAxis\":{\"additionalProperties\":false,\"properties\":{\"size\":{\"anyOf\":[{\"exclusiveMinimum\":0,\"type\":\"integer\"},{\"$ref\":\"#/$defs/ParameterizedSize\"},{\"$ref\":\"#/$defs/SizeReference\"}],\"description\":\"The size/length of this axis can be specified as\\n- fixed integer\\n- parameterized series of valid sizes (`ParameterizedSize`)\\n- reference to another axis with an optional offset (`SizeReference`)\",\"examples\":[10,{\"min\":32,\"step\":16},{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}],\"title\":\"Size\"},\"id\":{\"default\":\"index\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"index\",\"title\":\"Type\",\"type\":\"string\"},\"concatenable\":{\"default\":false,\"description\":\"If a model has a `concatenable` input axis, it can be processed blockwise,\\nsplitting a longer sample axis into blocks matching its input tensor description.\\nOutput axes are concatenable if they have a `SizeReference` to a concatenable\\ninput axis.\",\"title\":\"Concatenable\",\"type\":\"boolean\"}},\"required\":[\"size\",\"type\"],\"title\":\"model.v0_5.IndexInputAxis\",\"type\":\"object\"},\"IndexOutputAxis\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"default\":\"index\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"index\",\"title\":\"Type\",\"type\":\"string\"},\"size\":{\"anyOf\":[{\"exclusiveMinimum\":0,\"type\":\"integer\"},{\"$ref\":\"#/$defs/SizeReference\"},{\"$ref\":\"#/$defs/DataDependentSize\"}],\"description\":\"The size/length of this axis can be specified as\\n- fixed integer\\n- reference to another axis with an optional offset (`SizeReference`)\\n- data dependent size using `DataDependentSize` (size is only known after model inference)\",\"examples\":[10,{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}],\"title\":\"Size\"}},\"required\":[\"type\",\"size\"],\"title\":\"model.v0_5.IndexOutputAxis\",\"type\":\"object\"},\"IntervalOrRatioDataDescr\":{\"additionalProperties\":false,\"properties\":{\"type\":{\"default\":\"float32\",\"enum\":[\"float32\",\"float64\",\"uint8\",\"int8\",\"uint16\",\"int16\",\"uint32\",\"int32\",\"uint64\",\"int64\"],\"examples\":[\"float32\",\"float64\",\"uint8\",\"uint16\"],\"title\":\"Type\",\"type\":\"string\"},\"range\":{\"default\":[null,null],\"description\":\"Tuple `(minimum, maximum)` specifying the allowed range of the data in this tensor.\\n`None` corresponds to min/max of what can be expressed by **type**.\",\"maxItems\":2,\"minItems\":2,\"prefixItems\":[{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}]},{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}]}],\"title\":\"Range\",\"type\":\"array\"},\"unit\":{\"anyOf\":[{\"const\":\"arbitrary unit\",\"type\":\"string\"},{\"description\":\"An SI unit\",\"minLength\":1,\"pattern\":\"^(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\\\^[+-]?[1-9]\\\\d*)?((\\u00b7(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\\\^[+-]?[1-9]\\\\d*)?)|(/(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\\\^+?[1-9]\\\\d*)?))*$\",\"title\":\"SiUnit\",\"type\":\"string\"}],\"default\":\"arbitrary unit\",\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"description\":\"Scale for data on an interval (or ratio) scale.\",\"title\":\"Scale\",\"type\":\"number\"},\"offset\":{\"anyOf\":[{\"type\":\"number\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Offset for data on a ratio scale.\",\"title\":\"Offset\"}},\"title\":\"model.v0_5.IntervalOrRatioDataDescr\",\"type\":\"object\"},\"NominalOrOrdinalDataDescr\":{\"additionalProperties\":false,\"properties\":{\"values\":{\"anyOf\":[{\"items\":{\"type\":\"integer\"},\"minItems\":1,\"type\":\"array\"},{\"items\":{\"type\":\"number\"},\"minItems\":1,\"type\":\"array\"},{\"items\":{\"type\":\"boolean\"},\"minItems\":1,\"type\":\"array\"},{\"items\":{\"type\":\"string\"},\"minItems\":1,\"type\":\"array\"}],\"description\":\"A fixed set of nominal or an ascending sequence of ordinal values.\\nIn this case `data.type` is required to be an unsigend integer type, e.g. 'uint8'.\\nString `values` are interpreted as labels for tensor values 0, ..., N.\\nNote: as YAML 1.2 does not natively support a \\\"set\\\" datatype,\\nnominal values should be given as a sequence (aka list/array) as well.\",\"title\":\"Values\"},\"type\":{\"default\":\"uint8\",\"enum\":[\"float32\",\"float64\",\"uint8\",\"int8\",\"uint16\",\"int16\",\"uint32\",\"int32\",\"uint64\",\"int64\",\"bool\"],\"examples\":[\"float32\",\"uint8\",\"uint16\",\"int64\",\"bool\"],\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"const\":\"arbitrary unit\",\"type\":\"string\"},{\"description\":\"An SI unit\",\"minLength\":1,\"pattern\":\"^(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\\\^[+-]?[1-9]\\\\d*)?((\\u00b7(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\\\^[+-]?[1-9]\\\\d*)?)|(/(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\\\^+?[1-9]\\\\d*)?))*$\",\"title\":\"SiUnit\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"}},\"required\":[\"values\"],\"title\":\"model.v0_5.NominalOrOrdinalDataDescr\",\"type\":\"object\"},\"ParameterizedInputShape\":{\"additionalProperties\":false,\"description\":\"A sequence of valid shapes given by `shape_k = min + k * step for k in {0, 1, ...}`.\",\"properties\":{\"min\":{\"description\":\"The minimum input shape\",\"items\":{\"type\":\"integer\"},\"minItems\":1,\"title\":\"Min\",\"type\":\"array\"},\"step\":{\"description\":\"The minimum shape change\",\"items\":{\"type\":\"integer\"},\"minItems\":1,\"title\":\"Step\",\"type\":\"array\"}},\"required\":[\"min\",\"step\"],\"title\":\"model.v0_4.ParameterizedInputShape\",\"type\":\"object\"},\"ParameterizedSize\":{\"additionalProperties\":false,\"description\":\"Describes a range of valid tensor axis sizes as `size = min + n*step`.\\n\\n- **min** and **step** are given by the model description.\\n- All blocksize paramters n = 0,1,2,... yield a valid `size`.\\n- A greater blocksize paramter n = 0,1,2,... results in a greater **size**.\\n This allows to adjust the axis size more generically.\",\"properties\":{\"min\":{\"exclusiveMinimum\":0,\"title\":\"Min\",\"type\":\"integer\"},\"step\":{\"exclusiveMinimum\":0,\"title\":\"Step\",\"type\":\"integer\"}},\"required\":[\"min\",\"step\"],\"title\":\"model.v0_5.ParameterizedSize\",\"type\":\"object\"},\"RelativeFilePath\":{\"description\":\"A path relative to the `rdf.yaml` file (also if the RDF source is a URL).\",\"format\":\"path\",\"title\":\"RelativeFilePath\",\"type\":\"string\"},\"ReproducibilityTolerance\":{\"additionalProperties\":true,\"description\":\"Describes what small numerical differences -- if any -- may be tolerated\\nin the generated output when executing in different environments.\\n\\nA tensor element *output* is considered mismatched to the **test_tensor** if\\nabs(*output* - **test_tensor**) > **absolute_tolerance** + **relative_tolerance** * abs(**test_tensor**).\\n(Internally we call [numpy.testing.assert_allclose](https://numpy.org/doc/stable/reference/generated/numpy.testing.assert_allclose.html).)\\n\\nMotivation:\\n For testing we can request the respective deep learning frameworks to be as\\n reproducible as possible by setting seeds and chosing deterministic algorithms,\\n but differences in operating systems, available hardware and installed drivers\\n may still lead to numerical differences.\",\"properties\":{\"relative_tolerance\":{\"default\":0.001,\"description\":\"Maximum relative tolerance of reproduced test tensor.\",\"maximum\":0.01,\"minimum\":0,\"title\":\"Relative Tolerance\",\"type\":\"number\"},\"absolute_tolerance\":{\"default\":0.0001,\"description\":\"Maximum absolute tolerance of reproduced test tensor.\",\"minimum\":0,\"title\":\"Absolute Tolerance\",\"type\":\"number\"},\"mismatched_elements_per_million\":{\"default\":100,\"description\":\"Maximum number of mismatched elements/pixels per million to tolerate.\",\"maximum\":1000,\"minimum\":0,\"title\":\"Mismatched Elements Per Million\",\"type\":\"integer\"},\"output_ids\":{\"default\":[],\"description\":\"Limits the output tensor IDs these reproducibility details apply to.\",\"items\":{\"maxLength\":32,\"minLength\":1,\"title\":\"TensorId\",\"type\":\"string\"},\"title\":\"Output Ids\",\"type\":\"array\"},\"weights_formats\":{\"default\":[],\"description\":\"Limits the weights formats these details apply to.\",\"items\":{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},\"title\":\"Weights Formats\",\"type\":\"array\"}},\"title\":\"model.v0_5.ReproducibilityTolerance\",\"type\":\"object\"},\"RunMode\":{\"additionalProperties\":false,\"properties\":{\"name\":{\"anyOf\":[{\"const\":\"deepimagej\",\"type\":\"string\"},{\"type\":\"string\"}],\"description\":\"Run mode name\",\"title\":\"Name\"},\"kwargs\":{\"additionalProperties\":true,\"description\":\"Run mode specific key word arguments\",\"title\":\"Kwargs\",\"type\":\"object\"}},\"required\":[\"name\"],\"title\":\"model.v0_4.RunMode\",\"type\":\"object\"},\"ScaleLinearAlongAxisKwargs\":{\"additionalProperties\":false,\"description\":\"Key word arguments for `ScaleLinearDescr`\",\"properties\":{\"axis\":{\"description\":\"The axis of gain and offset values.\",\"examples\":[\"channel\"],\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"gain\":{\"anyOf\":[{\"type\":\"number\"},{\"items\":{\"type\":\"number\"},\"minItems\":1,\"type\":\"array\"}],\"default\":1.0,\"description\":\"multiplicative factor\",\"title\":\"Gain\"},\"offset\":{\"anyOf\":[{\"type\":\"number\"},{\"items\":{\"type\":\"number\"},\"minItems\":1,\"type\":\"array\"}],\"default\":0.0,\"description\":\"additive term\",\"title\":\"Offset\"}},\"required\":[\"axis\"],\"title\":\"model.v0_5.ScaleLinearAlongAxisKwargs\",\"type\":\"object\"},\"SizeReference\":{\"additionalProperties\":false,\"description\":\"A tensor axis size (extent in pixels/frames) defined in relation to a reference axis.\\n\\n`axis.size = reference.size * reference.scale / axis.scale + offset`\\n\\nNote:\\n1. The axis and the referenced axis need to have the same unit (or no unit).\\n2. Batch axes may not be referenced.\\n3. Fractions are rounded down.\\n4. If the reference axis is `concatenable` the referencing axis is assumed to be\\n `concatenable` as well with the same block order.\\n\\nExample:\\nAn unisotropic input image of w*h=100*49 pixels depicts a phsical space of 200*196mm\\u00b2.\\nLet's assume that we want to express the image height h in relation to its width w\\ninstead of only accepting input images of exactly 100*49 pixels\\n(for example to express a range of valid image shapes by parametrizing w, see `ParameterizedSize`).\\n\\n>>> w = SpaceInputAxis(id=AxisId(\\\"w\\\"), size=100, unit=\\\"millimeter\\\", scale=2)\\n>>> h = SpaceInputAxis(\\n... id=AxisId(\\\"h\\\"),\\n... size=SizeReference(tensor_id=TensorId(\\\"input\\\"), axis_id=AxisId(\\\"w\\\"), offset=-1),\\n... unit=\\\"millimeter\\\",\\n... scale=4,\\n... )\\n>>> print(h.size.get_size(h, w))\\n49\\n\\n\\u21d2 h = w * w.scale / h.scale + offset = 100 * 2mm / 4mm - 1 = 49\",\"properties\":{\"tensor_id\":{\"description\":\"tensor id of the reference axis\",\"maxLength\":32,\"minLength\":1,\"title\":\"TensorId\",\"type\":\"string\"},\"axis_id\":{\"description\":\"axis id of the reference axis\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"offset\":{\"default\":0,\"title\":\"Offset\",\"type\":\"integer\"}},\"required\":[\"tensor_id\",\"axis_id\"],\"title\":\"model.v0_5.SizeReference\",\"type\":\"object\"},\"SpaceInputAxis\":{\"additionalProperties\":false,\"properties\":{\"size\":{\"anyOf\":[{\"exclusiveMinimum\":0,\"type\":\"integer\"},{\"$ref\":\"#/$defs/ParameterizedSize\"},{\"$ref\":\"#/$defs/SizeReference\"}],\"description\":\"The size/length of this axis can be specified as\\n- fixed integer\\n- parameterized series of valid sizes (`ParameterizedSize`)\\n- reference to another axis with an optional offset (`SizeReference`)\",\"examples\":[10,{\"min\":32,\"step\":16},{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}],\"title\":\"Size\"},\"id\":{\"default\":\"x\",\"examples\":[\"x\",\"y\",\"z\"],\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"space\",\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"enum\":[\"attometer\",\"angstrom\",\"centimeter\",\"decimeter\",\"exameter\",\"femtometer\",\"foot\",\"gigameter\",\"hectometer\",\"inch\",\"kilometer\",\"megameter\",\"meter\",\"micrometer\",\"mile\",\"millimeter\",\"nanometer\",\"parsec\",\"petameter\",\"picometer\",\"terameter\",\"yard\",\"yoctometer\",\"yottameter\",\"zeptometer\",\"zettameter\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"exclusiveMinimum\":0,\"title\":\"Scale\",\"type\":\"number\"},\"concatenable\":{\"default\":false,\"description\":\"If a model has a `concatenable` input axis, it can be processed blockwise,\\nsplitting a longer sample axis into blocks matching its input tensor description.\\nOutput axes are concatenable if they have a `SizeReference` to a concatenable\\ninput axis.\",\"title\":\"Concatenable\",\"type\":\"boolean\"}},\"required\":[\"size\",\"type\"],\"title\":\"model.v0_5.SpaceInputAxis\",\"type\":\"object\"},\"SpaceOutputAxis\":{\"additionalProperties\":false,\"properties\":{\"size\":{\"anyOf\":[{\"exclusiveMinimum\":0,\"type\":\"integer\"},{\"$ref\":\"#/$defs/SizeReference\"}],\"description\":\"The size/length of this axis can be specified as\\n- fixed integer\\n- reference to another axis with an optional offset (see `SizeReference`)\",\"examples\":[10,{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}],\"title\":\"Size\"},\"id\":{\"default\":\"x\",\"examples\":[\"x\",\"y\",\"z\"],\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"space\",\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"enum\":[\"attometer\",\"angstrom\",\"centimeter\",\"decimeter\",\"exameter\",\"femtometer\",\"foot\",\"gigameter\",\"hectometer\",\"inch\",\"kilometer\",\"megameter\",\"meter\",\"micrometer\",\"mile\",\"millimeter\",\"nanometer\",\"parsec\",\"petameter\",\"picometer\",\"terameter\",\"yard\",\"yoctometer\",\"yottameter\",\"zeptometer\",\"zettameter\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"exclusiveMinimum\":0,\"title\":\"Scale\",\"type\":\"number\"}},\"required\":[\"size\",\"type\"],\"title\":\"model.v0_5.SpaceOutputAxis\",\"type\":\"object\"},\"SpaceOutputAxisWithHalo\":{\"additionalProperties\":false,\"properties\":{\"halo\":{\"description\":\"The halo should be cropped from the output tensor to avoid boundary effects.\\nIt is to be cropped from both sides, i.e. `size_after_crop = size - 2 * halo`.\\nTo document a halo that is already cropped by the model use `size.offset` instead.\",\"minimum\":1,\"title\":\"Halo\",\"type\":\"integer\"},\"size\":{\"$ref\":\"#/$defs/SizeReference\",\"description\":\"reference to another axis with an optional offset (see `SizeReference`)\",\"examples\":[10,{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}]},\"id\":{\"default\":\"x\",\"examples\":[\"x\",\"y\",\"z\"],\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"space\",\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"enum\":[\"attometer\",\"angstrom\",\"centimeter\",\"decimeter\",\"exameter\",\"femtometer\",\"foot\",\"gigameter\",\"hectometer\",\"inch\",\"kilometer\",\"megameter\",\"meter\",\"micrometer\",\"mile\",\"millimeter\",\"nanometer\",\"parsec\",\"petameter\",\"picometer\",\"terameter\",\"yard\",\"yoctometer\",\"yottameter\",\"zeptometer\",\"zettameter\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"exclusiveMinimum\":0,\"title\":\"Scale\",\"type\":\"number\"}},\"required\":[\"halo\",\"size\",\"type\"],\"title\":\"model.v0_5.SpaceOutputAxisWithHalo\",\"type\":\"object\"},\"TimeInputAxis\":{\"additionalProperties\":false,\"properties\":{\"size\":{\"anyOf\":[{\"exclusiveMinimum\":0,\"type\":\"integer\"},{\"$ref\":\"#/$defs/ParameterizedSize\"},{\"$ref\":\"#/$defs/SizeReference\"}],\"description\":\"The size/length of this axis can be specified as\\n- fixed integer\\n- parameterized series of valid sizes (`ParameterizedSize`)\\n- reference to another axis with an optional offset (`SizeReference`)\",\"examples\":[10,{\"min\":32,\"step\":16},{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}],\"title\":\"Size\"},\"id\":{\"default\":\"time\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"time\",\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"enum\":[\"attosecond\",\"centisecond\",\"day\",\"decisecond\",\"exasecond\",\"femtosecond\",\"gigasecond\",\"hectosecond\",\"hour\",\"kilosecond\",\"megasecond\",\"microsecond\",\"millisecond\",\"minute\",\"nanosecond\",\"petasecond\",\"picosecond\",\"second\",\"terasecond\",\"yoctosecond\",\"yottasecond\",\"zeptosecond\",\"zettasecond\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"exclusiveMinimum\":0,\"title\":\"Scale\",\"type\":\"number\"},\"concatenable\":{\"default\":false,\"description\":\"If a model has a `concatenable` input axis, it can be processed blockwise,\\nsplitting a longer sample axis into blocks matching its input tensor description.\\nOutput axes are concatenable if they have a `SizeReference` to a concatenable\\ninput axis.\",\"title\":\"Concatenable\",\"type\":\"boolean\"}},\"required\":[\"size\",\"type\"],\"title\":\"model.v0_5.TimeInputAxis\",\"type\":\"object\"},\"TimeOutputAxis\":{\"additionalProperties\":false,\"properties\":{\"size\":{\"anyOf\":[{\"exclusiveMinimum\":0,\"type\":\"integer\"},{\"$ref\":\"#/$defs/SizeReference\"}],\"description\":\"The size/length of this axis can be specified as\\n- fixed integer\\n- reference to another axis with an optional offset (see `SizeReference`)\",\"examples\":[10,{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}],\"title\":\"Size\"},\"id\":{\"default\":\"time\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"time\",\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"enum\":[\"attosecond\",\"centisecond\",\"day\",\"decisecond\",\"exasecond\",\"femtosecond\",\"gigasecond\",\"hectosecond\",\"hour\",\"kilosecond\",\"megasecond\",\"microsecond\",\"millisecond\",\"minute\",\"nanosecond\",\"petasecond\",\"picosecond\",\"second\",\"terasecond\",\"yoctosecond\",\"yottasecond\",\"zeptosecond\",\"zettasecond\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"exclusiveMinimum\":0,\"title\":\"Scale\",\"type\":\"number\"}},\"required\":[\"size\",\"type\"],\"title\":\"model.v0_5.TimeOutputAxis\",\"type\":\"object\"},\"TimeOutputAxisWithHalo\":{\"additionalProperties\":false,\"properties\":{\"halo\":{\"description\":\"The halo should be cropped from the output tensor to avoid boundary effects.\\nIt is to be cropped from both sides, i.e. `size_after_crop = size - 2 * halo`.\\nTo document a halo that is already cropped by the model use `size.offset` instead.\",\"minimum\":1,\"title\":\"Halo\",\"type\":\"integer\"},\"size\":{\"$ref\":\"#/$defs/SizeReference\",\"description\":\"reference to another axis with an optional offset (see `SizeReference`)\",\"examples\":[10,{\"axis_id\":\"a\",\"offset\":5,\"tensor_id\":\"t\"}]},\"id\":{\"default\":\"time\",\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"type\":{\"const\":\"time\",\"title\":\"Type\",\"type\":\"string\"},\"unit\":{\"anyOf\":[{\"enum\":[\"attosecond\",\"centisecond\",\"day\",\"decisecond\",\"exasecond\",\"femtosecond\",\"gigasecond\",\"hectosecond\",\"hour\",\"kilosecond\",\"megasecond\",\"microsecond\",\"millisecond\",\"minute\",\"nanosecond\",\"petasecond\",\"picosecond\",\"second\",\"terasecond\",\"yoctosecond\",\"yottasecond\",\"zeptosecond\",\"zettasecond\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Unit\"},\"scale\":{\"default\":1.0,\"exclusiveMinimum\":0,\"title\":\"Scale\",\"type\":\"number\"}},\"required\":[\"halo\",\"size\",\"type\"],\"title\":\"model.v0_5.TimeOutputAxisWithHalo\",\"type\":\"object\"},\"Uploader\":{\"additionalProperties\":false,\"properties\":{\"email\":{\"description\":\"Email\",\"format\":\"email\",\"title\":\"Email\",\"type\":\"string\"},\"name\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"name\",\"title\":\"Name\"}},\"required\":[\"email\"],\"title\":\"generic.v0_2.Uploader\",\"type\":\"object\"},\"Version\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"number\"}],\"description\":\"wraps a packaging.version.Version instance for validation in pydantic models\",\"title\":\"Version\"},\"YamlValue\":{\"anyOf\":[{\"type\":\"boolean\"},{\"format\":\"date\",\"type\":\"string\"},{\"format\":\"date-time\",\"type\":\"string\"},{\"type\":\"integer\"},{\"type\":\"number\"},{\"type\":\"string\"},{\"items\":{\"$ref\":\"#/$defs/YamlValue\"},\"type\":\"array\"},{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"type\":\"object\"},{\"type\":\"null\"}]},\"bioimageio__spec__application__v0_2__ApplicationDescr\":{\"additionalProperties\":false,\"description\":\"Bioimage.io description of an application.\",\"properties\":{\"name\":{\"description\":\"A human-friendly name of the resource description\",\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":1,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of the RDF and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"file and other attachments\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry\"},\"title\":\"Cite\",\"type\":\"array\"},\"config\":{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a github repo URL in `config` since we already have the\\n`git_repo` field defined in the spec.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n bioimageio: # here is the domain name\\n my_custom_key: 3837283\\n another_key:\\n nested: value\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files)\",\"examples\":[{\"bioimageio\":{\"another_key\":{\"nested\":\"value\"},\"my_custom_key\":3837283},\"imagej\":{\"macro_dir\":\"path/to/macro/file\"}}],\"title\":\"Config\",\"type\":\"object\"},\"download_url\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL to download the resource from (deprecated)\",\"title\":\"Download Url\"},\"git_repo\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"rdf_source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\\nDo not set this field in a YAML file.\",\"title\":\"Rdf Source\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"version_number\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"version number (n-th published version, not the semantic version)\",\"title\":\"Version Number\"},\"format_version\":{\"const\":\"0.2.4\",\"description\":\"The format version of this resource specification\\n(not the `version` of the resource description)\\nWhen creating a new resource always use the latest micro/patch version described here.\\nThe `format_version` is important for any consumer software to understand how to parse the fields.\",\"title\":\"Format Version\",\"type\":\"string\"},\"badges\":{\"description\":\"badges associated with this resource\",\"items\":{\"$ref\":\"#/$defs/BadgeDescr\"},\"title\":\"Badges\",\"type\":\"array\"},\"documentation\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or relative path to a markdown file with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\",\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"],\"title\":\"Documentation\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\\n) to discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"type\":{\"const\":\"application\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"ApplicationId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or path to the source of the application\",\"title\":\"Source\"}},\"required\":[\"name\",\"description\",\"format_version\",\"type\"],\"title\":\"application 0.2.4\",\"type\":\"object\"},\"bioimageio__spec__application__v0_3__ApplicationDescr\":{\"additionalProperties\":false,\"description\":\"Bioimage.io description of an application.\",\"properties\":{\"name\":{\"description\":\"A human-friendly name of the resource description.\\nMay only contains letters, digits, underscore, minus, parentheses and spaces.\",\"maxLength\":128,\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"description\":\"A string containing a brief description.\",\"maxLength\":1024,\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of this resource description and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"minItems\":1,\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"description\":\"file attachments\",\"items\":{\"$ref\":\"#/$defs/FileDescr\"},\"title\":\"Attachments\",\"type\":\"array\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry\"},\"minItems\":1,\"title\":\"Cite\",\"type\":\"array\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"}],\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\\nto discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"git_repo\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration, e.g. on bioimage.io\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"format_version\":{\"const\":\"0.3.0\",\"description\":\"The **format** version of this resource specification\",\"title\":\"Format Version\",\"type\":\"string\"},\"documentation\":{\"anyOf\":[{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"]},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or relative path to a markdown file encoded in UTF-8 with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\",\"title\":\"Documentation\"},\"badges\":{\"description\":\"badges associated with this resource\",\"items\":{\"$ref\":\"#/$defs/BadgeDescr\"},\"title\":\"Badges\",\"type\":\"array\"},\"config\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Config\",\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a GitHub repo URL in `config` since there is a `git_repo` field.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n giraffe_neckometer: # here is the domain name\\n length: 3837283\\n address:\\n home: zoo\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource.\\n(Packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files.)\"},\"type\":{\"const\":\"application\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"ApplicationId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"parent\":{\"anyOf\":[{\"minLength\":1,\"title\":\"ApplicationId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The description from which this one is derived\",\"title\":\"Parent\"},\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or path to the source of the application\",\"title\":\"Source\"}},\"required\":[\"name\",\"description\",\"authors\",\"cite\",\"license\",\"format_version\",\"type\"],\"title\":\"application 0.3.0\",\"type\":\"object\"},\"bioimageio__spec__dataset__v0_2__DatasetDescr\":{\"additionalProperties\":false,\"description\":\"A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage\\nprocessing.\",\"properties\":{\"name\":{\"description\":\"A human-friendly name of the resource description\",\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":1,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of the RDF and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"file and other attachments\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry\"},\"title\":\"Cite\",\"type\":\"array\"},\"config\":{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a github repo URL in `config` since we already have the\\n`git_repo` field defined in the spec.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n bioimageio: # here is the domain name\\n my_custom_key: 3837283\\n another_key:\\n nested: value\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files)\",\"examples\":[{\"bioimageio\":{\"another_key\":{\"nested\":\"value\"},\"my_custom_key\":3837283},\"imagej\":{\"macro_dir\":\"path/to/macro/file\"}}],\"title\":\"Config\",\"type\":\"object\"},\"download_url\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL to download the resource from (deprecated)\",\"title\":\"Download Url\"},\"git_repo\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"rdf_source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\\nDo not set this field in a YAML file.\",\"title\":\"Rdf Source\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"version_number\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"version number (n-th published version, not the semantic version)\",\"title\":\"Version Number\"},\"format_version\":{\"const\":\"0.2.4\",\"description\":\"The format version of this resource specification\\n(not the `version` of the resource description)\\nWhen creating a new resource always use the latest micro/patch version described here.\\nThe `format_version` is important for any consumer software to understand how to parse the fields.\",\"title\":\"Format Version\",\"type\":\"string\"},\"badges\":{\"description\":\"badges associated with this resource\",\"items\":{\"$ref\":\"#/$defs/BadgeDescr\"},\"title\":\"Badges\",\"type\":\"array\"},\"documentation\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or relative path to a markdown file with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\",\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"],\"title\":\"Documentation\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\\n) to discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"type\":{\"const\":\"dataset\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"DatasetId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"\\\"URL to the source of the dataset.\",\"title\":\"Source\"}},\"required\":[\"name\",\"description\",\"format_version\",\"type\"],\"title\":\"dataset 0.2.4\",\"type\":\"object\"},\"bioimageio__spec__dataset__v0_2__LinkedDataset\":{\"additionalProperties\":false,\"description\":\"Reference to a bioimage.io dataset.\",\"properties\":{\"id\":{\"description\":\"A valid dataset `id` from the bioimage.io collection.\",\"minLength\":1,\"title\":\"DatasetId\",\"type\":\"string\"},\"version_number\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"version number (n-th published version, not the semantic version) of linked dataset\",\"title\":\"Version Number\"}},\"required\":[\"id\"],\"title\":\"dataset.v0_2.LinkedDataset\",\"type\":\"object\"},\"bioimageio__spec__dataset__v0_3__DatasetDescr\":{\"additionalProperties\":false,\"description\":\"A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage\\nprocessing.\",\"properties\":{\"name\":{\"description\":\"A human-friendly name of the resource description.\\nMay only contains letters, digits, underscore, minus, parentheses and spaces.\",\"maxLength\":128,\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"description\":\"A string containing a brief description.\",\"maxLength\":1024,\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of this resource description and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"minItems\":1,\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"description\":\"file attachments\",\"items\":{\"$ref\":\"#/$defs/FileDescr\"},\"title\":\"Attachments\",\"type\":\"array\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry\"},\"minItems\":1,\"title\":\"Cite\",\"type\":\"array\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"}],\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\\nto discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"git_repo\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration, e.g. on bioimage.io\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"format_version\":{\"const\":\"0.3.0\",\"description\":\"The **format** version of this resource specification\",\"title\":\"Format Version\",\"type\":\"string\"},\"documentation\":{\"anyOf\":[{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"]},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or relative path to a markdown file encoded in UTF-8 with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\",\"title\":\"Documentation\"},\"badges\":{\"description\":\"badges associated with this resource\",\"items\":{\"$ref\":\"#/$defs/BadgeDescr\"},\"title\":\"Badges\",\"type\":\"array\"},\"config\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Config\",\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a GitHub repo URL in `config` since there is a `git_repo` field.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n giraffe_neckometer: # here is the domain name\\n length: 3837283\\n address:\\n home: zoo\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource.\\n(Packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files.)\"},\"type\":{\"const\":\"dataset\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"DatasetId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"parent\":{\"anyOf\":[{\"minLength\":1,\"title\":\"DatasetId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The description from which this one is derived\",\"title\":\"Parent\"},\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"\\\"URL to the source of the dataset.\",\"title\":\"Source\"}},\"required\":[\"name\",\"description\",\"authors\",\"cite\",\"license\",\"format_version\",\"type\"],\"title\":\"dataset 0.3.0\",\"type\":\"object\"},\"bioimageio__spec__dataset__v0_3__LinkedDataset\":{\"additionalProperties\":false,\"description\":\"Reference to a bioimage.io dataset.\",\"properties\":{\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the linked resource following SemVer 2.0.\"},\"id\":{\"description\":\"A valid dataset `id` from the bioimage.io collection.\",\"minLength\":1,\"title\":\"DatasetId\",\"type\":\"string\"}},\"required\":[\"id\"],\"title\":\"dataset.v0_3.LinkedDataset\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_2__Author\":{\"additionalProperties\":false,\"properties\":{\"affiliation\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Affiliation\",\"title\":\"Affiliation\"},\"email\":{\"anyOf\":[{\"format\":\"email\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Email\",\"title\":\"Email\"},\"orcid\":{\"anyOf\":[{\"description\":\"An ORCID identifier, see https://orcid.org/\",\"title\":\"OrcidId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\\n) in hyphenated groups of 4 digits, (and [valid](\\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\\n) as per ISO 7064 11,2.)\",\"examples\":[\"0000-0001-2345-6789\"],\"title\":\"Orcid\"},\"name\":{\"title\":\"Name\",\"type\":\"string\"},\"github_user\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Github User\"}},\"required\":[\"name\"],\"title\":\"generic.v0_2.Author\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_2__CiteEntry\":{\"additionalProperties\":false,\"properties\":{\"text\":{\"description\":\"free text description\",\"title\":\"Text\",\"type\":\"string\"},\"doi\":{\"anyOf\":[{\"description\":\"A digital object identifier, see https://www.doi.org/\",\"pattern\":\"^10\\\\.[0-9]{4}.+$\",\"title\":\"Doi\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A digital object identifier (DOI) is the prefered citation reference.\\nSee https://www.doi.org/ for details. (alternatively specify `url`)\",\"title\":\"Doi\"},\"url\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL to cite (preferably specify a `doi` instead)\",\"title\":\"Url\"}},\"required\":[\"text\"],\"title\":\"generic.v0_2.CiteEntry\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_2__Maintainer\":{\"additionalProperties\":false,\"properties\":{\"affiliation\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Affiliation\",\"title\":\"Affiliation\"},\"email\":{\"anyOf\":[{\"format\":\"email\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Email\",\"title\":\"Email\"},\"orcid\":{\"anyOf\":[{\"description\":\"An ORCID identifier, see https://orcid.org/\",\"title\":\"OrcidId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\\n) in hyphenated groups of 4 digits, (and [valid](\\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\\n) as per ISO 7064 11,2.)\",\"examples\":[\"0000-0001-2345-6789\"],\"title\":\"Orcid\"},\"name\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Name\"},\"github_user\":{\"title\":\"Github User\",\"type\":\"string\"}},\"required\":[\"github_user\"],\"title\":\"generic.v0_2.Maintainer\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_3__Author\":{\"additionalProperties\":false,\"properties\":{\"affiliation\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Affiliation\",\"title\":\"Affiliation\"},\"email\":{\"anyOf\":[{\"format\":\"email\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Email\",\"title\":\"Email\"},\"orcid\":{\"anyOf\":[{\"description\":\"An ORCID identifier, see https://orcid.org/\",\"title\":\"OrcidId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\\n) in hyphenated groups of 4 digits, (and [valid](\\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\\n) as per ISO 7064 11,2.)\",\"examples\":[\"0000-0001-2345-6789\"],\"title\":\"Orcid\"},\"name\":{\"title\":\"Name\",\"type\":\"string\"},\"github_user\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Github User\"}},\"required\":[\"name\"],\"title\":\"generic.v0_3.Author\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_3__BioimageioConfig\":{\"additionalProperties\":true,\"description\":\"bioimage.io internal metadata.\",\"properties\":{},\"title\":\"generic.v0_3.BioimageioConfig\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_3__CiteEntry\":{\"additionalProperties\":false,\"description\":\"A citation that should be referenced in work using this resource.\",\"properties\":{\"text\":{\"description\":\"free text description\",\"title\":\"Text\",\"type\":\"string\"},\"doi\":{\"anyOf\":[{\"description\":\"A digital object identifier, see https://www.doi.org/\",\"pattern\":\"^10\\\\.[0-9]{4}.+$\",\"title\":\"Doi\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A digital object identifier (DOI) is the prefered citation reference.\\nSee https://www.doi.org/ for details.\\nNote:\\n Either **doi** or **url** have to be specified.\",\"title\":\"Doi\"},\"url\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL to cite (preferably specify a **doi** instead/also).\\nNote:\\n Either **doi** or **url** have to be specified.\",\"title\":\"Url\"}},\"required\":[\"text\"],\"title\":\"generic.v0_3.CiteEntry\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_3__Config\":{\"additionalProperties\":true,\"description\":\"A place to store additional metadata (often tool specific).\\n\\nSuch additional metadata is typically set programmatically by the respective tool\\nor by people with specific insights into the tool.\\nIf you want to store additional metadata that does not match any of the other\\nfields, think of a key unlikely to collide with anyone elses use-case/tool and save\\nit here.\\n\\nPlease consider creating [an issue in the bioimageio.spec repository](https://github.com/bioimage-io/spec-bioimage-io/issues/new?template=Blank+issue)\\nif you are not sure if an existing field could cover your use case\\nor if you think such a field should exist.\",\"properties\":{\"bioimageio\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__BioimageioConfig\"}},\"title\":\"generic.v0_3.Config\",\"type\":\"object\"},\"bioimageio__spec__generic__v0_3__Maintainer\":{\"additionalProperties\":false,\"properties\":{\"affiliation\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Affiliation\",\"title\":\"Affiliation\"},\"email\":{\"anyOf\":[{\"format\":\"email\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Email\",\"title\":\"Email\"},\"orcid\":{\"anyOf\":[{\"description\":\"An ORCID identifier, see https://orcid.org/\",\"title\":\"OrcidId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\\n) in hyphenated groups of 4 digits, (and [valid](\\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\\n) as per ISO 7064 11,2.)\",\"examples\":[\"0000-0001-2345-6789\"],\"title\":\"Orcid\"},\"name\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"title\":\"Name\"},\"github_user\":{\"title\":\"Github User\",\"type\":\"string\"}},\"required\":[\"github_user\"],\"title\":\"generic.v0_3.Maintainer\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__BinarizeDescr\":{\"additionalProperties\":false,\"description\":\"BinarizeDescr the tensor with a fixed `BinarizeKwargs.threshold`.\\nValues above the threshold will be set to one, values below the threshold to zero.\",\"properties\":{\"name\":{\"const\":\"binarize\",\"title\":\"Name\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__BinarizeKwargs\"}},\"required\":[\"name\",\"kwargs\"],\"title\":\"model.v0_4.BinarizeDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__BinarizeKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `BinarizeDescr`\",\"properties\":{\"threshold\":{\"description\":\"The fixed threshold\",\"title\":\"Threshold\",\"type\":\"number\"}},\"required\":[\"threshold\"],\"title\":\"model.v0_4.BinarizeKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ClipDescr\":{\"additionalProperties\":false,\"description\":\"Clip tensor values to a range.\\n\\nSet tensor values below `ClipKwargs.min` to `ClipKwargs.min`\\nand above `ClipKwargs.max` to `ClipKwargs.max`.\",\"properties\":{\"name\":{\"const\":\"clip\",\"title\":\"Name\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/ClipKwargs\"}},\"required\":[\"name\",\"kwargs\"],\"title\":\"model.v0_4.ClipDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__InputTensorDescr\":{\"additionalProperties\":false,\"properties\":{\"name\":{\"description\":\"Tensor name. No duplicates are allowed.\",\"minLength\":1,\"title\":\"TensorName\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"title\":\"Description\",\"type\":\"string\"},\"axes\":{\"description\":\"Axes identifying characters. Same length and order as the axes in `shape`.\\n| axis | description |\\n| --- | --- |\\n| b | batch (groups multiple samples) |\\n| i | instance/index/element |\\n| t | time |\\n| c | channel |\\n| z | spatial dimension z |\\n| y | spatial dimension y |\\n| x | spatial dimension x |\",\"title\":\"Axes\",\"type\":\"string\"},\"data_range\":{\"anyOf\":[{\"maxItems\":2,\"minItems\":2,\"prefixItems\":[{\"type\":\"number\"},{\"type\":\"number\"}],\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Tuple `(minimum, maximum)` specifying the allowed range of the data in this tensor.\\nIf not specified, the full data range that can be expressed in `data_type` is allowed.\",\"title\":\"Data Range\"},\"data_type\":{\"description\":\"For now an input tensor is expected to be given as `float32`.\\nThe data flow in bioimage.io models is explained\\n[in this diagram.](https://docs.google.com/drawings/d/1FTw8-Rn6a6nXdkZ_SkMumtcjvur9mtIhRqLwnKqZNHM/edit).\",\"enum\":[\"float32\",\"uint8\",\"uint16\"],\"title\":\"Data Type\",\"type\":\"string\"},\"shape\":{\"anyOf\":[{\"items\":{\"type\":\"integer\"},\"type\":\"array\"},{\"$ref\":\"#/$defs/ParameterizedInputShape\"}],\"description\":\"Specification of input tensor shape.\",\"examples\":[[1,512,512,1],{\"min\":[1,64,64,1],\"step\":[0,32,32,0]}],\"title\":\"Shape\"},\"preprocessing\":{\"description\":\"Description of how this input should be preprocessed.\",\"items\":{\"discriminator\":{\"mapping\":{\"binarize\":\"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr\",\"clip\":\"#/$defs/bioimageio__spec__model__v0_4__ClipDescr\",\"scale_linear\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr\",\"scale_range\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr\",\"sigmoid\":\"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr\",\"zero_mean_unit_variance\":\"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr\"},\"propertyName\":\"name\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ClipDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr\"}]},\"title\":\"Preprocessing\",\"type\":\"array\"}},\"required\":[\"name\",\"axes\",\"data_type\",\"shape\"],\"title\":\"model.v0_4.InputTensorDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__KerasHdf5WeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Attachments that are specific to this weights entry.\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"dependencies\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"Dependencies\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.\",\"examples\":[\"conda:environment.yaml\",\"maven:./pom.xml\",\"pip:./requirements.txt\"],\"title\":\"Dependencies\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"tensorflow_version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"TensorFlow version used to create these weights\"}},\"required\":[\"source\"],\"title\":\"model.v0_4.KerasHdf5WeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__LinkedModel\":{\"additionalProperties\":false,\"description\":\"Reference to a bioimage.io model.\",\"properties\":{\"id\":{\"description\":\"A valid model `id` from the bioimage.io collection.\",\"examples\":[\"affable-shark\",\"ambitious-sloth\"],\"minLength\":1,\"title\":\"ModelId\",\"type\":\"string\"},\"version_number\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"version number (n-th published version, not the semantic version) of linked model\",\"title\":\"Version Number\"}},\"required\":[\"id\"],\"title\":\"model.v0_4.LinkedModel\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ModelDescr\":{\"additionalProperties\":false,\"description\":\"Specification of the fields used in a bioimage.io-compliant RDF that describes AI models with pretrained weights.\\n\\nThese fields are typically stored in a YAML file which we call a model resource description file (model RDF).\",\"properties\":{\"name\":{\"description\":\"A human-readable name of this model.\\nIt should be no longer than 64 characters and only contain letter, number, underscore, minus or space characters.\",\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":1,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of the model RDF and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"minItems\":1,\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"file and other attachments\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry\"},\"title\":\"Cite\",\"type\":\"array\"},\"config\":{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a github repo URL in `config` since we already have the\\n`git_repo` field defined in the spec.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n bioimageio: # here is the domain name\\n my_custom_key: 3837283\\n another_key:\\n nested: value\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files)\",\"examples\":[{\"bioimageio\":{\"another_key\":{\"nested\":\"value\"},\"my_custom_key\":3837283},\"imagej\":{\"macro_dir\":\"path/to/macro/file\"}}],\"title\":\"Config\",\"type\":\"object\"},\"download_url\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL to download the resource from (deprecated)\",\"title\":\"Download Url\"},\"git_repo\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"rdf_source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\\nDo not set this field in a YAML file.\",\"title\":\"Rdf Source\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"version_number\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"version number (n-th published version, not the semantic version)\",\"title\":\"Version Number\"},\"format_version\":{\"const\":\"0.4.10\",\"description\":\"Version of the bioimage.io model description specification used.\\nWhen creating a new model always use the latest micro/patch version described here.\\nThe `format_version` is important for any consumer software to understand how to parse the fields.\",\"title\":\"Format Version\",\"type\":\"string\"},\"type\":{\"const\":\"model\",\"description\":\"Specialized resource type 'model'\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"ModelId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"documentation\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"URL or relative path to a markdown file with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\\nThe documentation should include a '[#[#]]# Validation' (sub)section\\nwith details on how to quantitatively validate the model on unseen data.\",\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"],\"title\":\"Documentation\"},\"inputs\":{\"description\":\"Describes the input tensors expected by this model.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__InputTensorDescr\"},\"minItems\":1,\"title\":\"Inputs\",\"type\":\"array\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"type\":\"string\"}],\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do notsupport custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\\n) to discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"outputs\":{\"description\":\"Describes the output tensors.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__OutputTensorDescr\"},\"minItems\":1,\"title\":\"Outputs\",\"type\":\"array\"},\"packaged_by\":{\"description\":\"The persons that have packaged and uploaded this model.\\nOnly required if those persons differ from the `authors`.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"title\":\"Packaged By\",\"type\":\"array\"},\"parent\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__LinkedModel\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The model from which this model is derived, e.g. by fine-tuning the weights.\"},\"run_mode\":{\"anyOf\":[{\"$ref\":\"#/$defs/RunMode\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Custom run mode for this model: for more complex prediction procedures like test time\\ndata augmentation that currently cannot be expressed in the specification.\\nNo standard run modes are defined yet.\"},\"sample_inputs\":{\"description\":\"URLs/relative paths to sample inputs to illustrate possible inputs for the model,\\nfor example stored as PNG or TIFF images.\\nThe sample files primarily serve to inform a human user about an example use case\",\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Sample Inputs\",\"type\":\"array\"},\"sample_outputs\":{\"description\":\"URLs/relative paths to sample outputs corresponding to the `sample_inputs`.\",\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Sample Outputs\",\"type\":\"array\"},\"test_inputs\":{\"description\":\"Test input tensors compatible with the `inputs` description for a **single test case**.\\nThis means if your model has more than one input, you should provide one URL/relative path for each input.\\nEach test input should be a file with an ndarray in\\n[numpy.lib file format](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html#module-numpy.lib.format).\\nThe extension must be '.npy'.\",\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"minItems\":1,\"title\":\"Test Inputs\",\"type\":\"array\"},\"test_outputs\":{\"description\":\"Analog to `test_inputs`.\",\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"minItems\":1,\"title\":\"Test Outputs\",\"type\":\"array\"},\"timestamp\":{\"$ref\":\"#/$defs/Datetime\"},\"training_data\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_2__LinkedDataset\"},{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The dataset used to train this model\",\"title\":\"Training Data\"},\"weights\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__WeightsDescr\",\"description\":\"The weights for this model.\\nWeights can be given for different formats, but should otherwise be equivalent.\\nThe available weight formats determine which consumers can use this model.\"}},\"required\":[\"name\",\"description\",\"authors\",\"format_version\",\"type\",\"documentation\",\"inputs\",\"license\",\"outputs\",\"test_inputs\",\"test_outputs\",\"timestamp\",\"weights\"],\"title\":\"model 0.4.10\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__OnnxWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Attachments that are specific to this weights entry.\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"dependencies\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"Dependencies\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.\",\"examples\":[\"conda:environment.yaml\",\"maven:./pom.xml\",\"pip:./requirements.txt\"],\"title\":\"Dependencies\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"opset_version\":{\"anyOf\":[{\"minimum\":7,\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"ONNX opset version\",\"title\":\"Opset Version\"}},\"required\":[\"source\"],\"title\":\"model.v0_4.OnnxWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__OutputTensorDescr\":{\"additionalProperties\":false,\"properties\":{\"name\":{\"description\":\"Tensor name. No duplicates are allowed.\",\"minLength\":1,\"title\":\"TensorName\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"title\":\"Description\",\"type\":\"string\"},\"axes\":{\"description\":\"Axes identifying characters. Same length and order as the axes in `shape`.\\n| axis | description |\\n| --- | --- |\\n| b | batch (groups multiple samples) |\\n| i | instance/index/element |\\n| t | time |\\n| c | channel |\\n| z | spatial dimension z |\\n| y | spatial dimension y |\\n| x | spatial dimension x |\",\"title\":\"Axes\",\"type\":\"string\"},\"data_range\":{\"anyOf\":[{\"maxItems\":2,\"minItems\":2,\"prefixItems\":[{\"type\":\"number\"},{\"type\":\"number\"}],\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Tuple `(minimum, maximum)` specifying the allowed range of the data in this tensor.\\nIf not specified, the full data range that can be expressed in `data_type` is allowed.\",\"title\":\"Data Range\"},\"data_type\":{\"description\":\"Data type.\\nThe data flow in bioimage.io models is explained\\n[in this diagram.](https://docs.google.com/drawings/d/1FTw8-Rn6a6nXdkZ_SkMumtcjvur9mtIhRqLwnKqZNHM/edit).\",\"enum\":[\"float32\",\"float64\",\"uint8\",\"int8\",\"uint16\",\"int16\",\"uint32\",\"int32\",\"uint64\",\"int64\",\"bool\"],\"title\":\"Data Type\",\"type\":\"string\"},\"shape\":{\"anyOf\":[{\"items\":{\"type\":\"integer\"},\"type\":\"array\"},{\"$ref\":\"#/$defs/ImplicitOutputShape\"}],\"description\":\"Output tensor shape.\",\"title\":\"Shape\"},\"halo\":{\"anyOf\":[{\"items\":{\"type\":\"integer\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The `halo` that should be cropped from the output tensor to avoid boundary effects.\\nThe `halo` is to be cropped from both sides, i.e. `shape_after_crop = shape - 2 * halo`.\\nTo document a `halo` that is already cropped by the model `shape.offset` has to be used instead.\",\"title\":\"Halo\"},\"postprocessing\":{\"description\":\"Description of how this output should be postprocessed.\",\"items\":{\"discriminator\":{\"mapping\":{\"binarize\":\"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr\",\"clip\":\"#/$defs/bioimageio__spec__model__v0_4__ClipDescr\",\"scale_linear\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr\",\"scale_mean_variance\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleMeanVarianceDescr\",\"scale_range\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr\",\"sigmoid\":\"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr\",\"zero_mean_unit_variance\":\"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr\"},\"propertyName\":\"name\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ClipDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleMeanVarianceDescr\"}]},\"title\":\"Postprocessing\",\"type\":\"array\"}},\"required\":[\"name\",\"axes\",\"data_type\",\"shape\"],\"title\":\"model.v0_4.OutputTensorDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__PytorchStateDictWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Attachments that are specific to this weights entry.\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"dependencies\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"Dependencies\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.\",\"examples\":[\"conda:environment.yaml\",\"maven:./pom.xml\",\"pip:./requirements.txt\"],\"title\":\"Dependencies\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"architecture\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"CallableFromFile\",\"type\":\"string\"},{\"pattern\":\"^.+\\\\..+$\",\"title\":\"CallableFromDepencency\",\"type\":\"string\"}],\"description\":\"callable returning a torch.nn.Module instance.\\nLocal implementation: `<relative path to file>:<identifier of implementation within the file>`.\\nImplementation in a dependency: `<dependency-package>.<[dependency-module]>.<identifier>`.\",\"examples\":[\"my_function.py:MyNetworkClass\",\"my_module.submodule.get_my_model\"],\"title\":\"Architecture\"},\"architecture_sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The SHA256 of the architecture source file, if the architecture is not defined in a module listed in `dependencies`\\nYou can drag and drop your file to this\\n[online tool](http://emn178.github.io/online-tools/sha256_checksum.html) to generate a SHA256 in your browser.\\nOr you can generate a SHA256 checksum with Python's `hashlib`,\\n[here is a codesnippet](https://gist.github.com/FynnBe/e64460463df89439cff218bbf59c1100).\",\"title\":\"Architecture Sha256\"},\"kwargs\":{\"additionalProperties\":true,\"description\":\"key word arguments for the `architecture` callable\",\"title\":\"Kwargs\",\"type\":\"object\"},\"pytorch_version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Version of the PyTorch library used.\\nIf `depencencies` is specified it should include pytorch and the verison has to match.\\n(`dependencies` overrules `pytorch_version`)\"}},\"required\":[\"source\",\"architecture\"],\"title\":\"model.v0_4.PytorchStateDictWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ScaleLinearDescr\":{\"additionalProperties\":false,\"description\":\"Fixed linear scaling.\",\"properties\":{\"name\":{\"const\":\"scale_linear\",\"title\":\"Name\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearKwargs\"}},\"required\":[\"name\",\"kwargs\"],\"title\":\"model.v0_4.ScaleLinearDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ScaleLinearKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ScaleLinearDescr`\",\"properties\":{\"axes\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The subset of axes to scale jointly.\\nFor example xy to scale the two image axes for 2d data jointly.\",\"examples\":[\"xy\"],\"title\":\"Axes\"},\"gain\":{\"anyOf\":[{\"type\":\"number\"},{\"items\":{\"type\":\"number\"},\"type\":\"array\"}],\"default\":1.0,\"description\":\"multiplicative factor\",\"title\":\"Gain\"},\"offset\":{\"anyOf\":[{\"type\":\"number\"},{\"items\":{\"type\":\"number\"},\"type\":\"array\"}],\"default\":0.0,\"description\":\"additive term\",\"title\":\"Offset\"}},\"title\":\"model.v0_4.ScaleLinearKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ScaleMeanVarianceDescr\":{\"additionalProperties\":false,\"description\":\"Scale the tensor s.t. its mean and variance match a reference tensor.\",\"properties\":{\"name\":{\"const\":\"scale_mean_variance\",\"title\":\"Name\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleMeanVarianceKwargs\"}},\"required\":[\"name\",\"kwargs\"],\"title\":\"model.v0_4.ScaleMeanVarianceDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ScaleMeanVarianceKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ScaleMeanVarianceDescr`\",\"properties\":{\"mode\":{\"description\":\"Mode for computing mean and variance.\\n| mode | description |\\n| ----------- | ------------------------------------ |\\n| per_dataset | Compute for the entire dataset |\\n| per_sample | Compute for each sample individually |\",\"enum\":[\"per_dataset\",\"per_sample\"],\"title\":\"Mode\",\"type\":\"string\"},\"reference_tensor\":{\"description\":\"Name of tensor to match.\",\"minLength\":1,\"title\":\"TensorName\",\"type\":\"string\"},\"axes\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The subset of axes to scale jointly.\\nFor example xy to normalize the two image axes for 2d data jointly.\\nDefault: scale all non-batch axes jointly.\",\"examples\":[\"xy\"],\"title\":\"Axes\"},\"eps\":{\"default\":1e-06,\"description\":\"Epsilon for numeric stability:\\n\\\"`out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.\",\"exclusiveMinimum\":0,\"maximum\":0.1,\"title\":\"Eps\",\"type\":\"number\"}},\"required\":[\"mode\",\"reference_tensor\"],\"title\":\"model.v0_4.ScaleMeanVarianceKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ScaleRangeDescr\":{\"additionalProperties\":false,\"description\":\"Scale with percentiles.\",\"properties\":{\"name\":{\"const\":\"scale_range\",\"title\":\"Name\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeKwargs\"}},\"required\":[\"name\",\"kwargs\"],\"title\":\"model.v0_4.ScaleRangeDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ScaleRangeKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ScaleRangeDescr`\\n\\nFor `min_percentile`=0.0 (the default) and `max_percentile`=100 (the default)\\nthis processing step normalizes data to the [0, 1] intervall.\\nFor other percentiles the normalized values will partially be outside the [0, 1]\\nintervall. Use `ScaleRange` followed by `ClipDescr` if you want to limit the\\nnormalized values to a range.\",\"properties\":{\"mode\":{\"description\":\"Mode for computing percentiles.\\n| mode | description |\\n| ----------- | ------------------------------------ |\\n| per_dataset | compute for the entire dataset |\\n| per_sample | compute for each sample individually |\",\"enum\":[\"per_dataset\",\"per_sample\"],\"title\":\"Mode\",\"type\":\"string\"},\"axes\":{\"description\":\"The subset of axes to normalize jointly.\\nFor example xy to normalize the two image axes for 2d data jointly.\",\"examples\":[\"xy\"],\"title\":\"Axes\",\"type\":\"string\"},\"min_percentile\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"number\"}],\"default\":0.0,\"description\":\"The lower percentile used to determine the value to align with zero.\",\"ge\":0,\"lt\":100,\"title\":\"Min Percentile\"},\"max_percentile\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"number\"}],\"default\":100.0,\"description\":\"The upper percentile used to determine the value to align with one.\\nHas to be bigger than `min_percentile`.\\nThe range is 1 to 100 instead of 0 to 100 to avoid mistakenly\\naccepting percentiles specified in the range 0.0 to 1.0.\",\"gt\":1,\"le\":100,\"title\":\"Max Percentile\"},\"eps\":{\"default\":1e-06,\"description\":\"Epsilon for numeric stability.\\n`out = (tensor - v_lower) / (v_upper - v_lower + eps)`;\\nwith `v_lower,v_upper` values at the respective percentiles.\",\"exclusiveMinimum\":0,\"maximum\":0.1,\"title\":\"Eps\",\"type\":\"number\"},\"reference_tensor\":{\"anyOf\":[{\"minLength\":1,\"title\":\"TensorName\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Tensor name to compute the percentiles from. Default: The tensor itself.\\nFor any tensor in `inputs` only input tensor references are allowed.\\nFor a tensor in `outputs` only input tensor refereences are allowed if `mode: per_dataset`\",\"title\":\"Reference Tensor\"}},\"required\":[\"mode\",\"axes\"],\"title\":\"model.v0_4.ScaleRangeKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__SigmoidDescr\":{\"additionalProperties\":false,\"description\":\"The logistic sigmoid funciton, a.k.a. expit function.\",\"properties\":{\"name\":{\"const\":\"sigmoid\",\"title\":\"Name\",\"type\":\"string\"}},\"required\":[\"name\"],\"title\":\"model.v0_4.SigmoidDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__TensorflowJsWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The multi-file weights.\\nAll required files/folders should be a zip archive.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Attachments that are specific to this weights entry.\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"dependencies\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"Dependencies\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.\",\"examples\":[\"conda:environment.yaml\",\"maven:./pom.xml\",\"pip:./requirements.txt\"],\"title\":\"Dependencies\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"tensorflow_version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Version of the TensorFlow library used.\"}},\"required\":[\"source\"],\"title\":\"model.v0_4.TensorflowJsWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__TensorflowSavedModelBundleWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Attachments that are specific to this weights entry.\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"dependencies\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"Dependencies\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.\",\"examples\":[\"conda:environment.yaml\",\"maven:./pom.xml\",\"pip:./requirements.txt\"],\"title\":\"Dependencies\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"tensorflow_version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Version of the TensorFlow library used.\"}},\"required\":[\"source\"],\"title\":\"model.v0_4.TensorflowSavedModelBundleWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__TorchscriptWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Attachments that are specific to this weights entry.\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"dependencies\":{\"anyOf\":[{\"pattern\":\"^.+:.+$\",\"title\":\"Dependencies\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.\",\"examples\":[\"conda:environment.yaml\",\"maven:./pom.xml\",\"pip:./requirements.txt\"],\"title\":\"Dependencies\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"pytorch_version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Version of the PyTorch library used.\"}},\"required\":[\"source\"],\"title\":\"model.v0_4.TorchscriptWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__WeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"keras_hdf5\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__KerasHdf5WeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"onnx\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__OnnxWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"pytorch_state_dict\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__PytorchStateDictWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"tensorflow_js\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__TensorflowJsWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"tensorflow_saved_model_bundle\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__TensorflowSavedModelBundleWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"torchscript\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__TorchscriptWeightsDescr\"},{\"type\":\"null\"}],\"default\":null}},\"title\":\"model.v0_4.WeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr\":{\"additionalProperties\":false,\"description\":\"Subtract mean and divide by variance.\",\"properties\":{\"name\":{\"const\":\"zero_mean_unit_variance\",\"title\":\"Name\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceKwargs\"}},\"required\":[\"name\",\"kwargs\"],\"title\":\"model.v0_4.ZeroMeanUnitVarianceDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ZeroMeanUnitVarianceDescr`\",\"properties\":{\"mode\":{\"default\":\"fixed\",\"description\":\"Mode for computing mean and variance.\\n| mode | description |\\n| ----------- | ------------------------------------ |\\n| fixed | Fixed values for mean and variance |\\n| per_dataset | Compute for the entire dataset |\\n| per_sample | Compute for each sample individually |\",\"enum\":[\"fixed\",\"per_dataset\",\"per_sample\"],\"title\":\"Mode\",\"type\":\"string\"},\"axes\":{\"description\":\"The subset of axes to normalize jointly.\\nFor example `xy` to normalize the two image axes for 2d data jointly.\",\"examples\":[\"xy\"],\"title\":\"Axes\",\"type\":\"string\"},\"mean\":{\"anyOf\":[{\"type\":\"number\"},{\"items\":{\"type\":\"number\"},\"minItems\":1,\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The mean value(s) to use for `mode: fixed`.\\nFor example `[1.1, 2.2, 3.3]` in the case of a 3 channel image with `axes: xy`.\",\"examples\":[[1.1,2.2,3.3]],\"title\":\"Mean\"},\"std\":{\"anyOf\":[{\"type\":\"number\"},{\"items\":{\"type\":\"number\"},\"minItems\":1,\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The standard deviation values to use for `mode: fixed`. Analogous to mean.\",\"examples\":[[0.1,0.2,0.3]],\"title\":\"Std\"},\"eps\":{\"default\":1e-06,\"description\":\"epsilon for numeric stability: `out = (tensor - mean) / (std + eps)`.\",\"exclusiveMinimum\":0,\"maximum\":0.1,\"title\":\"Eps\",\"type\":\"number\"}},\"required\":[\"axes\"],\"title\":\"model.v0_4.ZeroMeanUnitVarianceKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__BinarizeDescr\":{\"additionalProperties\":false,\"description\":\"Binarize the tensor with a fixed threshold.\\n\\nValues above `BinarizeKwargs.threshold`/`BinarizeAlongAxisKwargs.threshold`\\nwill be set to one, values below the threshold to zero.\\n\\nExamples:\\n- in YAML\\n ```yaml\\n postprocessing:\\n - id: binarize\\n kwargs:\\n axis: 'channel'\\n threshold: [0.25, 0.5, 0.75]\\n ```\\n- in Python:\\n >>> postprocessing = [BinarizeDescr(\\n ... kwargs=BinarizeAlongAxisKwargs(\\n ... axis=AxisId('channel'),\\n ... threshold=[0.25, 0.5, 0.75],\\n ... )\\n ... )]\",\"properties\":{\"id\":{\"const\":\"binarize\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__BinarizeKwargs\"},{\"$ref\":\"#/$defs/BinarizeAlongAxisKwargs\"}],\"title\":\"Kwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.BinarizeDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__BinarizeKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `BinarizeDescr`\",\"properties\":{\"threshold\":{\"description\":\"The fixed threshold\",\"title\":\"Threshold\",\"type\":\"number\"}},\"required\":[\"threshold\"],\"title\":\"model.v0_5.BinarizeKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__BioimageioConfig\":{\"additionalProperties\":true,\"properties\":{\"reproducibility_tolerance\":{\"default\":[],\"description\":\"Tolerances to allow when reproducing the model's test outputs\\nfrom the model's test inputs.\\nOnly the first entry matching tensor id and weights format is considered.\",\"items\":{\"$ref\":\"#/$defs/ReproducibilityTolerance\"},\"title\":\"Reproducibility Tolerance\",\"type\":\"array\"}},\"title\":\"model.v0_5.BioimageioConfig\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ClipDescr\":{\"additionalProperties\":false,\"description\":\"Set tensor values below min to min and above max to max.\\n\\nSee `ScaleRangeDescr` for examples.\",\"properties\":{\"id\":{\"const\":\"clip\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/ClipKwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.ClipDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__Config\":{\"additionalProperties\":true,\"properties\":{\"bioimageio\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__BioimageioConfig\"}},\"title\":\"model.v0_5.Config\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__InputTensorDescr\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"default\":\"input\",\"description\":\"Input tensor id.\\nNo duplicates are allowed across all inputs and outputs.\",\"maxLength\":32,\"minLength\":1,\"title\":\"TensorId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"description\":\"free text description\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"axes\":{\"description\":\"tensor axes\",\"items\":{\"discriminator\":{\"mapping\":{\"batch\":\"#/$defs/BatchAxis\",\"channel\":\"#/$defs/ChannelAxis\",\"index\":\"#/$defs/IndexInputAxis\",\"space\":\"#/$defs/SpaceInputAxis\",\"time\":\"#/$defs/TimeInputAxis\"},\"propertyName\":\"type\"},\"oneOf\":[{\"$ref\":\"#/$defs/BatchAxis\"},{\"$ref\":\"#/$defs/ChannelAxis\"},{\"$ref\":\"#/$defs/IndexInputAxis\"},{\"$ref\":\"#/$defs/TimeInputAxis\"},{\"$ref\":\"#/$defs/SpaceInputAxis\"}]},\"minItems\":1,\"title\":\"Axes\",\"type\":\"array\"},\"test_tensor\":{\"$ref\":\"#/$defs/FileDescr\",\"description\":\"An example tensor to use for testing.\\nUsing the model with the test input tensors is expected to yield the test output tensors.\\nEach test tensor has be a an ndarray in the\\n[numpy.lib file format](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html#module-numpy.lib.format).\\nThe file extension must be '.npy'.\"},\"sample_tensor\":{\"anyOf\":[{\"$ref\":\"#/$defs/FileDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A sample tensor to illustrate a possible input/output for the model,\\nThe sample image primarily serves to inform a human user about an example use case\\nand is typically stored as .hdf5, .png or .tiff.\\nIt has to be readable by the [imageio library](https://imageio.readthedocs.io/en/stable/formats/index.html#supported-formats)\\n(numpy's `.npy` format is not supported).\\nThe image dimensionality has to match the number of axes specified in this tensor description.\"},\"data\":{\"anyOf\":[{\"$ref\":\"#/$defs/NominalOrOrdinalDataDescr\"},{\"$ref\":\"#/$defs/IntervalOrRatioDataDescr\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/$defs/NominalOrOrdinalDataDescr\"},{\"$ref\":\"#/$defs/IntervalOrRatioDataDescr\"}]},\"minItems\":1,\"type\":\"array\"}],\"default\":{\"type\":\"float32\",\"range\":[null,null],\"unit\":\"arbitrary unit\",\"scale\":1.0,\"offset\":null},\"description\":\"Description of the tensor's data values, optionally per channel.\\nIf specified per channel, the data `type` needs to match across channels.\",\"title\":\"Data\"},\"optional\":{\"default\":false,\"description\":\"indicates that this tensor may be `None`\",\"title\":\"Optional\",\"type\":\"boolean\"},\"preprocessing\":{\"description\":\"Description of how this input should be preprocessed.\\n\\nnotes:\\n- If preprocessing does not start with an 'ensure_dtype' entry, it is added\\n to ensure an input tensor's data type matches the input tensor's data description.\\n- If preprocessing does not end with an 'ensure_dtype' or 'binarize' entry, an\\n 'ensure_dtype' step is added to ensure preprocessing steps are not unintentionally\\n changing the data type.\",\"items\":{\"discriminator\":{\"mapping\":{\"binarize\":\"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr\",\"clip\":\"#/$defs/bioimageio__spec__model__v0_5__ClipDescr\",\"ensure_dtype\":\"#/$defs/EnsureDtypeDescr\",\"fixed_zero_mean_unit_variance\":\"#/$defs/FixedZeroMeanUnitVarianceDescr\",\"scale_linear\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr\",\"scale_range\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr\",\"sigmoid\":\"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr\",\"zero_mean_unit_variance\":\"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr\"},\"propertyName\":\"id\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ClipDescr\"},{\"$ref\":\"#/$defs/EnsureDtypeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr\"},{\"$ref\":\"#/$defs/FixedZeroMeanUnitVarianceDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr\"}]},\"title\":\"Preprocessing\",\"type\":\"array\"}},\"required\":[\"axes\",\"test_tensor\"],\"title\":\"model.v0_5.InputTensorDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__KerasHdf5WeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"Source of the weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"comment\":{\"default\":\"\",\"description\":\"A comment about this weights entry, for example how these weights were created.\",\"title\":\"Comment\",\"type\":\"string\"},\"tensorflow_version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"TensorFlow version used to create these weights.\"}},\"required\":[\"source\",\"tensorflow_version\"],\"title\":\"model.v0_5.KerasHdf5WeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__LinkedModel\":{\"additionalProperties\":false,\"description\":\"Reference to a bioimage.io model.\",\"properties\":{\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the linked resource following SemVer 2.0.\"},\"id\":{\"description\":\"A valid model `id` from the bioimage.io collection.\",\"minLength\":1,\"title\":\"ModelId\",\"type\":\"string\"}},\"required\":[\"id\"],\"title\":\"model.v0_5.LinkedModel\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ModelDescr\":{\"additionalProperties\":false,\"description\":\"Specification of the fields used in a bioimage.io-compliant RDF to describe AI models with pretrained weights.\\nThese fields are typically stored in a YAML file which we call a model resource description file (model RDF).\",\"properties\":{\"name\":{\"description\":\"A human-readable name of this model.\\nIt should be no longer than 64 characters\\nand may only contain letter, number, underscore, minus, parentheses and spaces.\\nWe recommend to chose a name that refers to the model's task and image modality.\",\"maxLength\":128,\"minLength\":5,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"description\":\"A string containing a brief description.\",\"maxLength\":1024,\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of the model RDF and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"minItems\":1,\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"description\":\"file attachments\",\"items\":{\"$ref\":\"#/$defs/FileDescr\"},\"title\":\"Attachments\",\"type\":\"array\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry\"},\"minItems\":1,\"title\":\"Cite\",\"type\":\"array\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"}],\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\\nto discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"git_repo\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration, e.g. on bioimage.io\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"format_version\":{\"const\":\"0.5.4\",\"description\":\"Version of the bioimage.io model description specification used.\\nWhen creating a new model always use the latest micro/patch version described here.\\nThe `format_version` is important for any consumer software to understand how to parse the fields.\",\"title\":\"Format Version\",\"type\":\"string\"},\"type\":{\"const\":\"model\",\"description\":\"Specialized resource type 'model'\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"ModelId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"documentation\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"URL or relative path to a markdown file with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\\nThe documentation should include a '#[#] Validation' (sub)section\\nwith details on how to quantitatively validate the model on unseen data.\",\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"],\"title\":\"Documentation\"},\"inputs\":{\"description\":\"Describes the input tensors expected by this model.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__InputTensorDescr\"},\"minItems\":1,\"title\":\"Inputs\",\"type\":\"array\"},\"outputs\":{\"description\":\"Describes the output tensors.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__OutputTensorDescr\"},\"minItems\":1,\"title\":\"Outputs\",\"type\":\"array\"},\"packaged_by\":{\"description\":\"The persons that have packaged and uploaded this model.\\nOnly required if those persons differ from the `authors`.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"title\":\"Packaged By\",\"type\":\"array\"},\"parent\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__LinkedModel\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The model from which this model is derived, e.g. by fine-tuning the weights.\"},\"run_mode\":{\"anyOf\":[{\"$ref\":\"#/$defs/RunMode\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Custom run mode for this model: for more complex prediction procedures like test time\\ndata augmentation that currently cannot be expressed in the specification.\\nNo standard run modes are defined yet.\"},\"timestamp\":{\"$ref\":\"#/$defs/Datetime\",\"description\":\"Timestamp in [ISO 8601](#https://en.wikipedia.org/wiki/ISO_8601) format\\nwith a few restrictions listed [here](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat).\\n(In Python a datetime object is valid, too).\"},\"training_data\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_3__LinkedDataset\"},{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The dataset used to train this model\",\"title\":\"Training Data\"},\"weights\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__WeightsDescr\",\"description\":\"The weights for this model.\\nWeights can be given for different formats, but should otherwise be equivalent.\\nThe available weight formats determine which consumers can use this model.\"},\"config\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__Config\"}},\"required\":[\"name\",\"description\",\"authors\",\"cite\",\"license\",\"format_version\",\"type\",\"documentation\",\"inputs\",\"outputs\",\"weights\"],\"title\":\"model 0.5.4\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__OnnxWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"Source of the weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"comment\":{\"default\":\"\",\"description\":\"A comment about this weights entry, for example how these weights were created.\",\"title\":\"Comment\",\"type\":\"string\"},\"opset_version\":{\"description\":\"ONNX opset version\",\"minimum\":7,\"title\":\"Opset Version\",\"type\":\"integer\"}},\"required\":[\"source\",\"opset_version\"],\"title\":\"model.v0_5.OnnxWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__OutputTensorDescr\":{\"additionalProperties\":false,\"properties\":{\"id\":{\"default\":\"output\",\"description\":\"Output tensor id.\\nNo duplicates are allowed across all inputs and outputs.\",\"maxLength\":32,\"minLength\":1,\"title\":\"TensorId\",\"type\":\"string\"},\"description\":{\"default\":\"\",\"description\":\"free text description\",\"maxLength\":128,\"title\":\"Description\",\"type\":\"string\"},\"axes\":{\"description\":\"tensor axes\",\"items\":{\"discriminator\":{\"mapping\":{\"batch\":\"#/$defs/BatchAxis\",\"channel\":\"#/$defs/ChannelAxis\",\"index\":\"#/$defs/IndexOutputAxis\",\"space\":{\"oneOf\":[{\"$ref\":\"#/$defs/SpaceOutputAxis\"},{\"$ref\":\"#/$defs/SpaceOutputAxisWithHalo\"}]},\"time\":{\"oneOf\":[{\"$ref\":\"#/$defs/TimeOutputAxis\"},{\"$ref\":\"#/$defs/TimeOutputAxisWithHalo\"}]}},\"propertyName\":\"type\"},\"oneOf\":[{\"$ref\":\"#/$defs/BatchAxis\"},{\"$ref\":\"#/$defs/ChannelAxis\"},{\"$ref\":\"#/$defs/IndexOutputAxis\"},{\"oneOf\":[{\"$ref\":\"#/$defs/TimeOutputAxis\"},{\"$ref\":\"#/$defs/TimeOutputAxisWithHalo\"}]},{\"oneOf\":[{\"$ref\":\"#/$defs/SpaceOutputAxis\"},{\"$ref\":\"#/$defs/SpaceOutputAxisWithHalo\"}]}]},\"minItems\":1,\"title\":\"Axes\",\"type\":\"array\"},\"test_tensor\":{\"$ref\":\"#/$defs/FileDescr\",\"description\":\"An example tensor to use for testing.\\nUsing the model with the test input tensors is expected to yield the test output tensors.\\nEach test tensor has be a an ndarray in the\\n[numpy.lib file format](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html#module-numpy.lib.format).\\nThe file extension must be '.npy'.\"},\"sample_tensor\":{\"anyOf\":[{\"$ref\":\"#/$defs/FileDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A sample tensor to illustrate a possible input/output for the model,\\nThe sample image primarily serves to inform a human user about an example use case\\nand is typically stored as .hdf5, .png or .tiff.\\nIt has to be readable by the [imageio library](https://imageio.readthedocs.io/en/stable/formats/index.html#supported-formats)\\n(numpy's `.npy` format is not supported).\\nThe image dimensionality has to match the number of axes specified in this tensor description.\"},\"data\":{\"anyOf\":[{\"$ref\":\"#/$defs/NominalOrOrdinalDataDescr\"},{\"$ref\":\"#/$defs/IntervalOrRatioDataDescr\"},{\"items\":{\"anyOf\":[{\"$ref\":\"#/$defs/NominalOrOrdinalDataDescr\"},{\"$ref\":\"#/$defs/IntervalOrRatioDataDescr\"}]},\"minItems\":1,\"type\":\"array\"}],\"default\":{\"type\":\"float32\",\"range\":[null,null],\"unit\":\"arbitrary unit\",\"scale\":1.0,\"offset\":null},\"description\":\"Description of the tensor's data values, optionally per channel.\\nIf specified per channel, the data `type` needs to match across channels.\",\"title\":\"Data\"},\"postprocessing\":{\"description\":\"Description of how this output should be postprocessed.\\n\\nnote: `postprocessing` always ends with an 'ensure_dtype' operation.\\n If not given this is added to cast to this tensor's `data.type`.\",\"items\":{\"discriminator\":{\"mapping\":{\"binarize\":\"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr\",\"clip\":\"#/$defs/bioimageio__spec__model__v0_5__ClipDescr\",\"ensure_dtype\":\"#/$defs/EnsureDtypeDescr\",\"fixed_zero_mean_unit_variance\":\"#/$defs/FixedZeroMeanUnitVarianceDescr\",\"scale_linear\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr\",\"scale_mean_variance\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleMeanVarianceDescr\",\"scale_range\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr\",\"sigmoid\":\"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr\",\"zero_mean_unit_variance\":\"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr\"},\"propertyName\":\"id\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ClipDescr\"},{\"$ref\":\"#/$defs/EnsureDtypeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr\"},{\"$ref\":\"#/$defs/FixedZeroMeanUnitVarianceDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleMeanVarianceDescr\"}]},\"title\":\"Postprocessing\",\"type\":\"array\"}},\"required\":[\"axes\",\"test_tensor\"],\"title\":\"model.v0_5.OutputTensorDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__PytorchStateDictWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"Source of the weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"comment\":{\"default\":\"\",\"description\":\"A comment about this weights entry, for example how these weights were created.\",\"title\":\"Comment\",\"type\":\"string\"},\"architecture\":{\"anyOf\":[{\"$ref\":\"#/$defs/ArchitectureFromFileDescr\"},{\"$ref\":\"#/$defs/ArchitectureFromLibraryDescr\"}],\"title\":\"Architecture\"},\"pytorch_version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"Version of the PyTorch library used.\\nIf `architecture.depencencies` is specified it has to include pytorch and any version pinning has to be compatible.\"},\"dependencies\":{\"anyOf\":[{\"$ref\":\"#/$defs/FileDescr\",\"examples\":[{\"source\":\"environment.yaml\"}]},{\"type\":\"null\"}],\"default\":null,\"description\":\"Custom depencies beyond pytorch described in a Conda environment file.\\nAllows to specify custom dependencies, see conda docs:\\n- [Exporting an environment file across platforms](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#exporting-an-environment-file-across-platforms)\\n- [Creating an environment file manually](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-file-manually)\\n\\nThe conda environment file should include pytorch and any version pinning has to be compatible with\\n**pytorch_version**.\"}},\"required\":[\"source\",\"architecture\",\"pytorch_version\"],\"title\":\"model.v0_5.PytorchStateDictWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ScaleLinearDescr\":{\"additionalProperties\":false,\"description\":\"Fixed linear scaling.\\n\\nExamples:\\n 1. Scale with scalar gain and offset\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: scale_linear\\n kwargs:\\n gain: 2.0\\n offset: 3.0\\n ```\\n - in Python:\\n >>> preprocessing = [\\n ... ScaleLinearDescr(kwargs=ScaleLinearKwargs(gain= 2.0, offset=3.0))\\n ... ]\\n\\n 2. Independent scaling along an axis\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: scale_linear\\n kwargs:\\n axis: 'channel'\\n gain: [1.0, 2.0, 3.0]\\n ```\\n - in Python:\\n >>> preprocessing = [\\n ... ScaleLinearDescr(\\n ... kwargs=ScaleLinearAlongAxisKwargs(\\n ... axis=AxisId(\\\"channel\\\"),\\n ... gain=[1.0, 2.0, 3.0],\\n ... )\\n ... )\\n ... ]\",\"properties\":{\"id\":{\"const\":\"scale_linear\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearKwargs\"},{\"$ref\":\"#/$defs/ScaleLinearAlongAxisKwargs\"}],\"title\":\"Kwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.ScaleLinearDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ScaleLinearKwargs\":{\"additionalProperties\":false,\"description\":\"Key word arguments for `ScaleLinearDescr`\",\"properties\":{\"gain\":{\"default\":1.0,\"description\":\"multiplicative factor\",\"title\":\"Gain\",\"type\":\"number\"},\"offset\":{\"default\":0.0,\"description\":\"additive term\",\"title\":\"Offset\",\"type\":\"number\"}},\"title\":\"model.v0_5.ScaleLinearKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ScaleMeanVarianceDescr\":{\"additionalProperties\":false,\"description\":\"Scale a tensor's data distribution to match another tensor's mean/std.\\n`out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.`\",\"properties\":{\"id\":{\"const\":\"scale_mean_variance\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleMeanVarianceKwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.ScaleMeanVarianceDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ScaleMeanVarianceKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ScaleMeanVarianceKwargs`\",\"properties\":{\"reference_tensor\":{\"description\":\"Name of tensor to match.\",\"maxLength\":32,\"minLength\":1,\"title\":\"TensorId\",\"type\":\"string\"},\"axes\":{\"anyOf\":[{\"items\":{\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The subset of axes to normalize jointly, i.e. axes to reduce to compute mean/std.\\nFor example to normalize 'batch', 'x' and 'y' jointly in a tensor ('batch', 'channel', 'y', 'x')\\nresulting in a tensor of equal shape normalized per channel, specify `axes=('batch', 'x', 'y')`.\\nTo normalize samples independently, leave out the 'batch' axis.\\nDefault: Scale all axes jointly.\",\"examples\":[[\"batch\",\"x\",\"y\"]],\"title\":\"Axes\"},\"eps\":{\"default\":1e-06,\"description\":\"Epsilon for numeric stability:\\n`out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.`\",\"exclusiveMinimum\":0,\"maximum\":0.1,\"title\":\"Eps\",\"type\":\"number\"}},\"required\":[\"reference_tensor\"],\"title\":\"model.v0_5.ScaleMeanVarianceKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ScaleRangeDescr\":{\"additionalProperties\":false,\"description\":\"Scale with percentiles.\\n\\nExamples:\\n1. Scale linearly to map 5th percentile to 0 and 99.8th percentile to 1.0\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: scale_range\\n kwargs:\\n axes: ['y', 'x']\\n max_percentile: 99.8\\n min_percentile: 5.0\\n ```\\n - in Python\\n >>> preprocessing = [\\n ... ScaleRangeDescr(\\n ... kwargs=ScaleRangeKwargs(\\n ... axes= (AxisId('y'), AxisId('x')),\\n ... max_percentile= 99.8,\\n ... min_percentile= 5.0,\\n ... )\\n ... ),\\n ... ClipDescr(\\n ... kwargs=ClipKwargs(\\n ... min=0.0,\\n ... max=1.0,\\n ... )\\n ... ),\\n ... ]\\n\\n 2. Combine the above scaling with additional clipping to clip values outside the range given by the percentiles.\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: scale_range\\n kwargs:\\n axes: ['y', 'x']\\n max_percentile: 99.8\\n min_percentile: 5.0\\n - id: scale_range\\n - id: clip\\n kwargs:\\n min: 0.0\\n max: 1.0\\n ```\\n - in Python\\n >>> preprocessing = [ScaleRangeDescr(\\n ... kwargs=ScaleRangeKwargs(\\n ... axes= (AxisId('y'), AxisId('x')),\\n ... max_percentile= 99.8,\\n ... min_percentile= 5.0,\\n ... )\\n ... )]\",\"properties\":{\"id\":{\"const\":\"scale_range\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeKwargs\"}},\"required\":[\"id\",\"kwargs\"],\"title\":\"model.v0_5.ScaleRangeDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ScaleRangeKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ScaleRangeDescr`\\n\\nFor `min_percentile`=0.0 (the default) and `max_percentile`=100 (the default)\\nthis processing step normalizes data to the [0, 1] intervall.\\nFor other percentiles the normalized values will partially be outside the [0, 1]\\nintervall. Use `ScaleRange` followed by `ClipDescr` if you want to limit the\\nnormalized values to a range.\",\"properties\":{\"axes\":{\"anyOf\":[{\"items\":{\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The subset of axes to normalize jointly, i.e. axes to reduce to compute the min/max percentile value.\\nFor example to normalize 'batch', 'x' and 'y' jointly in a tensor ('batch', 'channel', 'y', 'x')\\nresulting in a tensor of equal shape normalized per channel, specify `axes=('batch', 'x', 'y')`.\\nTo normalize samples independently, leave out the \\\"batch\\\" axis.\\nDefault: Scale all axes jointly.\",\"examples\":[[\"batch\",\"x\",\"y\"]],\"title\":\"Axes\"},\"min_percentile\":{\"default\":0.0,\"description\":\"The lower percentile used to determine the value to align with zero.\",\"exclusiveMaximum\":100,\"minimum\":0,\"title\":\"Min Percentile\",\"type\":\"number\"},\"max_percentile\":{\"default\":100.0,\"description\":\"The upper percentile used to determine the value to align with one.\\nHas to be bigger than `min_percentile`.\\nThe range is 1 to 100 instead of 0 to 100 to avoid mistakenly\\naccepting percentiles specified in the range 0.0 to 1.0.\",\"exclusiveMinimum\":1,\"maximum\":100,\"title\":\"Max Percentile\",\"type\":\"number\"},\"eps\":{\"default\":1e-06,\"description\":\"Epsilon for numeric stability.\\n`out = (tensor - v_lower) / (v_upper - v_lower + eps)`;\\nwith `v_lower,v_upper` values at the respective percentiles.\",\"exclusiveMinimum\":0,\"maximum\":0.1,\"title\":\"Eps\",\"type\":\"number\"},\"reference_tensor\":{\"anyOf\":[{\"maxLength\":32,\"minLength\":1,\"title\":\"TensorId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Tensor ID to compute the percentiles from. Default: The tensor itself.\\nFor any tensor in `inputs` only input tensor references are allowed.\",\"title\":\"Reference Tensor\"}},\"title\":\"model.v0_5.ScaleRangeKwargs\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__SigmoidDescr\":{\"additionalProperties\":false,\"description\":\"The logistic sigmoid funciton, a.k.a. expit function.\\n\\nExamples:\\n- in YAML\\n ```yaml\\n postprocessing:\\n - id: sigmoid\\n ```\\n- in Python:\\n >>> postprocessing = [SigmoidDescr()]\",\"properties\":{\"id\":{\"const\":\"sigmoid\",\"title\":\"Id\",\"type\":\"string\"}},\"required\":[\"id\"],\"title\":\"model.v0_5.SigmoidDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__TensorflowJsWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The multi-file weights.\\nAll required files/folders should be a zip archive.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"comment\":{\"default\":\"\",\"description\":\"A comment about this weights entry, for example how these weights were created.\",\"title\":\"Comment\",\"type\":\"string\"},\"tensorflow_version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"Version of the TensorFlow library used.\"}},\"required\":[\"source\",\"tensorflow_version\"],\"title\":\"model.v0_5.TensorflowJsWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__TensorflowSavedModelBundleWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"The multi-file weights.\\nAll required files/folders should be a zip archive.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"comment\":{\"default\":\"\",\"description\":\"A comment about this weights entry, for example how these weights were created.\",\"title\":\"Comment\",\"type\":\"string\"},\"tensorflow_version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"Version of the TensorFlow library used.\"},\"dependencies\":{\"anyOf\":[{\"$ref\":\"#/$defs/FileDescr\",\"examples\":[{\"source\":\"environment.yaml\"}]},{\"type\":\"null\"}],\"default\":null,\"description\":\"Custom dependencies beyond tensorflow.\\nShould include tensorflow and any version pinning has to be compatible with **tensorflow_version**.\"}},\"required\":[\"source\",\"tensorflow_version\"],\"title\":\"model.v0_5.TensorflowSavedModelBundleWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__TorchscriptWeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"description\":\"Source of the weights file.\",\"title\":\"Source\"},\"sha256\":{\"anyOf\":[{\"description\":\"A SHA-256 hash value\",\"maxLength\":64,\"minLength\":64,\"title\":\"Sha256\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"SHA256 hash value of the **source** file.\",\"title\":\"Sha256\"},\"authors\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Authors\\nEither the person(s) that have trained this model resulting in the original weights file.\\n (If this is the initial weights entry, i.e. it does not have a `parent`)\\nOr the person(s) who have converted the weights to this weights format.\\n (If this is a child weight, i.e. it has a `parent` field)\",\"title\":\"Authors\"},\"parent\":{\"anyOf\":[{\"enum\":[\"keras_hdf5\",\"onnx\",\"pytorch_state_dict\",\"tensorflow_js\",\"tensorflow_saved_model_bundle\",\"torchscript\"],\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The source weights these weights were converted from.\\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\\nAll weight entries except one (the initial set of weights resulting from training the model),\\nneed to have this field.\",\"examples\":[\"pytorch_state_dict\"],\"title\":\"Parent\"},\"comment\":{\"default\":\"\",\"description\":\"A comment about this weights entry, for example how these weights were created.\",\"title\":\"Comment\",\"type\":\"string\"},\"pytorch_version\":{\"$ref\":\"#/$defs/Version\",\"description\":\"Version of the PyTorch library used.\"}},\"required\":[\"source\",\"pytorch_version\"],\"title\":\"model.v0_5.TorchscriptWeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__WeightsDescr\":{\"additionalProperties\":false,\"properties\":{\"keras_hdf5\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__KerasHdf5WeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"onnx\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__OnnxWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"pytorch_state_dict\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__PytorchStateDictWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"tensorflow_js\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__TensorflowJsWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"tensorflow_saved_model_bundle\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__TensorflowSavedModelBundleWeightsDescr\"},{\"type\":\"null\"}],\"default\":null},\"torchscript\":{\"anyOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__TorchscriptWeightsDescr\"},{\"type\":\"null\"}],\"default\":null}},\"title\":\"model.v0_5.WeightsDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr\":{\"additionalProperties\":false,\"description\":\"Subtract mean and divide by variance.\\n\\nExamples:\\n Subtract tensor mean and variance\\n - in YAML\\n ```yaml\\n preprocessing:\\n - id: zero_mean_unit_variance\\n ```\\n - in Python\\n >>> preprocessing = [ZeroMeanUnitVarianceDescr()]\",\"properties\":{\"id\":{\"const\":\"zero_mean_unit_variance\",\"title\":\"Id\",\"type\":\"string\"},\"kwargs\":{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceKwargs\"}},\"required\":[\"id\"],\"title\":\"model.v0_5.ZeroMeanUnitVarianceDescr\",\"type\":\"object\"},\"bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceKwargs\":{\"additionalProperties\":false,\"description\":\"key word arguments for `ZeroMeanUnitVarianceDescr`\",\"properties\":{\"axes\":{\"anyOf\":[{\"items\":{\"maxLength\":16,\"minLength\":1,\"title\":\"AxisId\",\"type\":\"string\"},\"type\":\"array\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The subset of axes to normalize jointly, i.e. axes to reduce to compute mean/std.\\nFor example to normalize 'batch', 'x' and 'y' jointly in a tensor ('batch', 'channel', 'y', 'x')\\nresulting in a tensor of equal shape normalized per channel, specify `axes=('batch', 'x', 'y')`.\\nTo normalize each sample independently leave out the 'batch' axis.\\nDefault: Scale all axes jointly.\",\"examples\":[[\"batch\",\"x\",\"y\"]],\"title\":\"Axes\"},\"eps\":{\"default\":1e-06,\"description\":\"epsilon for numeric stability: `out = (tensor - mean) / (std + eps)`.\",\"exclusiveMinimum\":0,\"maximum\":0.1,\"title\":\"Eps\",\"type\":\"number\"}},\"title\":\"model.v0_5.ZeroMeanUnitVarianceKwargs\",\"type\":\"object\"},\"bioimageio__spec__notebook__v0_2__NotebookDescr\":{\"additionalProperties\":false,\"description\":\"Bioimage.io description of a Jupyter Notebook.\",\"properties\":{\"name\":{\"description\":\"A human-friendly name of the resource description\",\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":1,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of the RDF and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Author\"},\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"anyOf\":[{\"$ref\":\"#/$defs/AttachmentsDescr\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"file and other attachments\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry\"},\"title\":\"Cite\",\"type\":\"array\"},\"config\":{\"additionalProperties\":{\"$ref\":\"#/$defs/YamlValue\"},\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a github repo URL in `config` since we already have the\\n`git_repo` field defined in the spec.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n bioimageio: # here is the domain name\\n my_custom_key: 3837283\\n another_key:\\n nested: value\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files)\",\"examples\":[{\"bioimageio\":{\"another_key\":{\"nested\":\"value\"},\"my_custom_key\":3837283},\"imagej\":{\"macro_dir\":\"path/to/macro/file\"}}],\"title\":\"Config\",\"type\":\"object\"},\"download_url\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL to download the resource from (deprecated)\",\"title\":\"Download Url\"},\"git_repo\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_2__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"rdf_source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\\nDo not set this field in a YAML file.\",\"title\":\"Rdf Source\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"version_number\":{\"anyOf\":[{\"type\":\"integer\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"version number (n-th published version, not the semantic version)\",\"title\":\"Version Number\"},\"format_version\":{\"const\":\"0.2.4\",\"description\":\"The format version of this resource specification\\n(not the `version` of the resource description)\\nWhen creating a new resource always use the latest micro/patch version described here.\\nThe `format_version` is important for any consumer software to understand how to parse the fields.\",\"title\":\"Format Version\",\"type\":\"string\"},\"badges\":{\"description\":\"badges associated with this resource\",\"items\":{\"$ref\":\"#/$defs/BadgeDescr\"},\"title\":\"Badges\",\"type\":\"array\"},\"documentation\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or relative path to a markdown file with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\",\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"],\"title\":\"Documentation\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"},{\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\\n) to discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"type\":{\"const\":\"notebook\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"NotebookId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"}],\"description\":\"The Jupyter notebook\",\"title\":\"Source\"}},\"required\":[\"name\",\"description\",\"format_version\",\"type\",\"source\"],\"title\":\"notebook 0.2.4\",\"type\":\"object\"},\"bioimageio__spec__notebook__v0_3__NotebookDescr\":{\"additionalProperties\":false,\"description\":\"Bioimage.io description of a Jupyter notebook.\",\"properties\":{\"name\":{\"description\":\"A human-friendly name of the resource description.\\nMay only contains letters, digits, underscore, minus, parentheses and spaces.\",\"maxLength\":128,\"minLength\":1,\"title\":\"Name\",\"type\":\"string\"},\"description\":{\"description\":\"A string containing a brief description.\",\"maxLength\":1024,\"title\":\"Description\",\"type\":\"string\"},\"covers\":{\"description\":\"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')\",\"examples\":[[\"cover.png\"]],\"items\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}]},\"title\":\"Covers\",\"type\":\"array\"},\"id_emoji\":{\"anyOf\":[{\"examples\":[\"\\ud83e\\udd88\",\"\\ud83e\\udda5\"],\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"UTF-8 emoji for display alongside the `id`.\",\"title\":\"Id Emoji\"},\"authors\":{\"description\":\"The authors are the creators of this resource description and the primary points of contact.\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Author\"},\"minItems\":1,\"title\":\"Authors\",\"type\":\"array\"},\"attachments\":{\"description\":\"file attachments\",\"items\":{\"$ref\":\"#/$defs/FileDescr\"},\"title\":\"Attachments\",\"type\":\"array\"},\"cite\":{\"description\":\"citations\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry\"},\"minItems\":1,\"title\":\"Cite\",\"type\":\"array\"},\"license\":{\"anyOf\":[{\"enum\":[\"0BSD\",\"AAL\",\"Abstyles\",\"AdaCore-doc\",\"Adobe-2006\",\"Adobe-Display-PostScript\",\"Adobe-Glyph\",\"Adobe-Utopia\",\"ADSL\",\"AFL-1.1\",\"AFL-1.2\",\"AFL-2.0\",\"AFL-2.1\",\"AFL-3.0\",\"Afmparse\",\"AGPL-1.0-only\",\"AGPL-1.0-or-later\",\"AGPL-3.0-only\",\"AGPL-3.0-or-later\",\"Aladdin\",\"AMDPLPA\",\"AML\",\"AML-glslang\",\"AMPAS\",\"ANTLR-PD\",\"ANTLR-PD-fallback\",\"Apache-1.0\",\"Apache-1.1\",\"Apache-2.0\",\"APAFML\",\"APL-1.0\",\"App-s2p\",\"APSL-1.0\",\"APSL-1.1\",\"APSL-1.2\",\"APSL-2.0\",\"Arphic-1999\",\"Artistic-1.0\",\"Artistic-1.0-cl8\",\"Artistic-1.0-Perl\",\"Artistic-2.0\",\"ASWF-Digital-Assets-1.0\",\"ASWF-Digital-Assets-1.1\",\"Baekmuk\",\"Bahyph\",\"Barr\",\"bcrypt-Solar-Designer\",\"Beerware\",\"Bitstream-Charter\",\"Bitstream-Vera\",\"BitTorrent-1.0\",\"BitTorrent-1.1\",\"blessing\",\"BlueOak-1.0.0\",\"Boehm-GC\",\"Borceux\",\"Brian-Gladman-2-Clause\",\"Brian-Gladman-3-Clause\",\"BSD-1-Clause\",\"BSD-2-Clause\",\"BSD-2-Clause-Darwin\",\"BSD-2-Clause-Patent\",\"BSD-2-Clause-Views\",\"BSD-3-Clause\",\"BSD-3-Clause-acpica\",\"BSD-3-Clause-Attribution\",\"BSD-3-Clause-Clear\",\"BSD-3-Clause-flex\",\"BSD-3-Clause-HP\",\"BSD-3-Clause-LBNL\",\"BSD-3-Clause-Modification\",\"BSD-3-Clause-No-Military-License\",\"BSD-3-Clause-No-Nuclear-License\",\"BSD-3-Clause-No-Nuclear-License-2014\",\"BSD-3-Clause-No-Nuclear-Warranty\",\"BSD-3-Clause-Open-MPI\",\"BSD-3-Clause-Sun\",\"BSD-4-Clause\",\"BSD-4-Clause-Shortened\",\"BSD-4-Clause-UC\",\"BSD-4.3RENO\",\"BSD-4.3TAHOE\",\"BSD-Advertising-Acknowledgement\",\"BSD-Attribution-HPND-disclaimer\",\"BSD-Inferno-Nettverk\",\"BSD-Protection\",\"BSD-Source-beginning-file\",\"BSD-Source-Code\",\"BSD-Systemics\",\"BSD-Systemics-W3Works\",\"BSL-1.0\",\"BUSL-1.1\",\"bzip2-1.0.6\",\"C-UDA-1.0\",\"CAL-1.0\",\"CAL-1.0-Combined-Work-Exception\",\"Caldera\",\"Caldera-no-preamble\",\"CATOSL-1.1\",\"CC-BY-1.0\",\"CC-BY-2.0\",\"CC-BY-2.5\",\"CC-BY-2.5-AU\",\"CC-BY-3.0\",\"CC-BY-3.0-AT\",\"CC-BY-3.0-AU\",\"CC-BY-3.0-DE\",\"CC-BY-3.0-IGO\",\"CC-BY-3.0-NL\",\"CC-BY-3.0-US\",\"CC-BY-4.0\",\"CC-BY-NC-1.0\",\"CC-BY-NC-2.0\",\"CC-BY-NC-2.5\",\"CC-BY-NC-3.0\",\"CC-BY-NC-3.0-DE\",\"CC-BY-NC-4.0\",\"CC-BY-NC-ND-1.0\",\"CC-BY-NC-ND-2.0\",\"CC-BY-NC-ND-2.5\",\"CC-BY-NC-ND-3.0\",\"CC-BY-NC-ND-3.0-DE\",\"CC-BY-NC-ND-3.0-IGO\",\"CC-BY-NC-ND-4.0\",\"CC-BY-NC-SA-1.0\",\"CC-BY-NC-SA-2.0\",\"CC-BY-NC-SA-2.0-DE\",\"CC-BY-NC-SA-2.0-FR\",\"CC-BY-NC-SA-2.0-UK\",\"CC-BY-NC-SA-2.5\",\"CC-BY-NC-SA-3.0\",\"CC-BY-NC-SA-3.0-DE\",\"CC-BY-NC-SA-3.0-IGO\",\"CC-BY-NC-SA-4.0\",\"CC-BY-ND-1.0\",\"CC-BY-ND-2.0\",\"CC-BY-ND-2.5\",\"CC-BY-ND-3.0\",\"CC-BY-ND-3.0-DE\",\"CC-BY-ND-4.0\",\"CC-BY-SA-1.0\",\"CC-BY-SA-2.0\",\"CC-BY-SA-2.0-UK\",\"CC-BY-SA-2.1-JP\",\"CC-BY-SA-2.5\",\"CC-BY-SA-3.0\",\"CC-BY-SA-3.0-AT\",\"CC-BY-SA-3.0-DE\",\"CC-BY-SA-3.0-IGO\",\"CC-BY-SA-4.0\",\"CC-PDDC\",\"CC0-1.0\",\"CDDL-1.0\",\"CDDL-1.1\",\"CDL-1.0\",\"CDLA-Permissive-1.0\",\"CDLA-Permissive-2.0\",\"CDLA-Sharing-1.0\",\"CECILL-1.0\",\"CECILL-1.1\",\"CECILL-2.0\",\"CECILL-2.1\",\"CECILL-B\",\"CECILL-C\",\"CERN-OHL-1.1\",\"CERN-OHL-1.2\",\"CERN-OHL-P-2.0\",\"CERN-OHL-S-2.0\",\"CERN-OHL-W-2.0\",\"CFITSIO\",\"check-cvs\",\"checkmk\",\"ClArtistic\",\"Clips\",\"CMU-Mach\",\"CMU-Mach-nodoc\",\"CNRI-Jython\",\"CNRI-Python\",\"CNRI-Python-GPL-Compatible\",\"COIL-1.0\",\"Community-Spec-1.0\",\"Condor-1.1\",\"copyleft-next-0.3.0\",\"copyleft-next-0.3.1\",\"Cornell-Lossless-JPEG\",\"CPAL-1.0\",\"CPL-1.0\",\"CPOL-1.02\",\"Cronyx\",\"Crossword\",\"CrystalStacker\",\"CUA-OPL-1.0\",\"Cube\",\"curl\",\"D-FSL-1.0\",\"DEC-3-Clause\",\"diffmark\",\"DL-DE-BY-2.0\",\"DL-DE-ZERO-2.0\",\"DOC\",\"Dotseqn\",\"DRL-1.0\",\"DRL-1.1\",\"DSDP\",\"dtoa\",\"dvipdfm\",\"ECL-1.0\",\"ECL-2.0\",\"EFL-1.0\",\"EFL-2.0\",\"eGenix\",\"Elastic-2.0\",\"Entessa\",\"EPICS\",\"EPL-1.0\",\"EPL-2.0\",\"ErlPL-1.1\",\"etalab-2.0\",\"EUDatagrid\",\"EUPL-1.0\",\"EUPL-1.1\",\"EUPL-1.2\",\"Eurosym\",\"Fair\",\"FBM\",\"FDK-AAC\",\"Ferguson-Twofish\",\"Frameworx-1.0\",\"FreeBSD-DOC\",\"FreeImage\",\"FSFAP\",\"FSFAP-no-warranty-disclaimer\",\"FSFUL\",\"FSFULLR\",\"FSFULLRWD\",\"FTL\",\"Furuseth\",\"fwlw\",\"GCR-docs\",\"GD\",\"GFDL-1.1-invariants-only\",\"GFDL-1.1-invariants-or-later\",\"GFDL-1.1-no-invariants-only\",\"GFDL-1.1-no-invariants-or-later\",\"GFDL-1.1-only\",\"GFDL-1.1-or-later\",\"GFDL-1.2-invariants-only\",\"GFDL-1.2-invariants-or-later\",\"GFDL-1.2-no-invariants-only\",\"GFDL-1.2-no-invariants-or-later\",\"GFDL-1.2-only\",\"GFDL-1.2-or-later\",\"GFDL-1.3-invariants-only\",\"GFDL-1.3-invariants-or-later\",\"GFDL-1.3-no-invariants-only\",\"GFDL-1.3-no-invariants-or-later\",\"GFDL-1.3-only\",\"GFDL-1.3-or-later\",\"Giftware\",\"GL2PS\",\"Glide\",\"Glulxe\",\"GLWTPL\",\"gnuplot\",\"GPL-1.0-only\",\"GPL-1.0-or-later\",\"GPL-2.0-only\",\"GPL-2.0-or-later\",\"GPL-3.0-only\",\"GPL-3.0-or-later\",\"Graphics-Gems\",\"gSOAP-1.3b\",\"gtkbook\",\"HaskellReport\",\"hdparm\",\"Hippocratic-2.1\",\"HP-1986\",\"HP-1989\",\"HPND\",\"HPND-DEC\",\"HPND-doc\",\"HPND-doc-sell\",\"HPND-export-US\",\"HPND-export-US-modify\",\"HPND-Fenneberg-Livingston\",\"HPND-INRIA-IMAG\",\"HPND-Kevlin-Henney\",\"HPND-Markus-Kuhn\",\"HPND-MIT-disclaimer\",\"HPND-Pbmplus\",\"HPND-sell-MIT-disclaimer-xserver\",\"HPND-sell-regexpr\",\"HPND-sell-variant\",\"HPND-sell-variant-MIT-disclaimer\",\"HPND-UC\",\"HTMLTIDY\",\"IBM-pibs\",\"ICU\",\"IEC-Code-Components-EULA\",\"IJG\",\"IJG-short\",\"ImageMagick\",\"iMatix\",\"Imlib2\",\"Info-ZIP\",\"Inner-Net-2.0\",\"Intel\",\"Intel-ACPI\",\"Interbase-1.0\",\"IPA\",\"IPL-1.0\",\"ISC\",\"ISC-Veillard\",\"Jam\",\"JasPer-2.0\",\"JPL-image\",\"JPNIC\",\"JSON\",\"Kastrup\",\"Kazlib\",\"Knuth-CTAN\",\"LAL-1.2\",\"LAL-1.3\",\"Latex2e\",\"Latex2e-translated-notice\",\"Leptonica\",\"LGPL-2.0-only\",\"LGPL-2.0-or-later\",\"LGPL-2.1-only\",\"LGPL-2.1-or-later\",\"LGPL-3.0-only\",\"LGPL-3.0-or-later\",\"LGPLLR\",\"Libpng\",\"libpng-2.0\",\"libselinux-1.0\",\"libtiff\",\"libutil-David-Nugent\",\"LiLiQ-P-1.1\",\"LiLiQ-R-1.1\",\"LiLiQ-Rplus-1.1\",\"Linux-man-pages-1-para\",\"Linux-man-pages-copyleft\",\"Linux-man-pages-copyleft-2-para\",\"Linux-man-pages-copyleft-var\",\"Linux-OpenIB\",\"LOOP\",\"LPD-document\",\"LPL-1.0\",\"LPL-1.02\",\"LPPL-1.0\",\"LPPL-1.1\",\"LPPL-1.2\",\"LPPL-1.3a\",\"LPPL-1.3c\",\"lsof\",\"Lucida-Bitmap-Fonts\",\"LZMA-SDK-9.11-to-9.20\",\"LZMA-SDK-9.22\",\"Mackerras-3-Clause\",\"Mackerras-3-Clause-acknowledgment\",\"magaz\",\"mailprio\",\"MakeIndex\",\"Martin-Birgmeier\",\"McPhee-slideshow\",\"metamail\",\"Minpack\",\"MirOS\",\"MIT\",\"MIT-0\",\"MIT-advertising\",\"MIT-CMU\",\"MIT-enna\",\"MIT-feh\",\"MIT-Festival\",\"MIT-Modern-Variant\",\"MIT-open-group\",\"MIT-testregex\",\"MIT-Wu\",\"MITNFA\",\"MMIXware\",\"Motosoto\",\"MPEG-SSG\",\"mpi-permissive\",\"mpich2\",\"MPL-1.0\",\"MPL-1.1\",\"MPL-2.0\",\"MPL-2.0-no-copyleft-exception\",\"mplus\",\"MS-LPL\",\"MS-PL\",\"MS-RL\",\"MTLL\",\"MulanPSL-1.0\",\"MulanPSL-2.0\",\"Multics\",\"Mup\",\"NAIST-2003\",\"NASA-1.3\",\"Naumen\",\"NBPL-1.0\",\"NCGL-UK-2.0\",\"NCSA\",\"Net-SNMP\",\"NetCDF\",\"Newsletr\",\"NGPL\",\"NICTA-1.0\",\"NIST-PD\",\"NIST-PD-fallback\",\"NIST-Software\",\"NLOD-1.0\",\"NLOD-2.0\",\"NLPL\",\"Nokia\",\"NOSL\",\"Noweb\",\"NPL-1.0\",\"NPL-1.1\",\"NPOSL-3.0\",\"NRL\",\"NTP\",\"NTP-0\",\"O-UDA-1.0\",\"OCCT-PL\",\"OCLC-2.0\",\"ODbL-1.0\",\"ODC-By-1.0\",\"OFFIS\",\"OFL-1.0\",\"OFL-1.0-no-RFN\",\"OFL-1.0-RFN\",\"OFL-1.1\",\"OFL-1.1-no-RFN\",\"OFL-1.1-RFN\",\"OGC-1.0\",\"OGDL-Taiwan-1.0\",\"OGL-Canada-2.0\",\"OGL-UK-1.0\",\"OGL-UK-2.0\",\"OGL-UK-3.0\",\"OGTSL\",\"OLDAP-1.1\",\"OLDAP-1.2\",\"OLDAP-1.3\",\"OLDAP-1.4\",\"OLDAP-2.0\",\"OLDAP-2.0.1\",\"OLDAP-2.1\",\"OLDAP-2.2\",\"OLDAP-2.2.1\",\"OLDAP-2.2.2\",\"OLDAP-2.3\",\"OLDAP-2.4\",\"OLDAP-2.5\",\"OLDAP-2.6\",\"OLDAP-2.7\",\"OLDAP-2.8\",\"OLFL-1.3\",\"OML\",\"OpenPBS-2.3\",\"OpenSSL\",\"OpenSSL-standalone\",\"OpenVision\",\"OPL-1.0\",\"OPL-UK-3.0\",\"OPUBL-1.0\",\"OSET-PL-2.1\",\"OSL-1.0\",\"OSL-1.1\",\"OSL-2.0\",\"OSL-2.1\",\"OSL-3.0\",\"PADL\",\"Parity-6.0.0\",\"Parity-7.0.0\",\"PDDL-1.0\",\"PHP-3.0\",\"PHP-3.01\",\"Pixar\",\"Plexus\",\"pnmstitch\",\"PolyForm-Noncommercial-1.0.0\",\"PolyForm-Small-Business-1.0.0\",\"PostgreSQL\",\"PSF-2.0\",\"psfrag\",\"psutils\",\"Python-2.0\",\"Python-2.0.1\",\"python-ldap\",\"Qhull\",\"QPL-1.0\",\"QPL-1.0-INRIA-2004\",\"radvd\",\"Rdisc\",\"RHeCos-1.1\",\"RPL-1.1\",\"RPL-1.5\",\"RPSL-1.0\",\"RSA-MD\",\"RSCPL\",\"Ruby\",\"SAX-PD\",\"SAX-PD-2.0\",\"Saxpath\",\"SCEA\",\"SchemeReport\",\"Sendmail\",\"Sendmail-8.23\",\"SGI-B-1.0\",\"SGI-B-1.1\",\"SGI-B-2.0\",\"SGI-OpenGL\",\"SGP4\",\"SHL-0.5\",\"SHL-0.51\",\"SimPL-2.0\",\"SISSL\",\"SISSL-1.2\",\"SL\",\"Sleepycat\",\"SMLNJ\",\"SMPPL\",\"SNIA\",\"snprintf\",\"softSurfer\",\"Soundex\",\"Spencer-86\",\"Spencer-94\",\"Spencer-99\",\"SPL-1.0\",\"ssh-keyscan\",\"SSH-OpenSSH\",\"SSH-short\",\"SSLeay-standalone\",\"SSPL-1.0\",\"SugarCRM-1.1.3\",\"Sun-PPP\",\"SunPro\",\"SWL\",\"swrule\",\"Symlinks\",\"TAPR-OHL-1.0\",\"TCL\",\"TCP-wrappers\",\"TermReadKey\",\"TGPPL-1.0\",\"TMate\",\"TORQUE-1.1\",\"TOSL\",\"TPDL\",\"TPL-1.0\",\"TTWL\",\"TTYP0\",\"TU-Berlin-1.0\",\"TU-Berlin-2.0\",\"UCAR\",\"UCL-1.0\",\"ulem\",\"UMich-Merit\",\"Unicode-3.0\",\"Unicode-DFS-2015\",\"Unicode-DFS-2016\",\"Unicode-TOU\",\"UnixCrypt\",\"Unlicense\",\"UPL-1.0\",\"URT-RLE\",\"Vim\",\"VOSTROM\",\"VSL-1.0\",\"W3C\",\"W3C-19980720\",\"W3C-20150513\",\"w3m\",\"Watcom-1.0\",\"Widget-Workshop\",\"Wsuipa\",\"WTFPL\",\"X11\",\"X11-distribute-modifications-variant\",\"Xdebug-1.03\",\"Xerox\",\"Xfig\",\"XFree86-1.1\",\"xinetd\",\"xkeyboard-config-Zinoviev\",\"xlock\",\"Xnet\",\"xpp\",\"XSkat\",\"YPL-1.0\",\"YPL-1.1\",\"Zed\",\"Zeeff\",\"Zend-2.0\",\"Zimbra-1.3\",\"Zimbra-1.4\",\"Zlib\",\"zlib-acknowledgement\",\"ZPL-1.1\",\"ZPL-2.0\",\"ZPL-2.1\"],\"title\":\"LicenseId\",\"type\":\"string\"},{\"enum\":[\"AGPL-1.0\",\"AGPL-3.0\",\"BSD-2-Clause-FreeBSD\",\"BSD-2-Clause-NetBSD\",\"bzip2-1.0.5\",\"eCos-2.0\",\"GFDL-1.1\",\"GFDL-1.2\",\"GFDL-1.3\",\"GPL-1.0\",\"GPL-1.0+\",\"GPL-2.0\",\"GPL-2.0+\",\"GPL-2.0-with-autoconf-exception\",\"GPL-2.0-with-bison-exception\",\"GPL-2.0-with-classpath-exception\",\"GPL-2.0-with-font-exception\",\"GPL-2.0-with-GCC-exception\",\"GPL-3.0\",\"GPL-3.0+\",\"GPL-3.0-with-autoconf-exception\",\"GPL-3.0-with-GCC-exception\",\"LGPL-2.0\",\"LGPL-2.0+\",\"LGPL-2.1\",\"LGPL-2.1+\",\"LGPL-3.0\",\"LGPL-3.0+\",\"Nunit\",\"StandardML-NJ\",\"wxWindows\"],\"title\":\"DeprecatedLicenseId\",\"type\":\"string\"}],\"description\":\"A [SPDX license identifier](https://spdx.org/licenses/).\\nWe do not support custom license beyond the SPDX license list, if you need that please\\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\\nto discuss your intentions with the community.\",\"examples\":[\"CC0-1.0\",\"MIT\",\"BSD-2-Clause\"],\"title\":\"License\"},\"git_repo\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"A URL to the Git repository where the resource is being developed.\",\"examples\":[\"https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad\"],\"title\":\"Git Repo\"},\"icon\":{\"anyOf\":[{\"maxLength\":2,\"minLength\":1,\"type\":\"string\"},{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"An icon for illustration, e.g. on bioimage.io\",\"title\":\"Icon\"},\"links\":{\"description\":\"IDs of other bioimage.io resources\",\"examples\":[[\"ilastik/ilastik\",\"deepimagej/deepimagej\",\"zero/notebook_u-net_3d_zerocostdl4mic\"]],\"items\":{\"type\":\"string\"},\"title\":\"Links\",\"type\":\"array\"},\"uploader\":{\"anyOf\":[{\"$ref\":\"#/$defs/Uploader\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The person who uploaded the model (e.g. to bioimage.io)\"},\"maintainers\":{\"description\":\"Maintainers of this resource.\\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name\",\"items\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Maintainer\"},\"title\":\"Maintainers\",\"type\":\"array\"},\"tags\":{\"description\":\"Associated tags\",\"examples\":[[\"unet2d\",\"pytorch\",\"nucleus\",\"segmentation\",\"dsb2018\"]],\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"type\":\"array\"},\"version\":{\"anyOf\":[{\"$ref\":\"#/$defs/Version\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The version of the resource following SemVer 2.0.\"},\"format_version\":{\"const\":\"0.3.0\",\"description\":\"The **format** version of this resource specification\",\"title\":\"Format Version\",\"type\":\"string\"},\"documentation\":{\"anyOf\":[{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"}],\"examples\":[\"https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md\",\"README.md\"]},{\"type\":\"null\"}],\"default\":null,\"description\":\"URL or relative path to a markdown file encoded in UTF-8 with additional documentation.\\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\",\"title\":\"Documentation\"},\"badges\":{\"description\":\"badges associated with this resource\",\"items\":{\"$ref\":\"#/$defs/BadgeDescr\"},\"title\":\"Badges\",\"type\":\"array\"},\"config\":{\"$ref\":\"#/$defs/bioimageio__spec__generic__v0_3__Config\",\"description\":\"A field for custom configuration that can contain any keys not present in the RDF spec.\\nThis means you should not store, for example, a GitHub repo URL in `config` since there is a `git_repo` field.\\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\\nfor example:\\n```yaml\\nconfig:\\n giraffe_neckometer: # here is the domain name\\n length: 3837283\\n address:\\n home: zoo\\n imagej: # config specific to ImageJ\\n macro_dir: path/to/macro/file\\n```\\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource.\\n(Packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\\nan altered rdf.yaml file with local references to the downloaded files.)\"},\"type\":{\"const\":\"notebook\",\"title\":\"Type\",\"type\":\"string\"},\"id\":{\"anyOf\":[{\"minLength\":1,\"title\":\"NotebookId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"bioimage.io-wide unique resource identifier\\nassigned by bioimage.io; version **un**specific.\",\"title\":\"Id\"},\"parent\":{\"anyOf\":[{\"minLength\":1,\"title\":\"NotebookId\",\"type\":\"string\"},{\"type\":\"null\"}],\"default\":null,\"description\":\"The description from which this one is derived\",\"title\":\"Parent\"},\"source\":{\"anyOf\":[{\"description\":\"A URL with the HTTP or HTTPS scheme.\",\"format\":\"uri\",\"maxLength\":2083,\"minLength\":1,\"title\":\"HttpUrl\",\"type\":\"string\"},{\"format\":\"file-path\",\"title\":\"FilePath\",\"type\":\"string\"},{\"$ref\":\"#/$defs/RelativeFilePath\"}],\"description\":\"The Jupyter notebook\",\"title\":\"Source\"}},\"required\":[\"name\",\"description\",\"authors\",\"cite\",\"license\",\"format_version\",\"type\",\"source\"],\"title\":\"notebook 0.3.0\",\"type\":\"object\"}},\"discriminator\":{\"mapping\":{\"application\":{\"discriminator\":{\"mapping\":{\"0.2.4\":\"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr\",\"0.3.0\":\"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr\",\"title\":\"application 0.2\"},{\"$ref\":\"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr\",\"title\":\"application 0.3\"}],\"title\":\"application\"},\"dataset\":{\"discriminator\":{\"mapping\":{\"0.2.4\":\"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr\",\"0.3.0\":\"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr\",\"title\":\"dataset 0.2\"},{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr\",\"title\":\"dataset 0.3\"}],\"title\":\"dataset\"},\"model\":{\"discriminator\":{\"mapping\":{\"0.4.10\":\"#/$defs/bioimageio__spec__model__v0_4__ModelDescr\",\"0.5.4\":\"#/$defs/bioimageio__spec__model__v0_5__ModelDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ModelDescr\",\"title\":\"model 0.4\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ModelDescr\",\"title\":\"model 0.5\"}],\"title\":\"model\"},\"notebook\":{\"discriminator\":{\"mapping\":{\"0.2.4\":\"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr\",\"0.3.0\":\"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr\",\"title\":\"notebook 0.2\"},{\"$ref\":\"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr\",\"title\":\"notebook 0.3\"}],\"title\":\"notebook\"}},\"propertyName\":\"type\"},\"oneOf\":[{\"discriminator\":{\"mapping\":{\"0.2.4\":\"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr\",\"0.3.0\":\"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr\",\"title\":\"application 0.2\"},{\"$ref\":\"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr\",\"title\":\"application 0.3\"}],\"title\":\"application\"},{\"discriminator\":{\"mapping\":{\"0.2.4\":\"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr\",\"0.3.0\":\"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr\",\"title\":\"dataset 0.2\"},{\"$ref\":\"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr\",\"title\":\"dataset 0.3\"}],\"title\":\"dataset\"},{\"discriminator\":{\"mapping\":{\"0.4.10\":\"#/$defs/bioimageio__spec__model__v0_4__ModelDescr\",\"0.5.4\":\"#/$defs/bioimageio__spec__model__v0_5__ModelDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_4__ModelDescr\",\"title\":\"model 0.4\"},{\"$ref\":\"#/$defs/bioimageio__spec__model__v0_5__ModelDescr\",\"title\":\"model 0.5\"}],\"title\":\"model\"},{\"discriminator\":{\"mapping\":{\"0.2.4\":\"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr\",\"0.3.0\":\"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr\"},\"propertyName\":\"format_version\"},\"oneOf\":[{\"$ref\":\"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr\",\"title\":\"notebook 0.2\"},{\"$ref\":\"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr\",\"title\":\"notebook 0.3\"}],\"title\":\"notebook\"}]}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"bioimageio_schema_latest\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$defs":{"ArchitectureFromFileDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"Architecture source file","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"callable":{"description":"Identifier of the callable that returns a torch.nn.Module instance.","examples":["MyNetworkClass","get_my_model"],"minLength":1,"title":"Identifier","type":"string"},"kwargs":{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"description":"key word arguments for the `callable`","title":"Kwargs","type":"object"}},"required":["source","callable"],"title":"model.v0_5.ArchitectureFromFileDescr","type":"object"},"ArchitectureFromLibraryDescr":{"additionalProperties":false,"properties":{"callable":{"description":"Identifier of the callable that returns a torch.nn.Module instance.","examples":["MyNetworkClass","get_my_model"],"minLength":1,"title":"Identifier","type":"string"},"kwargs":{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"description":"key word arguments for the `callable`","title":"Kwargs","type":"object"},"import_from":{"description":"Where to import the callable from, i.e. `from <import_from> import <callable>`","title":"Import From","type":"string"}},"required":["callable","import_from"],"title":"model.v0_5.ArchitectureFromLibraryDescr","type":"object"},"AttachmentsDescr":{"additionalProperties":true,"properties":{"files":{"description":"File attachments","items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Files","type":"array"}},"title":"generic.v0_2.AttachmentsDescr","type":"object"},"BadgeDescr":{"additionalProperties":false,"description":"A custom badge","properties":{"label":{"description":"badge label to display on hover","examples":["Open in Colab"],"title":"Label","type":"string"},"icon":{"anyOf":[{"format":"file-path","title":"FilePath","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"format":"uri","maxLength":2083,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"badge icon (included in bioimage.io package if not a URL)","examples":["https://colab.research.google.com/assets/colab-badge.svg"],"title":"Icon"},"url":{"description":"target URL","examples":["https://colab.research.google.com/github/HenriquesLab/ZeroCostDL4Mic/blob/master/Colab_notebooks/U-net_2D_ZeroCostDL4Mic.ipynb"],"format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"}},"required":["label","url"],"title":"generic.v0_2.BadgeDescr","type":"object"},"BatchAxis":{"additionalProperties":false,"properties":{"id":{"default":"batch","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"batch","title":"Type","type":"string"},"size":{"anyOf":[{"const":1,"type":"integer"},{"type":"null"}],"default":null,"description":"The batch size may be fixed to 1,\notherwise (the default) it may be chosen arbitrarily depending on available memory","title":"Size"}},"required":["type"],"title":"model.v0_5.BatchAxis","type":"object"},"BinarizeAlongAxisKwargs":{"additionalProperties":false,"description":"key word arguments for `BinarizeDescr`","properties":{"threshold":{"description":"The fixed threshold values along `axis`","items":{"type":"number"},"minItems":1,"title":"Threshold","type":"array"},"axis":{"description":"The `threshold` axis","examples":["channel"],"maxLength":16,"minLength":1,"title":"AxisId","type":"string"}},"required":["threshold","axis"],"title":"model.v0_5.BinarizeAlongAxisKwargs","type":"object"},"ChannelAxis":{"additionalProperties":false,"properties":{"id":{"default":"channel","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"channel","title":"Type","type":"string"},"channel_names":{"items":{"minLength":1,"title":"Identifier","type":"string"},"minItems":1,"title":"Channel Names","type":"array"}},"required":["type","channel_names"],"title":"model.v0_5.ChannelAxis","type":"object"},"ClipKwargs":{"additionalProperties":false,"description":"key word arguments for `ClipDescr`","properties":{"min":{"description":"minimum value for clipping","title":"Min","type":"number"},"max":{"description":"maximum value for clipping","title":"Max","type":"number"}},"required":["min","max"],"title":"model.v0_4.ClipKwargs","type":"object"},"DataDependentSize":{"additionalProperties":false,"properties":{"min":{"default":1,"exclusiveMinimum":0,"title":"Min","type":"integer"},"max":{"anyOf":[{"exclusiveMinimum":1,"type":"integer"},{"type":"null"}],"default":null,"title":"Max"}},"title":"model.v0_5.DataDependentSize","type":"object"},"Datetime":{"description":"Timestamp in [ISO 8601](#https://en.wikipedia.org/wiki/ISO_8601) format\nwith a few restrictions listed [here](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat).","format":"date-time","title":"Datetime","type":"string"},"EnsureDtypeDescr":{"additionalProperties":false,"description":"Cast the tensor data type to `EnsureDtypeKwargs.dtype` (if not matching).\n\nThis can for example be used to ensure the inner neural network model gets a\ndifferent input tensor data type than the fully described bioimage.io model does.\n\nExamples:\n The described bioimage.io model (incl. preprocessing) accepts any\n float32-compatible tensor, normalizes it with percentiles and clipping and then\n casts it to uint8, which is what the neural network in this example expects.\n - in YAML\n ```yaml\n inputs:\n - data:\n type: float32 # described bioimage.io model is compatible with any float32 input tensor\n preprocessing:\n - id: scale_range\n kwargs:\n axes: ['y', 'x']\n max_percentile: 99.8\n min_percentile: 5.0\n - id: clip\n kwargs:\n min: 0.0\n max: 1.0\n - id: ensure_dtype # the neural network of the model requires uint8\n kwargs:\n dtype: uint8\n ```\n - in Python:\n >>> preprocessing = [\n ... ScaleRangeDescr(\n ... kwargs=ScaleRangeKwargs(\n ... axes= (AxisId('y'), AxisId('x')),\n ... max_percentile= 99.8,\n ... min_percentile= 5.0,\n ... )\n ... ),\n ... ClipDescr(kwargs=ClipKwargs(min=0.0, max=1.0)),\n ... EnsureDtypeDescr(kwargs=EnsureDtypeKwargs(dtype=\"uint8\")),\n ... ]","properties":{"id":{"const":"ensure_dtype","title":"Id","type":"string"},"kwargs":{"$ref":"#/$defs/EnsureDtypeKwargs"}},"required":["id","kwargs"],"title":"model.v0_5.EnsureDtypeDescr","type":"object"},"EnsureDtypeKwargs":{"additionalProperties":false,"description":"key word arguments for `EnsureDtypeDescr`","properties":{"dtype":{"enum":["float32","float64","uint8","int8","uint16","int16","uint32","int32","uint64","int64","bool"],"title":"Dtype","type":"string"}},"required":["dtype"],"title":"model.v0_5.EnsureDtypeKwargs","type":"object"},"FileDescr":{"additionalProperties":false,"description":"A file description","properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"File source","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"}},"required":["source"],"title":"_internal.io.FileDescr","type":"object"},"FixedZeroMeanUnitVarianceAlongAxisKwargs":{"additionalProperties":false,"description":"key word arguments for `FixedZeroMeanUnitVarianceDescr`","properties":{"mean":{"description":"The mean value(s) to normalize with.","items":{"type":"number"},"minItems":1,"title":"Mean","type":"array"},"std":{"description":"The standard deviation value(s) to normalize with.\nSize must match `mean` values.","items":{"minimum":1e-06,"type":"number"},"minItems":1,"title":"Std","type":"array"},"axis":{"description":"The axis of the mean/std values to normalize each entry along that dimension\nseparately.","examples":["channel","index"],"maxLength":16,"minLength":1,"title":"AxisId","type":"string"}},"required":["mean","std","axis"],"title":"model.v0_5.FixedZeroMeanUnitVarianceAlongAxisKwargs","type":"object"},"FixedZeroMeanUnitVarianceDescr":{"additionalProperties":false,"description":"Subtract a given mean and divide by the standard deviation.\n\nNormalize with fixed, precomputed values for\n`FixedZeroMeanUnitVarianceKwargs.mean` and `FixedZeroMeanUnitVarianceKwargs.std`\nUse `FixedZeroMeanUnitVarianceAlongAxisKwargs` for independent scaling along given\naxes.\n\nExamples:\n1. scalar value for whole tensor\n - in YAML\n ```yaml\n preprocessing:\n - id: fixed_zero_mean_unit_variance\n kwargs:\n mean: 103.5\n std: 13.7\n ```\n - in Python\n >>> preprocessing = [FixedZeroMeanUnitVarianceDescr(\n ... kwargs=FixedZeroMeanUnitVarianceKwargs(mean=103.5, std=13.7)\n ... )]\n\n2. independently along an axis\n - in YAML\n ```yaml\n preprocessing:\n - id: fixed_zero_mean_unit_variance\n kwargs:\n axis: channel\n mean: [101.5, 102.5, 103.5]\n std: [11.7, 12.7, 13.7]\n ```\n - in Python\n >>> preprocessing = [FixedZeroMeanUnitVarianceDescr(\n ... kwargs=FixedZeroMeanUnitVarianceAlongAxisKwargs(\n ... axis=AxisId(\"channel\"),\n ... mean=[101.5, 102.5, 103.5],\n ... std=[11.7, 12.7, 13.7],\n ... )\n ... )]","properties":{"id":{"const":"fixed_zero_mean_unit_variance","title":"Id","type":"string"},"kwargs":{"anyOf":[{"$ref":"#/$defs/FixedZeroMeanUnitVarianceKwargs"},{"$ref":"#/$defs/FixedZeroMeanUnitVarianceAlongAxisKwargs"}],"title":"Kwargs"}},"required":["id","kwargs"],"title":"model.v0_5.FixedZeroMeanUnitVarianceDescr","type":"object"},"FixedZeroMeanUnitVarianceKwargs":{"additionalProperties":false,"description":"key word arguments for `FixedZeroMeanUnitVarianceDescr`","properties":{"mean":{"description":"The mean value to normalize with.","title":"Mean","type":"number"},"std":{"description":"The standard deviation value to normalize with.","minimum":1e-06,"title":"Std","type":"number"}},"required":["mean","std"],"title":"model.v0_5.FixedZeroMeanUnitVarianceKwargs","type":"object"},"ImplicitOutputShape":{"additionalProperties":false,"description":"Output tensor shape depending on an input tensor shape.\n`shape(output_tensor) = shape(input_tensor) * scale + 2 * offset`","properties":{"reference_tensor":{"description":"Name of the reference tensor.","minLength":1,"title":"TensorName","type":"string"},"scale":{"description":"output_pix/input_pix for each dimension.\n'null' values indicate new dimensions, whose length is defined by 2*`offset`","items":{"anyOf":[{"type":"number"},{"type":"null"}]},"minItems":1,"title":"Scale","type":"array"},"offset":{"description":"Position of origin wrt to input.","items":{"anyOf":[{"type":"integer"},{"multipleOf":0.5,"type":"number"}]},"minItems":1,"title":"Offset","type":"array"}},"required":["reference_tensor","scale","offset"],"title":"model.v0_4.ImplicitOutputShape","type":"object"},"IndexInputAxis":{"additionalProperties":false,"properties":{"size":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"$ref":"#/$defs/ParameterizedSize"},{"$ref":"#/$defs/SizeReference"}],"description":"The size/length of this axis can be specified as\n- fixed integer\n- parameterized series of valid sizes (`ParameterizedSize`)\n- reference to another axis with an optional offset (`SizeReference`)","examples":[10,{"min":32,"step":16},{"axis_id":"a","offset":5,"tensor_id":"t"}],"title":"Size"},"id":{"default":"index","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"index","title":"Type","type":"string"},"concatenable":{"default":false,"description":"If a model has a `concatenable` input axis, it can be processed blockwise,\nsplitting a longer sample axis into blocks matching its input tensor description.\nOutput axes are concatenable if they have a `SizeReference` to a concatenable\ninput axis.","title":"Concatenable","type":"boolean"}},"required":["size","type"],"title":"model.v0_5.IndexInputAxis","type":"object"},"IndexOutputAxis":{"additionalProperties":false,"properties":{"id":{"default":"index","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"index","title":"Type","type":"string"},"size":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"$ref":"#/$defs/SizeReference"},{"$ref":"#/$defs/DataDependentSize"}],"description":"The size/length of this axis can be specified as\n- fixed integer\n- reference to another axis with an optional offset (`SizeReference`)\n- data dependent size using `DataDependentSize` (size is only known after model inference)","examples":[10,{"axis_id":"a","offset":5,"tensor_id":"t"}],"title":"Size"}},"required":["type","size"],"title":"model.v0_5.IndexOutputAxis","type":"object"},"IntervalOrRatioDataDescr":{"additionalProperties":false,"properties":{"type":{"default":"float32","enum":["float32","float64","uint8","int8","uint16","int16","uint32","int32","uint64","int64"],"examples":["float32","float64","uint8","uint16"],"title":"Type","type":"string"},"range":{"default":[null,null],"description":"Tuple `(minimum, maximum)` specifying the allowed range of the data in this tensor.\n`None` corresponds to min/max of what can be expressed by **type**.","maxItems":2,"minItems":2,"prefixItems":[{"anyOf":[{"type":"number"},{"type":"null"}]},{"anyOf":[{"type":"number"},{"type":"null"}]}],"title":"Range","type":"array"},"unit":{"anyOf":[{"const":"arbitrary unit","type":"string"},{"description":"An SI unit","minLength":1,"pattern":"^(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\^[+-]?[1-9]\\d*)?((\u00b7(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\^[+-]?[1-9]\\d*)?)|(/(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\^+?[1-9]\\d*)?))*$","title":"SiUnit","type":"string"}],"default":"arbitrary unit","title":"Unit"},"scale":{"default":1.0,"description":"Scale for data on an interval (or ratio) scale.","title":"Scale","type":"number"},"offset":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null,"description":"Offset for data on a ratio scale.","title":"Offset"}},"title":"model.v0_5.IntervalOrRatioDataDescr","type":"object"},"NominalOrOrdinalDataDescr":{"additionalProperties":false,"properties":{"values":{"anyOf":[{"items":{"type":"integer"},"minItems":1,"type":"array"},{"items":{"type":"number"},"minItems":1,"type":"array"},{"items":{"type":"boolean"},"minItems":1,"type":"array"},{"items":{"type":"string"},"minItems":1,"type":"array"}],"description":"A fixed set of nominal or an ascending sequence of ordinal values.\nIn this case `data.type` is required to be an unsigend integer type, e.g. 'uint8'.\nString `values` are interpreted as labels for tensor values 0, ..., N.\nNote: as YAML 1.2 does not natively support a \"set\" datatype,\nnominal values should be given as a sequence (aka list/array) as well.","title":"Values"},"type":{"default":"uint8","enum":["float32","float64","uint8","int8","uint16","int16","uint32","int32","uint64","int64","bool"],"examples":["float32","uint8","uint16","int64","bool"],"title":"Type","type":"string"},"unit":{"anyOf":[{"const":"arbitrary unit","type":"string"},{"description":"An SI unit","minLength":1,"pattern":"^(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\^[+-]?[1-9]\\d*)?((\u00b7(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\^[+-]?[1-9]\\d*)?)|(/(Q|R|Y|Z|E|P|T|G|M|k|h|da|d|c|m|\u00b5|n|p|f|a|z|y|r|q)?(m|g|s|A|K|mol|cd|Hz|N|Pa|J|W|C|V|F|\u03a9|S|Wb|T|H|lm|lx|Bq|Gy|Sv|kat|l|L)(\\^+?[1-9]\\d*)?))*$","title":"SiUnit","type":"string"},{"type":"null"}],"default":null,"title":"Unit"}},"required":["values"],"title":"model.v0_5.NominalOrOrdinalDataDescr","type":"object"},"ParameterizedInputShape":{"additionalProperties":false,"description":"A sequence of valid shapes given by `shape_k = min + k * step for k in {0, 1, ...}`.","properties":{"min":{"description":"The minimum input shape","items":{"type":"integer"},"minItems":1,"title":"Min","type":"array"},"step":{"description":"The minimum shape change","items":{"type":"integer"},"minItems":1,"title":"Step","type":"array"}},"required":["min","step"],"title":"model.v0_4.ParameterizedInputShape","type":"object"},"ParameterizedSize":{"additionalProperties":false,"description":"Describes a range of valid tensor axis sizes as `size = min + n*step`.\n\n- **min** and **step** are given by the model description.\n- All blocksize paramters n = 0,1,2,... yield a valid `size`.\n- A greater blocksize paramter n = 0,1,2,... results in a greater **size**.\n This allows to adjust the axis size more generically.","properties":{"min":{"exclusiveMinimum":0,"title":"Min","type":"integer"},"step":{"exclusiveMinimum":0,"title":"Step","type":"integer"}},"required":["min","step"],"title":"model.v0_5.ParameterizedSize","type":"object"},"RelativeFilePath":{"description":"A path relative to the `rdf.yaml` file (also if the RDF source is a URL).","format":"path","title":"RelativeFilePath","type":"string"},"ReproducibilityTolerance":{"additionalProperties":true,"description":"Describes what small numerical differences -- if any -- may be tolerated\nin the generated output when executing in different environments.\n\nA tensor element *output* is considered mismatched to the **test_tensor** if\nabs(*output* - **test_tensor**) > **absolute_tolerance** + **relative_tolerance** * abs(**test_tensor**).\n(Internally we call [numpy.testing.assert_allclose](https://numpy.org/doc/stable/reference/generated/numpy.testing.assert_allclose.html).)\n\nMotivation:\n For testing we can request the respective deep learning frameworks to be as\n reproducible as possible by setting seeds and chosing deterministic algorithms,\n but differences in operating systems, available hardware and installed drivers\n may still lead to numerical differences.","properties":{"relative_tolerance":{"default":0.001,"description":"Maximum relative tolerance of reproduced test tensor.","maximum":0.01,"minimum":0,"title":"Relative Tolerance","type":"number"},"absolute_tolerance":{"default":0.0001,"description":"Maximum absolute tolerance of reproduced test tensor.","minimum":0,"title":"Absolute Tolerance","type":"number"},"mismatched_elements_per_million":{"default":100,"description":"Maximum number of mismatched elements/pixels per million to tolerate.","maximum":1000,"minimum":0,"title":"Mismatched Elements Per Million","type":"integer"},"output_ids":{"default":[],"description":"Limits the output tensor IDs these reproducibility details apply to.","items":{"maxLength":32,"minLength":1,"title":"TensorId","type":"string"},"title":"Output Ids","type":"array"},"weights_formats":{"default":[],"description":"Limits the weights formats these details apply to.","items":{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},"title":"Weights Formats","type":"array"}},"title":"model.v0_5.ReproducibilityTolerance","type":"object"},"RunMode":{"additionalProperties":false,"properties":{"name":{"anyOf":[{"const":"deepimagej","type":"string"},{"type":"string"}],"description":"Run mode name","title":"Name"},"kwargs":{"additionalProperties":true,"description":"Run mode specific key word arguments","title":"Kwargs","type":"object"}},"required":["name"],"title":"model.v0_4.RunMode","type":"object"},"ScaleLinearAlongAxisKwargs":{"additionalProperties":false,"description":"Key word arguments for `ScaleLinearDescr`","properties":{"axis":{"description":"The axis of gain and offset values.","examples":["channel"],"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"gain":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"minItems":1,"type":"array"}],"default":1.0,"description":"multiplicative factor","title":"Gain"},"offset":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"minItems":1,"type":"array"}],"default":0.0,"description":"additive term","title":"Offset"}},"required":["axis"],"title":"model.v0_5.ScaleLinearAlongAxisKwargs","type":"object"},"SizeReference":{"additionalProperties":false,"description":"A tensor axis size (extent in pixels/frames) defined in relation to a reference axis.\n\n`axis.size = reference.size * reference.scale / axis.scale + offset`\n\nNote:\n1. The axis and the referenced axis need to have the same unit (or no unit).\n2. Batch axes may not be referenced.\n3. Fractions are rounded down.\n4. If the reference axis is `concatenable` the referencing axis is assumed to be\n `concatenable` as well with the same block order.\n\nExample:\nAn unisotropic input image of w*h=100*49 pixels depicts a phsical space of 200*196mm\u00b2.\nLet's assume that we want to express the image height h in relation to its width w\ninstead of only accepting input images of exactly 100*49 pixels\n(for example to express a range of valid image shapes by parametrizing w, see `ParameterizedSize`).\n\n>>> w = SpaceInputAxis(id=AxisId(\"w\"), size=100, unit=\"millimeter\", scale=2)\n>>> h = SpaceInputAxis(\n... id=AxisId(\"h\"),\n... size=SizeReference(tensor_id=TensorId(\"input\"), axis_id=AxisId(\"w\"), offset=-1),\n... unit=\"millimeter\",\n... scale=4,\n... )\n>>> print(h.size.get_size(h, w))\n49\n\n\u21d2 h = w * w.scale / h.scale + offset = 100 * 2mm / 4mm - 1 = 49","properties":{"tensor_id":{"description":"tensor id of the reference axis","maxLength":32,"minLength":1,"title":"TensorId","type":"string"},"axis_id":{"description":"axis id of the reference axis","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"offset":{"default":0,"title":"Offset","type":"integer"}},"required":["tensor_id","axis_id"],"title":"model.v0_5.SizeReference","type":"object"},"SpaceInputAxis":{"additionalProperties":false,"properties":{"size":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"$ref":"#/$defs/ParameterizedSize"},{"$ref":"#/$defs/SizeReference"}],"description":"The size/length of this axis can be specified as\n- fixed integer\n- parameterized series of valid sizes (`ParameterizedSize`)\n- reference to another axis with an optional offset (`SizeReference`)","examples":[10,{"min":32,"step":16},{"axis_id":"a","offset":5,"tensor_id":"t"}],"title":"Size"},"id":{"default":"x","examples":["x","y","z"],"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"space","title":"Type","type":"string"},"unit":{"anyOf":[{"enum":["attometer","angstrom","centimeter","decimeter","exameter","femtometer","foot","gigameter","hectometer","inch","kilometer","megameter","meter","micrometer","mile","millimeter","nanometer","parsec","petameter","picometer","terameter","yard","yoctometer","yottameter","zeptometer","zettameter"],"type":"string"},{"type":"null"}],"default":null,"title":"Unit"},"scale":{"default":1.0,"exclusiveMinimum":0,"title":"Scale","type":"number"},"concatenable":{"default":false,"description":"If a model has a `concatenable` input axis, it can be processed blockwise,\nsplitting a longer sample axis into blocks matching its input tensor description.\nOutput axes are concatenable if they have a `SizeReference` to a concatenable\ninput axis.","title":"Concatenable","type":"boolean"}},"required":["size","type"],"title":"model.v0_5.SpaceInputAxis","type":"object"},"SpaceOutputAxis":{"additionalProperties":false,"properties":{"size":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"$ref":"#/$defs/SizeReference"}],"description":"The size/length of this axis can be specified as\n- fixed integer\n- reference to another axis with an optional offset (see `SizeReference`)","examples":[10,{"axis_id":"a","offset":5,"tensor_id":"t"}],"title":"Size"},"id":{"default":"x","examples":["x","y","z"],"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"space","title":"Type","type":"string"},"unit":{"anyOf":[{"enum":["attometer","angstrom","centimeter","decimeter","exameter","femtometer","foot","gigameter","hectometer","inch","kilometer","megameter","meter","micrometer","mile","millimeter","nanometer","parsec","petameter","picometer","terameter","yard","yoctometer","yottameter","zeptometer","zettameter"],"type":"string"},{"type":"null"}],"default":null,"title":"Unit"},"scale":{"default":1.0,"exclusiveMinimum":0,"title":"Scale","type":"number"}},"required":["size","type"],"title":"model.v0_5.SpaceOutputAxis","type":"object"},"SpaceOutputAxisWithHalo":{"additionalProperties":false,"properties":{"halo":{"description":"The halo should be cropped from the output tensor to avoid boundary effects.\nIt is to be cropped from both sides, i.e. `size_after_crop = size - 2 * halo`.\nTo document a halo that is already cropped by the model use `size.offset` instead.","minimum":1,"title":"Halo","type":"integer"},"size":{"$ref":"#/$defs/SizeReference","description":"reference to another axis with an optional offset (see `SizeReference`)","examples":[10,{"axis_id":"a","offset":5,"tensor_id":"t"}]},"id":{"default":"x","examples":["x","y","z"],"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"space","title":"Type","type":"string"},"unit":{"anyOf":[{"enum":["attometer","angstrom","centimeter","decimeter","exameter","femtometer","foot","gigameter","hectometer","inch","kilometer","megameter","meter","micrometer","mile","millimeter","nanometer","parsec","petameter","picometer","terameter","yard","yoctometer","yottameter","zeptometer","zettameter"],"type":"string"},{"type":"null"}],"default":null,"title":"Unit"},"scale":{"default":1.0,"exclusiveMinimum":0,"title":"Scale","type":"number"}},"required":["halo","size","type"],"title":"model.v0_5.SpaceOutputAxisWithHalo","type":"object"},"TimeInputAxis":{"additionalProperties":false,"properties":{"size":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"$ref":"#/$defs/ParameterizedSize"},{"$ref":"#/$defs/SizeReference"}],"description":"The size/length of this axis can be specified as\n- fixed integer\n- parameterized series of valid sizes (`ParameterizedSize`)\n- reference to another axis with an optional offset (`SizeReference`)","examples":[10,{"min":32,"step":16},{"axis_id":"a","offset":5,"tensor_id":"t"}],"title":"Size"},"id":{"default":"time","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"time","title":"Type","type":"string"},"unit":{"anyOf":[{"enum":["attosecond","centisecond","day","decisecond","exasecond","femtosecond","gigasecond","hectosecond","hour","kilosecond","megasecond","microsecond","millisecond","minute","nanosecond","petasecond","picosecond","second","terasecond","yoctosecond","yottasecond","zeptosecond","zettasecond"],"type":"string"},{"type":"null"}],"default":null,"title":"Unit"},"scale":{"default":1.0,"exclusiveMinimum":0,"title":"Scale","type":"number"},"concatenable":{"default":false,"description":"If a model has a `concatenable` input axis, it can be processed blockwise,\nsplitting a longer sample axis into blocks matching its input tensor description.\nOutput axes are concatenable if they have a `SizeReference` to a concatenable\ninput axis.","title":"Concatenable","type":"boolean"}},"required":["size","type"],"title":"model.v0_5.TimeInputAxis","type":"object"},"TimeOutputAxis":{"additionalProperties":false,"properties":{"size":{"anyOf":[{"exclusiveMinimum":0,"type":"integer"},{"$ref":"#/$defs/SizeReference"}],"description":"The size/length of this axis can be specified as\n- fixed integer\n- reference to another axis with an optional offset (see `SizeReference`)","examples":[10,{"axis_id":"a","offset":5,"tensor_id":"t"}],"title":"Size"},"id":{"default":"time","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"time","title":"Type","type":"string"},"unit":{"anyOf":[{"enum":["attosecond","centisecond","day","decisecond","exasecond","femtosecond","gigasecond","hectosecond","hour","kilosecond","megasecond","microsecond","millisecond","minute","nanosecond","petasecond","picosecond","second","terasecond","yoctosecond","yottasecond","zeptosecond","zettasecond"],"type":"string"},{"type":"null"}],"default":null,"title":"Unit"},"scale":{"default":1.0,"exclusiveMinimum":0,"title":"Scale","type":"number"}},"required":["size","type"],"title":"model.v0_5.TimeOutputAxis","type":"object"},"TimeOutputAxisWithHalo":{"additionalProperties":false,"properties":{"halo":{"description":"The halo should be cropped from the output tensor to avoid boundary effects.\nIt is to be cropped from both sides, i.e. `size_after_crop = size - 2 * halo`.\nTo document a halo that is already cropped by the model use `size.offset` instead.","minimum":1,"title":"Halo","type":"integer"},"size":{"$ref":"#/$defs/SizeReference","description":"reference to another axis with an optional offset (see `SizeReference`)","examples":[10,{"axis_id":"a","offset":5,"tensor_id":"t"}]},"id":{"default":"time","maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"description":{"default":"","maxLength":128,"title":"Description","type":"string"},"type":{"const":"time","title":"Type","type":"string"},"unit":{"anyOf":[{"enum":["attosecond","centisecond","day","decisecond","exasecond","femtosecond","gigasecond","hectosecond","hour","kilosecond","megasecond","microsecond","millisecond","minute","nanosecond","petasecond","picosecond","second","terasecond","yoctosecond","yottasecond","zeptosecond","zettasecond"],"type":"string"},{"type":"null"}],"default":null,"title":"Unit"},"scale":{"default":1.0,"exclusiveMinimum":0,"title":"Scale","type":"number"}},"required":["halo","size","type"],"title":"model.v0_5.TimeOutputAxisWithHalo","type":"object"},"Uploader":{"additionalProperties":false,"properties":{"email":{"description":"Email","format":"email","title":"Email","type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"name","title":"Name"}},"required":["email"],"title":"generic.v0_2.Uploader","type":"object"},"Version":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"description":"wraps a packaging.version.Version instance for validation in pydantic models","title":"Version"},"YamlValue":{"anyOf":[{"type":"boolean"},{"format":"date","type":"string"},{"format":"date-time","type":"string"},{"type":"integer"},{"type":"number"},{"type":"string"},{"items":{"$ref":"#/$defs/YamlValue"},"type":"array"},{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"type":"object"},{"type":"null"}]},"bioimageio__spec__application__v0_2__ApplicationDescr":{"additionalProperties":false,"description":"Bioimage.io description of an application.","properties":{"name":{"description":"A human-friendly name of the resource description","minLength":1,"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":1,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of the RDF and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"title":"Authors","type":"array"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"file and other attachments"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry"},"title":"Cite","type":"array"},"config":{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a github repo URL in `config` since we already have the\n`git_repo` field defined in the spec.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n bioimageio: # here is the domain name\n my_custom_key: 3837283\n another_key:\n nested: value\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files)","examples":[{"bioimageio":{"another_key":{"nested":"value"},"my_custom_key":3837283},"imagej":{"macro_dir":"path/to/macro/file"}}],"title":"Config","type":"object"},"download_url":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"URL to download the resource from (deprecated)","title":"Download Url"},"git_repo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Maintainer"},"title":"Maintainers","type":"array"},"rdf_source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\nDo not set this field in a YAML file.","title":"Rdf Source"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"version number (n-th published version, not the semantic version)","title":"Version Number"},"format_version":{"const":"0.2.4","description":"The format version of this resource specification\n(not the `version` of the resource description)\nWhen creating a new resource always use the latest micro/patch version described here.\nThe `format_version` is important for any consumer software to understand how to parse the fields.","title":"Format Version","type":"string"},"badges":{"description":"badges associated with this resource","items":{"$ref":"#/$defs/BadgeDescr"},"title":"Badges","type":"array"},"documentation":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"URL or relative path to a markdown file with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.","examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"],"title":"Documentation"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"},{"type":"string"},{"type":"null"}],"default":null,"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\n) to discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"type":{"const":"application","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"ApplicationId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"URL or path to the source of the application","title":"Source"}},"required":["name","description","format_version","type"],"title":"application 0.2.4","type":"object"},"bioimageio__spec__application__v0_3__ApplicationDescr":{"additionalProperties":false,"description":"Bioimage.io description of an application.","properties":{"name":{"description":"A human-friendly name of the resource description.\nMay only contains letters, digits, underscore, minus, parentheses and spaces.","maxLength":128,"minLength":1,"title":"Name","type":"string"},"description":{"description":"A string containing a brief description.","maxLength":1024,"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":2,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of this resource description and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"minItems":1,"title":"Authors","type":"array"},"attachments":{"description":"file attachments","items":{"$ref":"#/$defs/FileDescr"},"title":"Attachments","type":"array"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry"},"minItems":1,"title":"Cite","type":"array"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"}],"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\nto discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"git_repo":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration, e.g. on bioimage.io","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Maintainer"},"title":"Maintainers","type":"array"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"format_version":{"const":"0.3.0","description":"The **format** version of this resource specification","title":"Format Version","type":"string"},"documentation":{"anyOf":[{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"]},{"type":"null"}],"default":null,"description":"URL or relative path to a markdown file encoded in UTF-8 with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.","title":"Documentation"},"badges":{"description":"badges associated with this resource","items":{"$ref":"#/$defs/BadgeDescr"},"title":"Badges","type":"array"},"config":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Config","description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a GitHub repo URL in `config` since there is a `git_repo` field.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n giraffe_neckometer: # here is the domain name\n length: 3837283\n address:\n home: zoo\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource.\n(Packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files.)"},"type":{"const":"application","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"ApplicationId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"parent":{"anyOf":[{"minLength":1,"title":"ApplicationId","type":"string"},{"type":"null"}],"default":null,"description":"The description from which this one is derived","title":"Parent"},"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"URL or path to the source of the application","title":"Source"}},"required":["name","description","authors","cite","license","format_version","type"],"title":"application 0.3.0","type":"object"},"bioimageio__spec__dataset__v0_2__DatasetDescr":{"additionalProperties":false,"description":"A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage\nprocessing.","properties":{"name":{"description":"A human-friendly name of the resource description","minLength":1,"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":1,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of the RDF and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"title":"Authors","type":"array"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"file and other attachments"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry"},"title":"Cite","type":"array"},"config":{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a github repo URL in `config` since we already have the\n`git_repo` field defined in the spec.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n bioimageio: # here is the domain name\n my_custom_key: 3837283\n another_key:\n nested: value\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files)","examples":[{"bioimageio":{"another_key":{"nested":"value"},"my_custom_key":3837283},"imagej":{"macro_dir":"path/to/macro/file"}}],"title":"Config","type":"object"},"download_url":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"URL to download the resource from (deprecated)","title":"Download Url"},"git_repo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Maintainer"},"title":"Maintainers","type":"array"},"rdf_source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\nDo not set this field in a YAML file.","title":"Rdf Source"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"version number (n-th published version, not the semantic version)","title":"Version Number"},"format_version":{"const":"0.2.4","description":"The format version of this resource specification\n(not the `version` of the resource description)\nWhen creating a new resource always use the latest micro/patch version described here.\nThe `format_version` is important for any consumer software to understand how to parse the fields.","title":"Format Version","type":"string"},"badges":{"description":"badges associated with this resource","items":{"$ref":"#/$defs/BadgeDescr"},"title":"Badges","type":"array"},"documentation":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"URL or relative path to a markdown file with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.","examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"],"title":"Documentation"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"},{"type":"string"},{"type":"null"}],"default":null,"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\n) to discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"type":{"const":"dataset","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"DatasetId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"\"URL to the source of the dataset.","title":"Source"}},"required":["name","description","format_version","type"],"title":"dataset 0.2.4","type":"object"},"bioimageio__spec__dataset__v0_2__LinkedDataset":{"additionalProperties":false,"description":"Reference to a bioimage.io dataset.","properties":{"id":{"description":"A valid dataset `id` from the bioimage.io collection.","minLength":1,"title":"DatasetId","type":"string"},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"version number (n-th published version, not the semantic version) of linked dataset","title":"Version Number"}},"required":["id"],"title":"dataset.v0_2.LinkedDataset","type":"object"},"bioimageio__spec__dataset__v0_3__DatasetDescr":{"additionalProperties":false,"description":"A bioimage.io dataset resource description file (dataset RDF) describes a dataset relevant to bioimage\nprocessing.","properties":{"name":{"description":"A human-friendly name of the resource description.\nMay only contains letters, digits, underscore, minus, parentheses and spaces.","maxLength":128,"minLength":1,"title":"Name","type":"string"},"description":{"description":"A string containing a brief description.","maxLength":1024,"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":2,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of this resource description and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"minItems":1,"title":"Authors","type":"array"},"attachments":{"description":"file attachments","items":{"$ref":"#/$defs/FileDescr"},"title":"Attachments","type":"array"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry"},"minItems":1,"title":"Cite","type":"array"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"}],"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\nto discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"git_repo":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration, e.g. on bioimage.io","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Maintainer"},"title":"Maintainers","type":"array"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"format_version":{"const":"0.3.0","description":"The **format** version of this resource specification","title":"Format Version","type":"string"},"documentation":{"anyOf":[{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"]},{"type":"null"}],"default":null,"description":"URL or relative path to a markdown file encoded in UTF-8 with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.","title":"Documentation"},"badges":{"description":"badges associated with this resource","items":{"$ref":"#/$defs/BadgeDescr"},"title":"Badges","type":"array"},"config":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Config","description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a GitHub repo URL in `config` since there is a `git_repo` field.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n giraffe_neckometer: # here is the domain name\n length: 3837283\n address:\n home: zoo\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource.\n(Packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files.)"},"type":{"const":"dataset","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"DatasetId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"parent":{"anyOf":[{"minLength":1,"title":"DatasetId","type":"string"},{"type":"null"}],"default":null,"description":"The description from which this one is derived","title":"Parent"},"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"\"URL to the source of the dataset.","title":"Source"}},"required":["name","description","authors","cite","license","format_version","type"],"title":"dataset 0.3.0","type":"object"},"bioimageio__spec__dataset__v0_3__LinkedDataset":{"additionalProperties":false,"description":"Reference to a bioimage.io dataset.","properties":{"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the linked resource following SemVer 2.0."},"id":{"description":"A valid dataset `id` from the bioimage.io collection.","minLength":1,"title":"DatasetId","type":"string"}},"required":["id"],"title":"dataset.v0_3.LinkedDataset","type":"object"},"bioimageio__spec__generic__v0_2__Author":{"additionalProperties":false,"properties":{"affiliation":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Affiliation","title":"Affiliation"},"email":{"anyOf":[{"format":"email","type":"string"},{"type":"null"}],"default":null,"description":"Email","title":"Email"},"orcid":{"anyOf":[{"description":"An ORCID identifier, see https://orcid.org/","title":"OrcidId","type":"string"},{"type":"null"}],"default":null,"description":"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\n) in hyphenated groups of 4 digits, (and [valid](\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\n) as per ISO 7064 11,2.)","examples":["0000-0001-2345-6789"],"title":"Orcid"},"name":{"title":"Name","type":"string"},"github_user":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Github User"}},"required":["name"],"title":"generic.v0_2.Author","type":"object"},"bioimageio__spec__generic__v0_2__CiteEntry":{"additionalProperties":false,"properties":{"text":{"description":"free text description","title":"Text","type":"string"},"doi":{"anyOf":[{"description":"A digital object identifier, see https://www.doi.org/","pattern":"^10\\.[0-9]{4}.+$","title":"Doi","type":"string"},{"type":"null"}],"default":null,"description":"A digital object identifier (DOI) is the prefered citation reference.\nSee https://www.doi.org/ for details. (alternatively specify `url`)","title":"Doi"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"URL to cite (preferably specify a `doi` instead)","title":"Url"}},"required":["text"],"title":"generic.v0_2.CiteEntry","type":"object"},"bioimageio__spec__generic__v0_2__Maintainer":{"additionalProperties":false,"properties":{"affiliation":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Affiliation","title":"Affiliation"},"email":{"anyOf":[{"format":"email","type":"string"},{"type":"null"}],"default":null,"description":"Email","title":"Email"},"orcid":{"anyOf":[{"description":"An ORCID identifier, see https://orcid.org/","title":"OrcidId","type":"string"},{"type":"null"}],"default":null,"description":"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\n) in hyphenated groups of 4 digits, (and [valid](\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\n) as per ISO 7064 11,2.)","examples":["0000-0001-2345-6789"],"title":"Orcid"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"github_user":{"title":"Github User","type":"string"}},"required":["github_user"],"title":"generic.v0_2.Maintainer","type":"object"},"bioimageio__spec__generic__v0_3__Author":{"additionalProperties":false,"properties":{"affiliation":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Affiliation","title":"Affiliation"},"email":{"anyOf":[{"format":"email","type":"string"},{"type":"null"}],"default":null,"description":"Email","title":"Email"},"orcid":{"anyOf":[{"description":"An ORCID identifier, see https://orcid.org/","title":"OrcidId","type":"string"},{"type":"null"}],"default":null,"description":"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\n) in hyphenated groups of 4 digits, (and [valid](\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\n) as per ISO 7064 11,2.)","examples":["0000-0001-2345-6789"],"title":"Orcid"},"name":{"title":"Name","type":"string"},"github_user":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Github User"}},"required":["name"],"title":"generic.v0_3.Author","type":"object"},"bioimageio__spec__generic__v0_3__BioimageioConfig":{"additionalProperties":true,"description":"bioimage.io internal metadata.","properties":{},"title":"generic.v0_3.BioimageioConfig","type":"object"},"bioimageio__spec__generic__v0_3__CiteEntry":{"additionalProperties":false,"description":"A citation that should be referenced in work using this resource.","properties":{"text":{"description":"free text description","title":"Text","type":"string"},"doi":{"anyOf":[{"description":"A digital object identifier, see https://www.doi.org/","pattern":"^10\\.[0-9]{4}.+$","title":"Doi","type":"string"},{"type":"null"}],"default":null,"description":"A digital object identifier (DOI) is the prefered citation reference.\nSee https://www.doi.org/ for details.\nNote:\n Either **doi** or **url** have to be specified.","title":"Doi"},"url":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"URL to cite (preferably specify a **doi** instead/also).\nNote:\n Either **doi** or **url** have to be specified.","title":"Url"}},"required":["text"],"title":"generic.v0_3.CiteEntry","type":"object"},"bioimageio__spec__generic__v0_3__Config":{"additionalProperties":true,"description":"A place to store additional metadata (often tool specific).\n\nSuch additional metadata is typically set programmatically by the respective tool\nor by people with specific insights into the tool.\nIf you want to store additional metadata that does not match any of the other\nfields, think of a key unlikely to collide with anyone elses use-case/tool and save\nit here.\n\nPlease consider creating [an issue in the bioimageio.spec repository](https://github.com/bioimage-io/spec-bioimage-io/issues/new?template=Blank+issue)\nif you are not sure if an existing field could cover your use case\nor if you think such a field should exist.","properties":{"bioimageio":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__BioimageioConfig"}},"title":"generic.v0_3.Config","type":"object"},"bioimageio__spec__generic__v0_3__Maintainer":{"additionalProperties":false,"properties":{"affiliation":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Affiliation","title":"Affiliation"},"email":{"anyOf":[{"format":"email","type":"string"},{"type":"null"}],"default":null,"description":"Email","title":"Email"},"orcid":{"anyOf":[{"description":"An ORCID identifier, see https://orcid.org/","title":"OrcidId","type":"string"},{"type":"null"}],"default":null,"description":"An [ORCID iD](https://support.orcid.org/hc/en-us/sections/360001495313-What-is-ORCID\n) in hyphenated groups of 4 digits, (and [valid](\nhttps://support.orcid.org/hc/en-us/articles/360006897674-Structure-of-the-ORCID-Identifier\n) as per ISO 7064 11,2.)","examples":["0000-0001-2345-6789"],"title":"Orcid"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Name"},"github_user":{"title":"Github User","type":"string"}},"required":["github_user"],"title":"generic.v0_3.Maintainer","type":"object"},"bioimageio__spec__model__v0_4__BinarizeDescr":{"additionalProperties":false,"description":"BinarizeDescr the tensor with a fixed `BinarizeKwargs.threshold`.\nValues above the threshold will be set to one, values below the threshold to zero.","properties":{"name":{"const":"binarize","title":"Name","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__BinarizeKwargs"}},"required":["name","kwargs"],"title":"model.v0_4.BinarizeDescr","type":"object"},"bioimageio__spec__model__v0_4__BinarizeKwargs":{"additionalProperties":false,"description":"key word arguments for `BinarizeDescr`","properties":{"threshold":{"description":"The fixed threshold","title":"Threshold","type":"number"}},"required":["threshold"],"title":"model.v0_4.BinarizeKwargs","type":"object"},"bioimageio__spec__model__v0_4__ClipDescr":{"additionalProperties":false,"description":"Clip tensor values to a range.\n\nSet tensor values below `ClipKwargs.min` to `ClipKwargs.min`\nand above `ClipKwargs.max` to `ClipKwargs.max`.","properties":{"name":{"const":"clip","title":"Name","type":"string"},"kwargs":{"$ref":"#/$defs/ClipKwargs"}},"required":["name","kwargs"],"title":"model.v0_4.ClipDescr","type":"object"},"bioimageio__spec__model__v0_4__InputTensorDescr":{"additionalProperties":false,"properties":{"name":{"description":"Tensor name. No duplicates are allowed.","minLength":1,"title":"TensorName","type":"string"},"description":{"default":"","title":"Description","type":"string"},"axes":{"description":"Axes identifying characters. Same length and order as the axes in `shape`.\n| axis | description |\n| --- | --- |\n| b | batch (groups multiple samples) |\n| i | instance/index/element |\n| t | time |\n| c | channel |\n| z | spatial dimension z |\n| y | spatial dimension y |\n| x | spatial dimension x |","title":"Axes","type":"string"},"data_range":{"anyOf":[{"maxItems":2,"minItems":2,"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array"},{"type":"null"}],"default":null,"description":"Tuple `(minimum, maximum)` specifying the allowed range of the data in this tensor.\nIf not specified, the full data range that can be expressed in `data_type` is allowed.","title":"Data Range"},"data_type":{"description":"For now an input tensor is expected to be given as `float32`.\nThe data flow in bioimage.io models is explained\n[in this diagram.](https://docs.google.com/drawings/d/1FTw8-Rn6a6nXdkZ_SkMumtcjvur9mtIhRqLwnKqZNHM/edit).","enum":["float32","uint8","uint16"],"title":"Data Type","type":"string"},"shape":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"$ref":"#/$defs/ParameterizedInputShape"}],"description":"Specification of input tensor shape.","examples":[[1,512,512,1],{"min":[1,64,64,1],"step":[0,32,32,0]}],"title":"Shape"},"preprocessing":{"description":"Description of how this input should be preprocessed.","items":{"discriminator":{"mapping":{"binarize":"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr","clip":"#/$defs/bioimageio__spec__model__v0_4__ClipDescr","scale_linear":"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr","scale_range":"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr","sigmoid":"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr","zero_mean_unit_variance":"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr"},"propertyName":"name"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ClipDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr"}]},"title":"Preprocessing","type":"array"}},"required":["name","axes","data_type","shape"],"title":"model.v0_4.InputTensorDescr","type":"object"},"bioimageio__spec__model__v0_4__KerasHdf5WeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"Attachments that are specific to this weights entry."},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"dependencies":{"anyOf":[{"pattern":"^.+:.+$","title":"Dependencies","type":"string"},{"type":"null"}],"default":null,"description":"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.","examples":["conda:environment.yaml","maven:./pom.xml","pip:./requirements.txt"],"title":"Dependencies"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"tensorflow_version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"TensorFlow version used to create these weights"}},"required":["source"],"title":"model.v0_4.KerasHdf5WeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__LinkedModel":{"additionalProperties":false,"description":"Reference to a bioimage.io model.","properties":{"id":{"description":"A valid model `id` from the bioimage.io collection.","examples":["affable-shark","ambitious-sloth"],"minLength":1,"title":"ModelId","type":"string"},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"version number (n-th published version, not the semantic version) of linked model","title":"Version Number"}},"required":["id"],"title":"model.v0_4.LinkedModel","type":"object"},"bioimageio__spec__model__v0_4__ModelDescr":{"additionalProperties":false,"description":"Specification of the fields used in a bioimage.io-compliant RDF that describes AI models with pretrained weights.\n\nThese fields are typically stored in a YAML file which we call a model resource description file (model RDF).","properties":{"name":{"description":"A human-readable name of this model.\nIt should be no longer than 64 characters and only contain letter, number, underscore, minus or space characters.","minLength":1,"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":1,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of the model RDF and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"minItems":1,"title":"Authors","type":"array"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"file and other attachments"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry"},"title":"Cite","type":"array"},"config":{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a github repo URL in `config` since we already have the\n`git_repo` field defined in the spec.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n bioimageio: # here is the domain name\n my_custom_key: 3837283\n another_key:\n nested: value\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files)","examples":[{"bioimageio":{"another_key":{"nested":"value"},"my_custom_key":3837283},"imagej":{"macro_dir":"path/to/macro/file"}}],"title":"Config","type":"object"},"download_url":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"URL to download the resource from (deprecated)","title":"Download Url"},"git_repo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Maintainer"},"title":"Maintainers","type":"array"},"rdf_source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\nDo not set this field in a YAML file.","title":"Rdf Source"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"version number (n-th published version, not the semantic version)","title":"Version Number"},"format_version":{"const":"0.4.10","description":"Version of the bioimage.io model description specification used.\nWhen creating a new model always use the latest micro/patch version described here.\nThe `format_version` is important for any consumer software to understand how to parse the fields.","title":"Format Version","type":"string"},"type":{"const":"model","description":"Specialized resource type 'model'","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"ModelId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"documentation":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"URL or relative path to a markdown file with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\nThe documentation should include a '[#[#]]# Validation' (sub)section\nwith details on how to quantitatively validate the model on unseen data.","examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"],"title":"Documentation"},"inputs":{"description":"Describes the input tensors expected by this model.","items":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__InputTensorDescr"},"minItems":1,"title":"Inputs","type":"array"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"type":"string"}],"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do notsupport custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\n) to discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"outputs":{"description":"Describes the output tensors.","items":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__OutputTensorDescr"},"minItems":1,"title":"Outputs","type":"array"},"packaged_by":{"description":"The persons that have packaged and uploaded this model.\nOnly required if those persons differ from the `authors`.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"title":"Packaged By","type":"array"},"parent":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__LinkedModel"},{"type":"null"}],"default":null,"description":"The model from which this model is derived, e.g. by fine-tuning the weights."},"run_mode":{"anyOf":[{"$ref":"#/$defs/RunMode"},{"type":"null"}],"default":null,"description":"Custom run mode for this model: for more complex prediction procedures like test time\ndata augmentation that currently cannot be expressed in the specification.\nNo standard run modes are defined yet."},"sample_inputs":{"description":"URLs/relative paths to sample inputs to illustrate possible inputs for the model,\nfor example stored as PNG or TIFF images.\nThe sample files primarily serve to inform a human user about an example use case","items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Sample Inputs","type":"array"},"sample_outputs":{"description":"URLs/relative paths to sample outputs corresponding to the `sample_inputs`.","items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Sample Outputs","type":"array"},"test_inputs":{"description":"Test input tensors compatible with the `inputs` description for a **single test case**.\nThis means if your model has more than one input, you should provide one URL/relative path for each input.\nEach test input should be a file with an ndarray in\n[numpy.lib file format](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html#module-numpy.lib.format).\nThe extension must be '.npy'.","items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"minItems":1,"title":"Test Inputs","type":"array"},"test_outputs":{"description":"Analog to `test_inputs`.","items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"minItems":1,"title":"Test Outputs","type":"array"},"timestamp":{"$ref":"#/$defs/Datetime"},"training_data":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__dataset__v0_2__LinkedDataset"},{"$ref":"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr"},{"type":"null"}],"default":null,"description":"The dataset used to train this model","title":"Training Data"},"weights":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__WeightsDescr","description":"The weights for this model.\nWeights can be given for different formats, but should otherwise be equivalent.\nThe available weight formats determine which consumers can use this model."}},"required":["name","description","authors","format_version","type","documentation","inputs","license","outputs","test_inputs","test_outputs","timestamp","weights"],"title":"model 0.4.10","type":"object"},"bioimageio__spec__model__v0_4__OnnxWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"Attachments that are specific to this weights entry."},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"dependencies":{"anyOf":[{"pattern":"^.+:.+$","title":"Dependencies","type":"string"},{"type":"null"}],"default":null,"description":"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.","examples":["conda:environment.yaml","maven:./pom.xml","pip:./requirements.txt"],"title":"Dependencies"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"opset_version":{"anyOf":[{"minimum":7,"type":"integer"},{"type":"null"}],"default":null,"description":"ONNX opset version","title":"Opset Version"}},"required":["source"],"title":"model.v0_4.OnnxWeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__OutputTensorDescr":{"additionalProperties":false,"properties":{"name":{"description":"Tensor name. No duplicates are allowed.","minLength":1,"title":"TensorName","type":"string"},"description":{"default":"","title":"Description","type":"string"},"axes":{"description":"Axes identifying characters. Same length and order as the axes in `shape`.\n| axis | description |\n| --- | --- |\n| b | batch (groups multiple samples) |\n| i | instance/index/element |\n| t | time |\n| c | channel |\n| z | spatial dimension z |\n| y | spatial dimension y |\n| x | spatial dimension x |","title":"Axes","type":"string"},"data_range":{"anyOf":[{"maxItems":2,"minItems":2,"prefixItems":[{"type":"number"},{"type":"number"}],"type":"array"},{"type":"null"}],"default":null,"description":"Tuple `(minimum, maximum)` specifying the allowed range of the data in this tensor.\nIf not specified, the full data range that can be expressed in `data_type` is allowed.","title":"Data Range"},"data_type":{"description":"Data type.\nThe data flow in bioimage.io models is explained\n[in this diagram.](https://docs.google.com/drawings/d/1FTw8-Rn6a6nXdkZ_SkMumtcjvur9mtIhRqLwnKqZNHM/edit).","enum":["float32","float64","uint8","int8","uint16","int16","uint32","int32","uint64","int64","bool"],"title":"Data Type","type":"string"},"shape":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"$ref":"#/$defs/ImplicitOutputShape"}],"description":"Output tensor shape.","title":"Shape"},"halo":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"default":null,"description":"The `halo` that should be cropped from the output tensor to avoid boundary effects.\nThe `halo` is to be cropped from both sides, i.e. `shape_after_crop = shape - 2 * halo`.\nTo document a `halo` that is already cropped by the model `shape.offset` has to be used instead.","title":"Halo"},"postprocessing":{"description":"Description of how this output should be postprocessed.","items":{"discriminator":{"mapping":{"binarize":"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr","clip":"#/$defs/bioimageio__spec__model__v0_4__ClipDescr","scale_linear":"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr","scale_mean_variance":"#/$defs/bioimageio__spec__model__v0_4__ScaleMeanVarianceDescr","scale_range":"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr","sigmoid":"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr","zero_mean_unit_variance":"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr"},"propertyName":"name"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__BinarizeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ClipDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__SigmoidDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleMeanVarianceDescr"}]},"title":"Postprocessing","type":"array"}},"required":["name","axes","data_type","shape"],"title":"model.v0_4.OutputTensorDescr","type":"object"},"bioimageio__spec__model__v0_4__PytorchStateDictWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"Attachments that are specific to this weights entry."},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"dependencies":{"anyOf":[{"pattern":"^.+:.+$","title":"Dependencies","type":"string"},{"type":"null"}],"default":null,"description":"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.","examples":["conda:environment.yaml","maven:./pom.xml","pip:./requirements.txt"],"title":"Dependencies"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"architecture":{"anyOf":[{"pattern":"^.+:.+$","title":"CallableFromFile","type":"string"},{"pattern":"^.+\\..+$","title":"CallableFromDepencency","type":"string"}],"description":"callable returning a torch.nn.Module instance.\nLocal implementation: `<relative path to file>:<identifier of implementation within the file>`.\nImplementation in a dependency: `<dependency-package>.<[dependency-module]>.<identifier>`.","examples":["my_function.py:MyNetworkClass","my_module.submodule.get_my_model"],"title":"Architecture"},"architecture_sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"The SHA256 of the architecture source file, if the architecture is not defined in a module listed in `dependencies`\nYou can drag and drop your file to this\n[online tool](http://emn178.github.io/online-tools/sha256_checksum.html) to generate a SHA256 in your browser.\nOr you can generate a SHA256 checksum with Python's `hashlib`,\n[here is a codesnippet](https://gist.github.com/FynnBe/e64460463df89439cff218bbf59c1100).","title":"Architecture Sha256"},"kwargs":{"additionalProperties":true,"description":"key word arguments for the `architecture` callable","title":"Kwargs","type":"object"},"pytorch_version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"Version of the PyTorch library used.\nIf `depencencies` is specified it should include pytorch and the verison has to match.\n(`dependencies` overrules `pytorch_version`)"}},"required":["source","architecture"],"title":"model.v0_4.PytorchStateDictWeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__ScaleLinearDescr":{"additionalProperties":false,"description":"Fixed linear scaling.","properties":{"name":{"const":"scale_linear","title":"Name","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleLinearKwargs"}},"required":["name","kwargs"],"title":"model.v0_4.ScaleLinearDescr","type":"object"},"bioimageio__spec__model__v0_4__ScaleLinearKwargs":{"additionalProperties":false,"description":"key word arguments for `ScaleLinearDescr`","properties":{"axes":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"The subset of axes to scale jointly.\nFor example xy to scale the two image axes for 2d data jointly.","examples":["xy"],"title":"Axes"},"gain":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"type":"array"}],"default":1.0,"description":"multiplicative factor","title":"Gain"},"offset":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"type":"array"}],"default":0.0,"description":"additive term","title":"Offset"}},"title":"model.v0_4.ScaleLinearKwargs","type":"object"},"bioimageio__spec__model__v0_4__ScaleMeanVarianceDescr":{"additionalProperties":false,"description":"Scale the tensor s.t. its mean and variance match a reference tensor.","properties":{"name":{"const":"scale_mean_variance","title":"Name","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleMeanVarianceKwargs"}},"required":["name","kwargs"],"title":"model.v0_4.ScaleMeanVarianceDescr","type":"object"},"bioimageio__spec__model__v0_4__ScaleMeanVarianceKwargs":{"additionalProperties":false,"description":"key word arguments for `ScaleMeanVarianceDescr`","properties":{"mode":{"description":"Mode for computing mean and variance.\n| mode | description |\n| ----------- | ------------------------------------ |\n| per_dataset | Compute for the entire dataset |\n| per_sample | Compute for each sample individually |","enum":["per_dataset","per_sample"],"title":"Mode","type":"string"},"reference_tensor":{"description":"Name of tensor to match.","minLength":1,"title":"TensorName","type":"string"},"axes":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"The subset of axes to scale jointly.\nFor example xy to normalize the two image axes for 2d data jointly.\nDefault: scale all non-batch axes jointly.","examples":["xy"],"title":"Axes"},"eps":{"default":1e-06,"description":"Epsilon for numeric stability:\n\"`out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.","exclusiveMinimum":0,"maximum":0.1,"title":"Eps","type":"number"}},"required":["mode","reference_tensor"],"title":"model.v0_4.ScaleMeanVarianceKwargs","type":"object"},"bioimageio__spec__model__v0_4__ScaleRangeDescr":{"additionalProperties":false,"description":"Scale with percentiles.","properties":{"name":{"const":"scale_range","title":"Name","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ScaleRangeKwargs"}},"required":["name","kwargs"],"title":"model.v0_4.ScaleRangeDescr","type":"object"},"bioimageio__spec__model__v0_4__ScaleRangeKwargs":{"additionalProperties":false,"description":"key word arguments for `ScaleRangeDescr`\n\nFor `min_percentile`=0.0 (the default) and `max_percentile`=100 (the default)\nthis processing step normalizes data to the [0, 1] intervall.\nFor other percentiles the normalized values will partially be outside the [0, 1]\nintervall. Use `ScaleRange` followed by `ClipDescr` if you want to limit the\nnormalized values to a range.","properties":{"mode":{"description":"Mode for computing percentiles.\n| mode | description |\n| ----------- | ------------------------------------ |\n| per_dataset | compute for the entire dataset |\n| per_sample | compute for each sample individually |","enum":["per_dataset","per_sample"],"title":"Mode","type":"string"},"axes":{"description":"The subset of axes to normalize jointly.\nFor example xy to normalize the two image axes for 2d data jointly.","examples":["xy"],"title":"Axes","type":"string"},"min_percentile":{"anyOf":[{"type":"integer"},{"type":"number"}],"default":0.0,"description":"The lower percentile used to determine the value to align with zero.","ge":0,"lt":100,"title":"Min Percentile"},"max_percentile":{"anyOf":[{"type":"integer"},{"type":"number"}],"default":100.0,"description":"The upper percentile used to determine the value to align with one.\nHas to be bigger than `min_percentile`.\nThe range is 1 to 100 instead of 0 to 100 to avoid mistakenly\naccepting percentiles specified in the range 0.0 to 1.0.","gt":1,"le":100,"title":"Max Percentile"},"eps":{"default":1e-06,"description":"Epsilon for numeric stability.\n`out = (tensor - v_lower) / (v_upper - v_lower + eps)`;\nwith `v_lower,v_upper` values at the respective percentiles.","exclusiveMinimum":0,"maximum":0.1,"title":"Eps","type":"number"},"reference_tensor":{"anyOf":[{"minLength":1,"title":"TensorName","type":"string"},{"type":"null"}],"default":null,"description":"Tensor name to compute the percentiles from. Default: The tensor itself.\nFor any tensor in `inputs` only input tensor references are allowed.\nFor a tensor in `outputs` only input tensor refereences are allowed if `mode: per_dataset`","title":"Reference Tensor"}},"required":["mode","axes"],"title":"model.v0_4.ScaleRangeKwargs","type":"object"},"bioimageio__spec__model__v0_4__SigmoidDescr":{"additionalProperties":false,"description":"The logistic sigmoid funciton, a.k.a. expit function.","properties":{"name":{"const":"sigmoid","title":"Name","type":"string"}},"required":["name"],"title":"model.v0_4.SigmoidDescr","type":"object"},"bioimageio__spec__model__v0_4__TensorflowJsWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The multi-file weights.\nAll required files/folders should be a zip archive.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"Attachments that are specific to this weights entry."},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"dependencies":{"anyOf":[{"pattern":"^.+:.+$","title":"Dependencies","type":"string"},{"type":"null"}],"default":null,"description":"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.","examples":["conda:environment.yaml","maven:./pom.xml","pip:./requirements.txt"],"title":"Dependencies"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"tensorflow_version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"Version of the TensorFlow library used."}},"required":["source"],"title":"model.v0_4.TensorflowJsWeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__TensorflowSavedModelBundleWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"Attachments that are specific to this weights entry."},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"dependencies":{"anyOf":[{"pattern":"^.+:.+$","title":"Dependencies","type":"string"},{"type":"null"}],"default":null,"description":"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.","examples":["conda:environment.yaml","maven:./pom.xml","pip:./requirements.txt"],"title":"Dependencies"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"tensorflow_version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"Version of the TensorFlow library used."}},"required":["source"],"title":"model.v0_4.TensorflowSavedModelBundleWeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__TorchscriptWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"Attachments that are specific to this weights entry."},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"dependencies":{"anyOf":[{"pattern":"^.+:.+$","title":"Dependencies","type":"string"},{"type":"null"}],"default":null,"description":"Dependency manager and dependency file, specified as `<dependency manager>:<relative file path>`.","examples":["conda:environment.yaml","maven:./pom.xml","pip:./requirements.txt"],"title":"Dependencies"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"pytorch_version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"Version of the PyTorch library used."}},"required":["source"],"title":"model.v0_4.TorchscriptWeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__WeightsDescr":{"additionalProperties":false,"properties":{"keras_hdf5":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__KerasHdf5WeightsDescr"},{"type":"null"}],"default":null},"onnx":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__OnnxWeightsDescr"},{"type":"null"}],"default":null},"pytorch_state_dict":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__PytorchStateDictWeightsDescr"},{"type":"null"}],"default":null},"tensorflow_js":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__TensorflowJsWeightsDescr"},{"type":"null"}],"default":null},"tensorflow_saved_model_bundle":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__TensorflowSavedModelBundleWeightsDescr"},{"type":"null"}],"default":null},"torchscript":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__TorchscriptWeightsDescr"},{"type":"null"}],"default":null}},"title":"model.v0_4.WeightsDescr","type":"object"},"bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceDescr":{"additionalProperties":false,"description":"Subtract mean and divide by variance.","properties":{"name":{"const":"zero_mean_unit_variance","title":"Name","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceKwargs"}},"required":["name","kwargs"],"title":"model.v0_4.ZeroMeanUnitVarianceDescr","type":"object"},"bioimageio__spec__model__v0_4__ZeroMeanUnitVarianceKwargs":{"additionalProperties":false,"description":"key word arguments for `ZeroMeanUnitVarianceDescr`","properties":{"mode":{"default":"fixed","description":"Mode for computing mean and variance.\n| mode | description |\n| ----------- | ------------------------------------ |\n| fixed | Fixed values for mean and variance |\n| per_dataset | Compute for the entire dataset |\n| per_sample | Compute for each sample individually |","enum":["fixed","per_dataset","per_sample"],"title":"Mode","type":"string"},"axes":{"description":"The subset of axes to normalize jointly.\nFor example `xy` to normalize the two image axes for 2d data jointly.","examples":["xy"],"title":"Axes","type":"string"},"mean":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"The mean value(s) to use for `mode: fixed`.\nFor example `[1.1, 2.2, 3.3]` in the case of a 3 channel image with `axes: xy`.","examples":[[1.1,2.2,3.3]],"title":"Mean"},"std":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"minItems":1,"type":"array"},{"type":"null"}],"default":null,"description":"The standard deviation values to use for `mode: fixed`. Analogous to mean.","examples":[[0.1,0.2,0.3]],"title":"Std"},"eps":{"default":1e-06,"description":"epsilon for numeric stability: `out = (tensor - mean) / (std + eps)`.","exclusiveMinimum":0,"maximum":0.1,"title":"Eps","type":"number"}},"required":["axes"],"title":"model.v0_4.ZeroMeanUnitVarianceKwargs","type":"object"},"bioimageio__spec__model__v0_5__BinarizeDescr":{"additionalProperties":false,"description":"Binarize the tensor with a fixed threshold.\n\nValues above `BinarizeKwargs.threshold`/`BinarizeAlongAxisKwargs.threshold`\nwill be set to one, values below the threshold to zero.\n\nExamples:\n- in YAML\n ```yaml\n postprocessing:\n - id: binarize\n kwargs:\n axis: 'channel'\n threshold: [0.25, 0.5, 0.75]\n ```\n- in Python:\n >>> postprocessing = [BinarizeDescr(\n ... kwargs=BinarizeAlongAxisKwargs(\n ... axis=AxisId('channel'),\n ... threshold=[0.25, 0.5, 0.75],\n ... )\n ... )]","properties":{"id":{"const":"binarize","title":"Id","type":"string"},"kwargs":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__BinarizeKwargs"},{"$ref":"#/$defs/BinarizeAlongAxisKwargs"}],"title":"Kwargs"}},"required":["id","kwargs"],"title":"model.v0_5.BinarizeDescr","type":"object"},"bioimageio__spec__model__v0_5__BinarizeKwargs":{"additionalProperties":false,"description":"key word arguments for `BinarizeDescr`","properties":{"threshold":{"description":"The fixed threshold","title":"Threshold","type":"number"}},"required":["threshold"],"title":"model.v0_5.BinarizeKwargs","type":"object"},"bioimageio__spec__model__v0_5__BioimageioConfig":{"additionalProperties":true,"properties":{"reproducibility_tolerance":{"default":[],"description":"Tolerances to allow when reproducing the model's test outputs\nfrom the model's test inputs.\nOnly the first entry matching tensor id and weights format is considered.","items":{"$ref":"#/$defs/ReproducibilityTolerance"},"title":"Reproducibility Tolerance","type":"array"}},"title":"model.v0_5.BioimageioConfig","type":"object"},"bioimageio__spec__model__v0_5__ClipDescr":{"additionalProperties":false,"description":"Set tensor values below min to min and above max to max.\n\nSee `ScaleRangeDescr` for examples.","properties":{"id":{"const":"clip","title":"Id","type":"string"},"kwargs":{"$ref":"#/$defs/ClipKwargs"}},"required":["id","kwargs"],"title":"model.v0_5.ClipDescr","type":"object"},"bioimageio__spec__model__v0_5__Config":{"additionalProperties":true,"properties":{"bioimageio":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__BioimageioConfig"}},"title":"model.v0_5.Config","type":"object"},"bioimageio__spec__model__v0_5__InputTensorDescr":{"additionalProperties":false,"properties":{"id":{"default":"input","description":"Input tensor id.\nNo duplicates are allowed across all inputs and outputs.","maxLength":32,"minLength":1,"title":"TensorId","type":"string"},"description":{"default":"","description":"free text description","maxLength":128,"title":"Description","type":"string"},"axes":{"description":"tensor axes","items":{"discriminator":{"mapping":{"batch":"#/$defs/BatchAxis","channel":"#/$defs/ChannelAxis","index":"#/$defs/IndexInputAxis","space":"#/$defs/SpaceInputAxis","time":"#/$defs/TimeInputAxis"},"propertyName":"type"},"oneOf":[{"$ref":"#/$defs/BatchAxis"},{"$ref":"#/$defs/ChannelAxis"},{"$ref":"#/$defs/IndexInputAxis"},{"$ref":"#/$defs/TimeInputAxis"},{"$ref":"#/$defs/SpaceInputAxis"}]},"minItems":1,"title":"Axes","type":"array"},"test_tensor":{"$ref":"#/$defs/FileDescr","description":"An example tensor to use for testing.\nUsing the model with the test input tensors is expected to yield the test output tensors.\nEach test tensor has be a an ndarray in the\n[numpy.lib file format](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html#module-numpy.lib.format).\nThe file extension must be '.npy'."},"sample_tensor":{"anyOf":[{"$ref":"#/$defs/FileDescr"},{"type":"null"}],"default":null,"description":"A sample tensor to illustrate a possible input/output for the model,\nThe sample image primarily serves to inform a human user about an example use case\nand is typically stored as .hdf5, .png or .tiff.\nIt has to be readable by the [imageio library](https://imageio.readthedocs.io/en/stable/formats/index.html#supported-formats)\n(numpy's `.npy` format is not supported).\nThe image dimensionality has to match the number of axes specified in this tensor description."},"data":{"anyOf":[{"$ref":"#/$defs/NominalOrOrdinalDataDescr"},{"$ref":"#/$defs/IntervalOrRatioDataDescr"},{"items":{"anyOf":[{"$ref":"#/$defs/NominalOrOrdinalDataDescr"},{"$ref":"#/$defs/IntervalOrRatioDataDescr"}]},"minItems":1,"type":"array"}],"default":{"type":"float32","range":[null,null],"unit":"arbitrary unit","scale":1.0,"offset":null},"description":"Description of the tensor's data values, optionally per channel.\nIf specified per channel, the data `type` needs to match across channels.","title":"Data"},"optional":{"default":false,"description":"indicates that this tensor may be `None`","title":"Optional","type":"boolean"},"preprocessing":{"description":"Description of how this input should be preprocessed.\n\nnotes:\n- If preprocessing does not start with an 'ensure_dtype' entry, it is added\n to ensure an input tensor's data type matches the input tensor's data description.\n- If preprocessing does not end with an 'ensure_dtype' or 'binarize' entry, an\n 'ensure_dtype' step is added to ensure preprocessing steps are not unintentionally\n changing the data type.","items":{"discriminator":{"mapping":{"binarize":"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr","clip":"#/$defs/bioimageio__spec__model__v0_5__ClipDescr","ensure_dtype":"#/$defs/EnsureDtypeDescr","fixed_zero_mean_unit_variance":"#/$defs/FixedZeroMeanUnitVarianceDescr","scale_linear":"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr","scale_range":"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr","sigmoid":"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr","zero_mean_unit_variance":"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr"},"propertyName":"id"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ClipDescr"},{"$ref":"#/$defs/EnsureDtypeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr"},{"$ref":"#/$defs/FixedZeroMeanUnitVarianceDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr"}]},"title":"Preprocessing","type":"array"}},"required":["axes","test_tensor"],"title":"model.v0_5.InputTensorDescr","type":"object"},"bioimageio__spec__model__v0_5__KerasHdf5WeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"Source of the weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"comment":{"default":"","description":"A comment about this weights entry, for example how these weights were created.","title":"Comment","type":"string"},"tensorflow_version":{"$ref":"#/$defs/Version","description":"TensorFlow version used to create these weights."}},"required":["source","tensorflow_version"],"title":"model.v0_5.KerasHdf5WeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__LinkedModel":{"additionalProperties":false,"description":"Reference to a bioimage.io model.","properties":{"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the linked resource following SemVer 2.0."},"id":{"description":"A valid model `id` from the bioimage.io collection.","minLength":1,"title":"ModelId","type":"string"}},"required":["id"],"title":"model.v0_5.LinkedModel","type":"object"},"bioimageio__spec__model__v0_5__ModelDescr":{"additionalProperties":false,"description":"Specification of the fields used in a bioimage.io-compliant RDF to describe AI models with pretrained weights.\nThese fields are typically stored in a YAML file which we call a model resource description file (model RDF).","properties":{"name":{"description":"A human-readable name of this model.\nIt should be no longer than 64 characters\nand may only contain letter, number, underscore, minus, parentheses and spaces.\nWe recommend to chose a name that refers to the model's task and image modality.","maxLength":128,"minLength":5,"title":"Name","type":"string"},"description":{"description":"A string containing a brief description.","maxLength":1024,"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":2,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of the model RDF and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"minItems":1,"title":"Authors","type":"array"},"attachments":{"description":"file attachments","items":{"$ref":"#/$defs/FileDescr"},"title":"Attachments","type":"array"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry"},"minItems":1,"title":"Cite","type":"array"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"}],"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\nto discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"git_repo":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration, e.g. on bioimage.io","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Maintainer"},"title":"Maintainers","type":"array"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"format_version":{"const":"0.5.4","description":"Version of the bioimage.io model description specification used.\nWhen creating a new model always use the latest micro/patch version described here.\nThe `format_version` is important for any consumer software to understand how to parse the fields.","title":"Format Version","type":"string"},"type":{"const":"model","description":"Specialized resource type 'model'","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"ModelId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"documentation":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"URL or relative path to a markdown file with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.\nThe documentation should include a '#[#] Validation' (sub)section\nwith details on how to quantitatively validate the model on unseen data.","examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"],"title":"Documentation"},"inputs":{"description":"Describes the input tensors expected by this model.","items":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__InputTensorDescr"},"minItems":1,"title":"Inputs","type":"array"},"outputs":{"description":"Describes the output tensors.","items":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__OutputTensorDescr"},"minItems":1,"title":"Outputs","type":"array"},"packaged_by":{"description":"The persons that have packaged and uploaded this model.\nOnly required if those persons differ from the `authors`.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"title":"Packaged By","type":"array"},"parent":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__LinkedModel"},{"type":"null"}],"default":null,"description":"The model from which this model is derived, e.g. by fine-tuning the weights."},"run_mode":{"anyOf":[{"$ref":"#/$defs/RunMode"},{"type":"null"}],"default":null,"description":"Custom run mode for this model: for more complex prediction procedures like test time\ndata augmentation that currently cannot be expressed in the specification.\nNo standard run modes are defined yet."},"timestamp":{"$ref":"#/$defs/Datetime","description":"Timestamp in [ISO 8601](#https://en.wikipedia.org/wiki/ISO_8601) format\nwith a few restrictions listed [here](https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat).\n(In Python a datetime object is valid, too)."},"training_data":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__dataset__v0_3__LinkedDataset"},{"$ref":"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr"},{"$ref":"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr"},{"type":"null"}],"default":null,"description":"The dataset used to train this model","title":"Training Data"},"weights":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__WeightsDescr","description":"The weights for this model.\nWeights can be given for different formats, but should otherwise be equivalent.\nThe available weight formats determine which consumers can use this model."},"config":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__Config"}},"required":["name","description","authors","cite","license","format_version","type","documentation","inputs","outputs","weights"],"title":"model 0.5.4","type":"object"},"bioimageio__spec__model__v0_5__OnnxWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"Source of the weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"comment":{"default":"","description":"A comment about this weights entry, for example how these weights were created.","title":"Comment","type":"string"},"opset_version":{"description":"ONNX opset version","minimum":7,"title":"Opset Version","type":"integer"}},"required":["source","opset_version"],"title":"model.v0_5.OnnxWeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__OutputTensorDescr":{"additionalProperties":false,"properties":{"id":{"default":"output","description":"Output tensor id.\nNo duplicates are allowed across all inputs and outputs.","maxLength":32,"minLength":1,"title":"TensorId","type":"string"},"description":{"default":"","description":"free text description","maxLength":128,"title":"Description","type":"string"},"axes":{"description":"tensor axes","items":{"discriminator":{"mapping":{"batch":"#/$defs/BatchAxis","channel":"#/$defs/ChannelAxis","index":"#/$defs/IndexOutputAxis","space":{"oneOf":[{"$ref":"#/$defs/SpaceOutputAxis"},{"$ref":"#/$defs/SpaceOutputAxisWithHalo"}]},"time":{"oneOf":[{"$ref":"#/$defs/TimeOutputAxis"},{"$ref":"#/$defs/TimeOutputAxisWithHalo"}]}},"propertyName":"type"},"oneOf":[{"$ref":"#/$defs/BatchAxis"},{"$ref":"#/$defs/ChannelAxis"},{"$ref":"#/$defs/IndexOutputAxis"},{"oneOf":[{"$ref":"#/$defs/TimeOutputAxis"},{"$ref":"#/$defs/TimeOutputAxisWithHalo"}]},{"oneOf":[{"$ref":"#/$defs/SpaceOutputAxis"},{"$ref":"#/$defs/SpaceOutputAxisWithHalo"}]}]},"minItems":1,"title":"Axes","type":"array"},"test_tensor":{"$ref":"#/$defs/FileDescr","description":"An example tensor to use for testing.\nUsing the model with the test input tensors is expected to yield the test output tensors.\nEach test tensor has be a an ndarray in the\n[numpy.lib file format](https://numpy.org/doc/stable/reference/generated/numpy.lib.format.html#module-numpy.lib.format).\nThe file extension must be '.npy'."},"sample_tensor":{"anyOf":[{"$ref":"#/$defs/FileDescr"},{"type":"null"}],"default":null,"description":"A sample tensor to illustrate a possible input/output for the model,\nThe sample image primarily serves to inform a human user about an example use case\nand is typically stored as .hdf5, .png or .tiff.\nIt has to be readable by the [imageio library](https://imageio.readthedocs.io/en/stable/formats/index.html#supported-formats)\n(numpy's `.npy` format is not supported).\nThe image dimensionality has to match the number of axes specified in this tensor description."},"data":{"anyOf":[{"$ref":"#/$defs/NominalOrOrdinalDataDescr"},{"$ref":"#/$defs/IntervalOrRatioDataDescr"},{"items":{"anyOf":[{"$ref":"#/$defs/NominalOrOrdinalDataDescr"},{"$ref":"#/$defs/IntervalOrRatioDataDescr"}]},"minItems":1,"type":"array"}],"default":{"type":"float32","range":[null,null],"unit":"arbitrary unit","scale":1.0,"offset":null},"description":"Description of the tensor's data values, optionally per channel.\nIf specified per channel, the data `type` needs to match across channels.","title":"Data"},"postprocessing":{"description":"Description of how this output should be postprocessed.\n\nnote: `postprocessing` always ends with an 'ensure_dtype' operation.\n If not given this is added to cast to this tensor's `data.type`.","items":{"discriminator":{"mapping":{"binarize":"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr","clip":"#/$defs/bioimageio__spec__model__v0_5__ClipDescr","ensure_dtype":"#/$defs/EnsureDtypeDescr","fixed_zero_mean_unit_variance":"#/$defs/FixedZeroMeanUnitVarianceDescr","scale_linear":"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr","scale_mean_variance":"#/$defs/bioimageio__spec__model__v0_5__ScaleMeanVarianceDescr","scale_range":"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr","sigmoid":"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr","zero_mean_unit_variance":"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr"},"propertyName":"id"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__BinarizeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ClipDescr"},{"$ref":"#/$defs/EnsureDtypeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__SigmoidDescr"},{"$ref":"#/$defs/FixedZeroMeanUnitVarianceDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeDescr"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleMeanVarianceDescr"}]},"title":"Postprocessing","type":"array"}},"required":["axes","test_tensor"],"title":"model.v0_5.OutputTensorDescr","type":"object"},"bioimageio__spec__model__v0_5__PytorchStateDictWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"Source of the weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"comment":{"default":"","description":"A comment about this weights entry, for example how these weights were created.","title":"Comment","type":"string"},"architecture":{"anyOf":[{"$ref":"#/$defs/ArchitectureFromFileDescr"},{"$ref":"#/$defs/ArchitectureFromLibraryDescr"}],"title":"Architecture"},"pytorch_version":{"$ref":"#/$defs/Version","description":"Version of the PyTorch library used.\nIf `architecture.depencencies` is specified it has to include pytorch and any version pinning has to be compatible."},"dependencies":{"anyOf":[{"$ref":"#/$defs/FileDescr","examples":[{"source":"environment.yaml"}]},{"type":"null"}],"default":null,"description":"Custom depencies beyond pytorch described in a Conda environment file.\nAllows to specify custom dependencies, see conda docs:\n- [Exporting an environment file across platforms](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#exporting-an-environment-file-across-platforms)\n- [Creating an environment file manually](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-file-manually)\n\nThe conda environment file should include pytorch and any version pinning has to be compatible with\n**pytorch_version**."}},"required":["source","architecture","pytorch_version"],"title":"model.v0_5.PytorchStateDictWeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__ScaleLinearDescr":{"additionalProperties":false,"description":"Fixed linear scaling.\n\nExamples:\n 1. Scale with scalar gain and offset\n - in YAML\n ```yaml\n preprocessing:\n - id: scale_linear\n kwargs:\n gain: 2.0\n offset: 3.0\n ```\n - in Python:\n >>> preprocessing = [\n ... ScaleLinearDescr(kwargs=ScaleLinearKwargs(gain= 2.0, offset=3.0))\n ... ]\n\n 2. Independent scaling along an axis\n - in YAML\n ```yaml\n preprocessing:\n - id: scale_linear\n kwargs:\n axis: 'channel'\n gain: [1.0, 2.0, 3.0]\n ```\n - in Python:\n >>> preprocessing = [\n ... ScaleLinearDescr(\n ... kwargs=ScaleLinearAlongAxisKwargs(\n ... axis=AxisId(\"channel\"),\n ... gain=[1.0, 2.0, 3.0],\n ... )\n ... )\n ... ]","properties":{"id":{"const":"scale_linear","title":"Id","type":"string"},"kwargs":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleLinearKwargs"},{"$ref":"#/$defs/ScaleLinearAlongAxisKwargs"}],"title":"Kwargs"}},"required":["id","kwargs"],"title":"model.v0_5.ScaleLinearDescr","type":"object"},"bioimageio__spec__model__v0_5__ScaleLinearKwargs":{"additionalProperties":false,"description":"Key word arguments for `ScaleLinearDescr`","properties":{"gain":{"default":1.0,"description":"multiplicative factor","title":"Gain","type":"number"},"offset":{"default":0.0,"description":"additive term","title":"Offset","type":"number"}},"title":"model.v0_5.ScaleLinearKwargs","type":"object"},"bioimageio__spec__model__v0_5__ScaleMeanVarianceDescr":{"additionalProperties":false,"description":"Scale a tensor's data distribution to match another tensor's mean/std.\n`out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.`","properties":{"id":{"const":"scale_mean_variance","title":"Id","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleMeanVarianceKwargs"}},"required":["id","kwargs"],"title":"model.v0_5.ScaleMeanVarianceDescr","type":"object"},"bioimageio__spec__model__v0_5__ScaleMeanVarianceKwargs":{"additionalProperties":false,"description":"key word arguments for `ScaleMeanVarianceKwargs`","properties":{"reference_tensor":{"description":"Name of tensor to match.","maxLength":32,"minLength":1,"title":"TensorId","type":"string"},"axes":{"anyOf":[{"items":{"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"type":"array"},{"type":"null"}],"default":null,"description":"The subset of axes to normalize jointly, i.e. axes to reduce to compute mean/std.\nFor example to normalize 'batch', 'x' and 'y' jointly in a tensor ('batch', 'channel', 'y', 'x')\nresulting in a tensor of equal shape normalized per channel, specify `axes=('batch', 'x', 'y')`.\nTo normalize samples independently, leave out the 'batch' axis.\nDefault: Scale all axes jointly.","examples":[["batch","x","y"]],"title":"Axes"},"eps":{"default":1e-06,"description":"Epsilon for numeric stability:\n`out = (tensor - mean) / (std + eps) * (ref_std + eps) + ref_mean.`","exclusiveMinimum":0,"maximum":0.1,"title":"Eps","type":"number"}},"required":["reference_tensor"],"title":"model.v0_5.ScaleMeanVarianceKwargs","type":"object"},"bioimageio__spec__model__v0_5__ScaleRangeDescr":{"additionalProperties":false,"description":"Scale with percentiles.\n\nExamples:\n1. Scale linearly to map 5th percentile to 0 and 99.8th percentile to 1.0\n - in YAML\n ```yaml\n preprocessing:\n - id: scale_range\n kwargs:\n axes: ['y', 'x']\n max_percentile: 99.8\n min_percentile: 5.0\n ```\n - in Python\n >>> preprocessing = [\n ... ScaleRangeDescr(\n ... kwargs=ScaleRangeKwargs(\n ... axes= (AxisId('y'), AxisId('x')),\n ... max_percentile= 99.8,\n ... min_percentile= 5.0,\n ... )\n ... ),\n ... ClipDescr(\n ... kwargs=ClipKwargs(\n ... min=0.0,\n ... max=1.0,\n ... )\n ... ),\n ... ]\n\n 2. Combine the above scaling with additional clipping to clip values outside the range given by the percentiles.\n - in YAML\n ```yaml\n preprocessing:\n - id: scale_range\n kwargs:\n axes: ['y', 'x']\n max_percentile: 99.8\n min_percentile: 5.0\n - id: scale_range\n - id: clip\n kwargs:\n min: 0.0\n max: 1.0\n ```\n - in Python\n >>> preprocessing = [ScaleRangeDescr(\n ... kwargs=ScaleRangeKwargs(\n ... axes= (AxisId('y'), AxisId('x')),\n ... max_percentile= 99.8,\n ... min_percentile= 5.0,\n ... )\n ... )]","properties":{"id":{"const":"scale_range","title":"Id","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ScaleRangeKwargs"}},"required":["id","kwargs"],"title":"model.v0_5.ScaleRangeDescr","type":"object"},"bioimageio__spec__model__v0_5__ScaleRangeKwargs":{"additionalProperties":false,"description":"key word arguments for `ScaleRangeDescr`\n\nFor `min_percentile`=0.0 (the default) and `max_percentile`=100 (the default)\nthis processing step normalizes data to the [0, 1] intervall.\nFor other percentiles the normalized values will partially be outside the [0, 1]\nintervall. Use `ScaleRange` followed by `ClipDescr` if you want to limit the\nnormalized values to a range.","properties":{"axes":{"anyOf":[{"items":{"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"type":"array"},{"type":"null"}],"default":null,"description":"The subset of axes to normalize jointly, i.e. axes to reduce to compute the min/max percentile value.\nFor example to normalize 'batch', 'x' and 'y' jointly in a tensor ('batch', 'channel', 'y', 'x')\nresulting in a tensor of equal shape normalized per channel, specify `axes=('batch', 'x', 'y')`.\nTo normalize samples independently, leave out the \"batch\" axis.\nDefault: Scale all axes jointly.","examples":[["batch","x","y"]],"title":"Axes"},"min_percentile":{"default":0.0,"description":"The lower percentile used to determine the value to align with zero.","exclusiveMaximum":100,"minimum":0,"title":"Min Percentile","type":"number"},"max_percentile":{"default":100.0,"description":"The upper percentile used to determine the value to align with one.\nHas to be bigger than `min_percentile`.\nThe range is 1 to 100 instead of 0 to 100 to avoid mistakenly\naccepting percentiles specified in the range 0.0 to 1.0.","exclusiveMinimum":1,"maximum":100,"title":"Max Percentile","type":"number"},"eps":{"default":1e-06,"description":"Epsilon for numeric stability.\n`out = (tensor - v_lower) / (v_upper - v_lower + eps)`;\nwith `v_lower,v_upper` values at the respective percentiles.","exclusiveMinimum":0,"maximum":0.1,"title":"Eps","type":"number"},"reference_tensor":{"anyOf":[{"maxLength":32,"minLength":1,"title":"TensorId","type":"string"},{"type":"null"}],"default":null,"description":"Tensor ID to compute the percentiles from. Default: The tensor itself.\nFor any tensor in `inputs` only input tensor references are allowed.","title":"Reference Tensor"}},"title":"model.v0_5.ScaleRangeKwargs","type":"object"},"bioimageio__spec__model__v0_5__SigmoidDescr":{"additionalProperties":false,"description":"The logistic sigmoid funciton, a.k.a. expit function.\n\nExamples:\n- in YAML\n ```yaml\n postprocessing:\n - id: sigmoid\n ```\n- in Python:\n >>> postprocessing = [SigmoidDescr()]","properties":{"id":{"const":"sigmoid","title":"Id","type":"string"}},"required":["id"],"title":"model.v0_5.SigmoidDescr","type":"object"},"bioimageio__spec__model__v0_5__TensorflowJsWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The multi-file weights.\nAll required files/folders should be a zip archive.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"comment":{"default":"","description":"A comment about this weights entry, for example how these weights were created.","title":"Comment","type":"string"},"tensorflow_version":{"$ref":"#/$defs/Version","description":"Version of the TensorFlow library used."}},"required":["source","tensorflow_version"],"title":"model.v0_5.TensorflowJsWeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__TensorflowSavedModelBundleWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"The multi-file weights.\nAll required files/folders should be a zip archive.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"comment":{"default":"","description":"A comment about this weights entry, for example how these weights were created.","title":"Comment","type":"string"},"tensorflow_version":{"$ref":"#/$defs/Version","description":"Version of the TensorFlow library used."},"dependencies":{"anyOf":[{"$ref":"#/$defs/FileDescr","examples":[{"source":"environment.yaml"}]},{"type":"null"}],"default":null,"description":"Custom dependencies beyond tensorflow.\nShould include tensorflow and any version pinning has to be compatible with **tensorflow_version**."}},"required":["source","tensorflow_version"],"title":"model.v0_5.TensorflowSavedModelBundleWeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__TorchscriptWeightsDescr":{"additionalProperties":false,"properties":{"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"description":"Source of the weights file.","title":"Source"},"sha256":{"anyOf":[{"description":"A SHA-256 hash value","maxLength":64,"minLength":64,"title":"Sha256","type":"string"},{"type":"null"}],"default":null,"description":"SHA256 hash value of the **source** file.","title":"Sha256"},"authors":{"anyOf":[{"items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"type":"array"},{"type":"null"}],"default":null,"description":"Authors\nEither the person(s) that have trained this model resulting in the original weights file.\n (If this is the initial weights entry, i.e. it does not have a `parent`)\nOr the person(s) who have converted the weights to this weights format.\n (If this is a child weight, i.e. it has a `parent` field)","title":"Authors"},"parent":{"anyOf":[{"enum":["keras_hdf5","onnx","pytorch_state_dict","tensorflow_js","tensorflow_saved_model_bundle","torchscript"],"type":"string"},{"type":"null"}],"default":null,"description":"The source weights these weights were converted from.\nFor example, if a model's weights were converted from the `pytorch_state_dict` format to `torchscript`,\nThe `pytorch_state_dict` weights entry has no `parent` and is the parent of the `torchscript` weights.\nAll weight entries except one (the initial set of weights resulting from training the model),\nneed to have this field.","examples":["pytorch_state_dict"],"title":"Parent"},"comment":{"default":"","description":"A comment about this weights entry, for example how these weights were created.","title":"Comment","type":"string"},"pytorch_version":{"$ref":"#/$defs/Version","description":"Version of the PyTorch library used."}},"required":["source","pytorch_version"],"title":"model.v0_5.TorchscriptWeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__WeightsDescr":{"additionalProperties":false,"properties":{"keras_hdf5":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__KerasHdf5WeightsDescr"},{"type":"null"}],"default":null},"onnx":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__OnnxWeightsDescr"},{"type":"null"}],"default":null},"pytorch_state_dict":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__PytorchStateDictWeightsDescr"},{"type":"null"}],"default":null},"tensorflow_js":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__TensorflowJsWeightsDescr"},{"type":"null"}],"default":null},"tensorflow_saved_model_bundle":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__TensorflowSavedModelBundleWeightsDescr"},{"type":"null"}],"default":null},"torchscript":{"anyOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_5__TorchscriptWeightsDescr"},{"type":"null"}],"default":null}},"title":"model.v0_5.WeightsDescr","type":"object"},"bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceDescr":{"additionalProperties":false,"description":"Subtract mean and divide by variance.\n\nExamples:\n Subtract tensor mean and variance\n - in YAML\n ```yaml\n preprocessing:\n - id: zero_mean_unit_variance\n ```\n - in Python\n >>> preprocessing = [ZeroMeanUnitVarianceDescr()]","properties":{"id":{"const":"zero_mean_unit_variance","title":"Id","type":"string"},"kwargs":{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceKwargs"}},"required":["id"],"title":"model.v0_5.ZeroMeanUnitVarianceDescr","type":"object"},"bioimageio__spec__model__v0_5__ZeroMeanUnitVarianceKwargs":{"additionalProperties":false,"description":"key word arguments for `ZeroMeanUnitVarianceDescr`","properties":{"axes":{"anyOf":[{"items":{"maxLength":16,"minLength":1,"title":"AxisId","type":"string"},"type":"array"},{"type":"null"}],"default":null,"description":"The subset of axes to normalize jointly, i.e. axes to reduce to compute mean/std.\nFor example to normalize 'batch', 'x' and 'y' jointly in a tensor ('batch', 'channel', 'y', 'x')\nresulting in a tensor of equal shape normalized per channel, specify `axes=('batch', 'x', 'y')`.\nTo normalize each sample independently leave out the 'batch' axis.\nDefault: Scale all axes jointly.","examples":[["batch","x","y"]],"title":"Axes"},"eps":{"default":1e-06,"description":"epsilon for numeric stability: `out = (tensor - mean) / (std + eps)`.","exclusiveMinimum":0,"maximum":0.1,"title":"Eps","type":"number"}},"title":"model.v0_5.ZeroMeanUnitVarianceKwargs","type":"object"},"bioimageio__spec__notebook__v0_2__NotebookDescr":{"additionalProperties":false,"description":"Bioimage.io description of a Jupyter Notebook.","properties":{"name":{"description":"A human-friendly name of the resource description","minLength":1,"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg', '.tif', '.tiff')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":1,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of the RDF and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Author"},"title":"Authors","type":"array"},"attachments":{"anyOf":[{"$ref":"#/$defs/AttachmentsDescr"},{"type":"null"}],"default":null,"description":"file and other attachments"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__CiteEntry"},"title":"Cite","type":"array"},"config":{"additionalProperties":{"$ref":"#/$defs/YamlValue"},"description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a github repo URL in `config` since we already have the\n`git_repo` field defined in the spec.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n bioimageio: # here is the domain name\n my_custom_key: 3837283\n another_key:\n nested: value\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource\n(packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files)","examples":[{"bioimageio":{"another_key":{"nested":"value"},"my_custom_key":3837283},"imagej":{"macro_dir":"path/to/macro/file"}}],"title":"Config","type":"object"},"download_url":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"URL to download the resource from (deprecated)","title":"Download Url"},"git_repo":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified `authors` are maintainers and at least some of them should specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_2__Maintainer"},"title":"Maintainers","type":"array"},"rdf_source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"Resource description file (RDF) source; used to keep track of where an rdf.yaml was loaded from.\nDo not set this field in a YAML file.","title":"Rdf Source"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"version_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"version number (n-th published version, not the semantic version)","title":"Version Number"},"format_version":{"const":"0.2.4","description":"The format version of this resource specification\n(not the `version` of the resource description)\nWhen creating a new resource always use the latest micro/patch version described here.\nThe `format_version` is important for any consumer software to understand how to parse the fields.","title":"Format Version","type":"string"},"badges":{"description":"badges associated with this resource","items":{"$ref":"#/$defs/BadgeDescr"},"title":"Badges","type":"array"},"documentation":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"URL or relative path to a markdown file with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.","examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"],"title":"Documentation"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"},{"type":"string"},{"type":"null"}],"default":null,"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose\n) to discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"type":{"const":"notebook","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"NotebookId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"format":"file-path","title":"FilePath","type":"string"},{"$ref":"#/$defs/RelativeFilePath"}],"description":"The Jupyter notebook","title":"Source"}},"required":["name","description","format_version","type","source"],"title":"notebook 0.2.4","type":"object"},"bioimageio__spec__notebook__v0_3__NotebookDescr":{"additionalProperties":false,"description":"Bioimage.io description of a Jupyter notebook.","properties":{"name":{"description":"A human-friendly name of the resource description.\nMay only contains letters, digits, underscore, minus, parentheses and spaces.","maxLength":128,"minLength":1,"title":"Name","type":"string"},"description":{"description":"A string containing a brief description.","maxLength":1024,"title":"Description","type":"string"},"covers":{"description":"Cover images. Please use an image smaller than 500KB and an aspect ratio width to height of 2:1 or 1:1.\nThe supported image formats are: ('.gif', '.jpeg', '.jpg', '.png', '.svg')","examples":[["cover.png"]],"items":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}]},"title":"Covers","type":"array"},"id_emoji":{"anyOf":[{"examples":["\ud83e\udd88","\ud83e\udda5"],"maxLength":2,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"UTF-8 emoji for display alongside the `id`.","title":"Id Emoji"},"authors":{"description":"The authors are the creators of this resource description and the primary points of contact.","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Author"},"minItems":1,"title":"Authors","type":"array"},"attachments":{"description":"file attachments","items":{"$ref":"#/$defs/FileDescr"},"title":"Attachments","type":"array"},"cite":{"description":"citations","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__CiteEntry"},"minItems":1,"title":"Cite","type":"array"},"license":{"anyOf":[{"enum":["0BSD","AAL","Abstyles","AdaCore-doc","Adobe-2006","Adobe-Display-PostScript","Adobe-Glyph","Adobe-Utopia","ADSL","AFL-1.1","AFL-1.2","AFL-2.0","AFL-2.1","AFL-3.0","Afmparse","AGPL-1.0-only","AGPL-1.0-or-later","AGPL-3.0-only","AGPL-3.0-or-later","Aladdin","AMDPLPA","AML","AML-glslang","AMPAS","ANTLR-PD","ANTLR-PD-fallback","Apache-1.0","Apache-1.1","Apache-2.0","APAFML","APL-1.0","App-s2p","APSL-1.0","APSL-1.1","APSL-1.2","APSL-2.0","Arphic-1999","Artistic-1.0","Artistic-1.0-cl8","Artistic-1.0-Perl","Artistic-2.0","ASWF-Digital-Assets-1.0","ASWF-Digital-Assets-1.1","Baekmuk","Bahyph","Barr","bcrypt-Solar-Designer","Beerware","Bitstream-Charter","Bitstream-Vera","BitTorrent-1.0","BitTorrent-1.1","blessing","BlueOak-1.0.0","Boehm-GC","Borceux","Brian-Gladman-2-Clause","Brian-Gladman-3-Clause","BSD-1-Clause","BSD-2-Clause","BSD-2-Clause-Darwin","BSD-2-Clause-Patent","BSD-2-Clause-Views","BSD-3-Clause","BSD-3-Clause-acpica","BSD-3-Clause-Attribution","BSD-3-Clause-Clear","BSD-3-Clause-flex","BSD-3-Clause-HP","BSD-3-Clause-LBNL","BSD-3-Clause-Modification","BSD-3-Clause-No-Military-License","BSD-3-Clause-No-Nuclear-License","BSD-3-Clause-No-Nuclear-License-2014","BSD-3-Clause-No-Nuclear-Warranty","BSD-3-Clause-Open-MPI","BSD-3-Clause-Sun","BSD-4-Clause","BSD-4-Clause-Shortened","BSD-4-Clause-UC","BSD-4.3RENO","BSD-4.3TAHOE","BSD-Advertising-Acknowledgement","BSD-Attribution-HPND-disclaimer","BSD-Inferno-Nettverk","BSD-Protection","BSD-Source-beginning-file","BSD-Source-Code","BSD-Systemics","BSD-Systemics-W3Works","BSL-1.0","BUSL-1.1","bzip2-1.0.6","C-UDA-1.0","CAL-1.0","CAL-1.0-Combined-Work-Exception","Caldera","Caldera-no-preamble","CATOSL-1.1","CC-BY-1.0","CC-BY-2.0","CC-BY-2.5","CC-BY-2.5-AU","CC-BY-3.0","CC-BY-3.0-AT","CC-BY-3.0-AU","CC-BY-3.0-DE","CC-BY-3.0-IGO","CC-BY-3.0-NL","CC-BY-3.0-US","CC-BY-4.0","CC-BY-NC-1.0","CC-BY-NC-2.0","CC-BY-NC-2.5","CC-BY-NC-3.0","CC-BY-NC-3.0-DE","CC-BY-NC-4.0","CC-BY-NC-ND-1.0","CC-BY-NC-ND-2.0","CC-BY-NC-ND-2.5","CC-BY-NC-ND-3.0","CC-BY-NC-ND-3.0-DE","CC-BY-NC-ND-3.0-IGO","CC-BY-NC-ND-4.0","CC-BY-NC-SA-1.0","CC-BY-NC-SA-2.0","CC-BY-NC-SA-2.0-DE","CC-BY-NC-SA-2.0-FR","CC-BY-NC-SA-2.0-UK","CC-BY-NC-SA-2.5","CC-BY-NC-SA-3.0","CC-BY-NC-SA-3.0-DE","CC-BY-NC-SA-3.0-IGO","CC-BY-NC-SA-4.0","CC-BY-ND-1.0","CC-BY-ND-2.0","CC-BY-ND-2.5","CC-BY-ND-3.0","CC-BY-ND-3.0-DE","CC-BY-ND-4.0","CC-BY-SA-1.0","CC-BY-SA-2.0","CC-BY-SA-2.0-UK","CC-BY-SA-2.1-JP","CC-BY-SA-2.5","CC-BY-SA-3.0","CC-BY-SA-3.0-AT","CC-BY-SA-3.0-DE","CC-BY-SA-3.0-IGO","CC-BY-SA-4.0","CC-PDDC","CC0-1.0","CDDL-1.0","CDDL-1.1","CDL-1.0","CDLA-Permissive-1.0","CDLA-Permissive-2.0","CDLA-Sharing-1.0","CECILL-1.0","CECILL-1.1","CECILL-2.0","CECILL-2.1","CECILL-B","CECILL-C","CERN-OHL-1.1","CERN-OHL-1.2","CERN-OHL-P-2.0","CERN-OHL-S-2.0","CERN-OHL-W-2.0","CFITSIO","check-cvs","checkmk","ClArtistic","Clips","CMU-Mach","CMU-Mach-nodoc","CNRI-Jython","CNRI-Python","CNRI-Python-GPL-Compatible","COIL-1.0","Community-Spec-1.0","Condor-1.1","copyleft-next-0.3.0","copyleft-next-0.3.1","Cornell-Lossless-JPEG","CPAL-1.0","CPL-1.0","CPOL-1.02","Cronyx","Crossword","CrystalStacker","CUA-OPL-1.0","Cube","curl","D-FSL-1.0","DEC-3-Clause","diffmark","DL-DE-BY-2.0","DL-DE-ZERO-2.0","DOC","Dotseqn","DRL-1.0","DRL-1.1","DSDP","dtoa","dvipdfm","ECL-1.0","ECL-2.0","EFL-1.0","EFL-2.0","eGenix","Elastic-2.0","Entessa","EPICS","EPL-1.0","EPL-2.0","ErlPL-1.1","etalab-2.0","EUDatagrid","EUPL-1.0","EUPL-1.1","EUPL-1.2","Eurosym","Fair","FBM","FDK-AAC","Ferguson-Twofish","Frameworx-1.0","FreeBSD-DOC","FreeImage","FSFAP","FSFAP-no-warranty-disclaimer","FSFUL","FSFULLR","FSFULLRWD","FTL","Furuseth","fwlw","GCR-docs","GD","GFDL-1.1-invariants-only","GFDL-1.1-invariants-or-later","GFDL-1.1-no-invariants-only","GFDL-1.1-no-invariants-or-later","GFDL-1.1-only","GFDL-1.1-or-later","GFDL-1.2-invariants-only","GFDL-1.2-invariants-or-later","GFDL-1.2-no-invariants-only","GFDL-1.2-no-invariants-or-later","GFDL-1.2-only","GFDL-1.2-or-later","GFDL-1.3-invariants-only","GFDL-1.3-invariants-or-later","GFDL-1.3-no-invariants-only","GFDL-1.3-no-invariants-or-later","GFDL-1.3-only","GFDL-1.3-or-later","Giftware","GL2PS","Glide","Glulxe","GLWTPL","gnuplot","GPL-1.0-only","GPL-1.0-or-later","GPL-2.0-only","GPL-2.0-or-later","GPL-3.0-only","GPL-3.0-or-later","Graphics-Gems","gSOAP-1.3b","gtkbook","HaskellReport","hdparm","Hippocratic-2.1","HP-1986","HP-1989","HPND","HPND-DEC","HPND-doc","HPND-doc-sell","HPND-export-US","HPND-export-US-modify","HPND-Fenneberg-Livingston","HPND-INRIA-IMAG","HPND-Kevlin-Henney","HPND-Markus-Kuhn","HPND-MIT-disclaimer","HPND-Pbmplus","HPND-sell-MIT-disclaimer-xserver","HPND-sell-regexpr","HPND-sell-variant","HPND-sell-variant-MIT-disclaimer","HPND-UC","HTMLTIDY","IBM-pibs","ICU","IEC-Code-Components-EULA","IJG","IJG-short","ImageMagick","iMatix","Imlib2","Info-ZIP","Inner-Net-2.0","Intel","Intel-ACPI","Interbase-1.0","IPA","IPL-1.0","ISC","ISC-Veillard","Jam","JasPer-2.0","JPL-image","JPNIC","JSON","Kastrup","Kazlib","Knuth-CTAN","LAL-1.2","LAL-1.3","Latex2e","Latex2e-translated-notice","Leptonica","LGPL-2.0-only","LGPL-2.0-or-later","LGPL-2.1-only","LGPL-2.1-or-later","LGPL-3.0-only","LGPL-3.0-or-later","LGPLLR","Libpng","libpng-2.0","libselinux-1.0","libtiff","libutil-David-Nugent","LiLiQ-P-1.1","LiLiQ-R-1.1","LiLiQ-Rplus-1.1","Linux-man-pages-1-para","Linux-man-pages-copyleft","Linux-man-pages-copyleft-2-para","Linux-man-pages-copyleft-var","Linux-OpenIB","LOOP","LPD-document","LPL-1.0","LPL-1.02","LPPL-1.0","LPPL-1.1","LPPL-1.2","LPPL-1.3a","LPPL-1.3c","lsof","Lucida-Bitmap-Fonts","LZMA-SDK-9.11-to-9.20","LZMA-SDK-9.22","Mackerras-3-Clause","Mackerras-3-Clause-acknowledgment","magaz","mailprio","MakeIndex","Martin-Birgmeier","McPhee-slideshow","metamail","Minpack","MirOS","MIT","MIT-0","MIT-advertising","MIT-CMU","MIT-enna","MIT-feh","MIT-Festival","MIT-Modern-Variant","MIT-open-group","MIT-testregex","MIT-Wu","MITNFA","MMIXware","Motosoto","MPEG-SSG","mpi-permissive","mpich2","MPL-1.0","MPL-1.1","MPL-2.0","MPL-2.0-no-copyleft-exception","mplus","MS-LPL","MS-PL","MS-RL","MTLL","MulanPSL-1.0","MulanPSL-2.0","Multics","Mup","NAIST-2003","NASA-1.3","Naumen","NBPL-1.0","NCGL-UK-2.0","NCSA","Net-SNMP","NetCDF","Newsletr","NGPL","NICTA-1.0","NIST-PD","NIST-PD-fallback","NIST-Software","NLOD-1.0","NLOD-2.0","NLPL","Nokia","NOSL","Noweb","NPL-1.0","NPL-1.1","NPOSL-3.0","NRL","NTP","NTP-0","O-UDA-1.0","OCCT-PL","OCLC-2.0","ODbL-1.0","ODC-By-1.0","OFFIS","OFL-1.0","OFL-1.0-no-RFN","OFL-1.0-RFN","OFL-1.1","OFL-1.1-no-RFN","OFL-1.1-RFN","OGC-1.0","OGDL-Taiwan-1.0","OGL-Canada-2.0","OGL-UK-1.0","OGL-UK-2.0","OGL-UK-3.0","OGTSL","OLDAP-1.1","OLDAP-1.2","OLDAP-1.3","OLDAP-1.4","OLDAP-2.0","OLDAP-2.0.1","OLDAP-2.1","OLDAP-2.2","OLDAP-2.2.1","OLDAP-2.2.2","OLDAP-2.3","OLDAP-2.4","OLDAP-2.5","OLDAP-2.6","OLDAP-2.7","OLDAP-2.8","OLFL-1.3","OML","OpenPBS-2.3","OpenSSL","OpenSSL-standalone","OpenVision","OPL-1.0","OPL-UK-3.0","OPUBL-1.0","OSET-PL-2.1","OSL-1.0","OSL-1.1","OSL-2.0","OSL-2.1","OSL-3.0","PADL","Parity-6.0.0","Parity-7.0.0","PDDL-1.0","PHP-3.0","PHP-3.01","Pixar","Plexus","pnmstitch","PolyForm-Noncommercial-1.0.0","PolyForm-Small-Business-1.0.0","PostgreSQL","PSF-2.0","psfrag","psutils","Python-2.0","Python-2.0.1","python-ldap","Qhull","QPL-1.0","QPL-1.0-INRIA-2004","radvd","Rdisc","RHeCos-1.1","RPL-1.1","RPL-1.5","RPSL-1.0","RSA-MD","RSCPL","Ruby","SAX-PD","SAX-PD-2.0","Saxpath","SCEA","SchemeReport","Sendmail","Sendmail-8.23","SGI-B-1.0","SGI-B-1.1","SGI-B-2.0","SGI-OpenGL","SGP4","SHL-0.5","SHL-0.51","SimPL-2.0","SISSL","SISSL-1.2","SL","Sleepycat","SMLNJ","SMPPL","SNIA","snprintf","softSurfer","Soundex","Spencer-86","Spencer-94","Spencer-99","SPL-1.0","ssh-keyscan","SSH-OpenSSH","SSH-short","SSLeay-standalone","SSPL-1.0","SugarCRM-1.1.3","Sun-PPP","SunPro","SWL","swrule","Symlinks","TAPR-OHL-1.0","TCL","TCP-wrappers","TermReadKey","TGPPL-1.0","TMate","TORQUE-1.1","TOSL","TPDL","TPL-1.0","TTWL","TTYP0","TU-Berlin-1.0","TU-Berlin-2.0","UCAR","UCL-1.0","ulem","UMich-Merit","Unicode-3.0","Unicode-DFS-2015","Unicode-DFS-2016","Unicode-TOU","UnixCrypt","Unlicense","UPL-1.0","URT-RLE","Vim","VOSTROM","VSL-1.0","W3C","W3C-19980720","W3C-20150513","w3m","Watcom-1.0","Widget-Workshop","Wsuipa","WTFPL","X11","X11-distribute-modifications-variant","Xdebug-1.03","Xerox","Xfig","XFree86-1.1","xinetd","xkeyboard-config-Zinoviev","xlock","Xnet","xpp","XSkat","YPL-1.0","YPL-1.1","Zed","Zeeff","Zend-2.0","Zimbra-1.3","Zimbra-1.4","Zlib","zlib-acknowledgement","ZPL-1.1","ZPL-2.0","ZPL-2.1"],"title":"LicenseId","type":"string"},{"enum":["AGPL-1.0","AGPL-3.0","BSD-2-Clause-FreeBSD","BSD-2-Clause-NetBSD","bzip2-1.0.5","eCos-2.0","GFDL-1.1","GFDL-1.2","GFDL-1.3","GPL-1.0","GPL-1.0+","GPL-2.0","GPL-2.0+","GPL-2.0-with-autoconf-exception","GPL-2.0-with-bison-exception","GPL-2.0-with-classpath-exception","GPL-2.0-with-font-exception","GPL-2.0-with-GCC-exception","GPL-3.0","GPL-3.0+","GPL-3.0-with-autoconf-exception","GPL-3.0-with-GCC-exception","LGPL-2.0","LGPL-2.0+","LGPL-2.1","LGPL-2.1+","LGPL-3.0","LGPL-3.0+","Nunit","StandardML-NJ","wxWindows"],"title":"DeprecatedLicenseId","type":"string"}],"description":"A [SPDX license identifier](https://spdx.org/licenses/).\nWe do not support custom license beyond the SPDX license list, if you need that please\n[open a GitHub issue](https://github.com/bioimage-io/spec-bioimage-io/issues/new/choose)\nto discuss your intentions with the community.","examples":["CC0-1.0","MIT","BSD-2-Clause"],"title":"License"},"git_repo":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"type":"null"}],"default":null,"description":"A URL to the Git repository where the resource is being developed.","examples":["https://github.com/bioimage-io/spec-bioimage-io/tree/main/example_descriptions/models/unet2d_nuclei_broad"],"title":"Git Repo"},"icon":{"anyOf":[{"maxLength":2,"minLength":1,"type":"string"},{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"},{"type":"null"}],"default":null,"description":"An icon for illustration, e.g. on bioimage.io","title":"Icon"},"links":{"description":"IDs of other bioimage.io resources","examples":[["ilastik/ilastik","deepimagej/deepimagej","zero/notebook_u-net_3d_zerocostdl4mic"]],"items":{"type":"string"},"title":"Links","type":"array"},"uploader":{"anyOf":[{"$ref":"#/$defs/Uploader"},{"type":"null"}],"default":null,"description":"The person who uploaded the model (e.g. to bioimage.io)"},"maintainers":{"description":"Maintainers of this resource.\nIf not specified, `authors` are maintainers and at least some of them has to specify their `github_user` name","items":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Maintainer"},"title":"Maintainers","type":"array"},"tags":{"description":"Associated tags","examples":[["unet2d","pytorch","nucleus","segmentation","dsb2018"]],"items":{"type":"string"},"title":"Tags","type":"array"},"version":{"anyOf":[{"$ref":"#/$defs/Version"},{"type":"null"}],"default":null,"description":"The version of the resource following SemVer 2.0."},"format_version":{"const":"0.3.0","description":"The **format** version of this resource specification","title":"Format Version","type":"string"},"documentation":{"anyOf":[{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"$ref":"#/$defs/RelativeFilePath"},{"format":"file-path","title":"FilePath","type":"string"}],"examples":["https://raw.githubusercontent.com/bioimage-io/spec-bioimage-io/main/example_descriptions/models/unet2d_nuclei_broad/README.md","README.md"]},{"type":"null"}],"default":null,"description":"URL or relative path to a markdown file encoded in UTF-8 with additional documentation.\nThe recommended documentation file name is `README.md`. An `.md` suffix is mandatory.","title":"Documentation"},"badges":{"description":"badges associated with this resource","items":{"$ref":"#/$defs/BadgeDescr"},"title":"Badges","type":"array"},"config":{"$ref":"#/$defs/bioimageio__spec__generic__v0_3__Config","description":"A field for custom configuration that can contain any keys not present in the RDF spec.\nThis means you should not store, for example, a GitHub repo URL in `config` since there is a `git_repo` field.\nKeys in `config` may be very specific to a tool or consumer software. To avoid conflicting definitions,\nit is recommended to wrap added configuration into a sub-field named with the specific domain or tool name,\nfor example:\n```yaml\nconfig:\n giraffe_neckometer: # here is the domain name\n length: 3837283\n address:\n home: zoo\n imagej: # config specific to ImageJ\n macro_dir: path/to/macro/file\n```\nIf possible, please use [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) for keys in `config`.\nYou may want to list linked files additionally under `attachments` to include them when packaging a resource.\n(Packaging a resource means downloading/copying important linked files and creating a ZIP archive that contains\nan altered rdf.yaml file with local references to the downloaded files.)"},"type":{"const":"notebook","title":"Type","type":"string"},"id":{"anyOf":[{"minLength":1,"title":"NotebookId","type":"string"},{"type":"null"}],"default":null,"description":"bioimage.io-wide unique resource identifier\nassigned by bioimage.io; version **un**specific.","title":"Id"},"parent":{"anyOf":[{"minLength":1,"title":"NotebookId","type":"string"},{"type":"null"}],"default":null,"description":"The description from which this one is derived","title":"Parent"},"source":{"anyOf":[{"description":"A URL with the HTTP or HTTPS scheme.","format":"uri","maxLength":2083,"minLength":1,"title":"HttpUrl","type":"string"},{"format":"file-path","title":"FilePath","type":"string"},{"$ref":"#/$defs/RelativeFilePath"}],"description":"The Jupyter notebook","title":"Source"}},"required":["name","description","authors","cite","license","format_version","type","source"],"title":"notebook 0.3.0","type":"object"}},"discriminator":{"mapping":{"application":{"discriminator":{"mapping":{"0.2.4":"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr","0.3.0":"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr","title":"application 0.2"},{"$ref":"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr","title":"application 0.3"}],"title":"application"},"dataset":{"discriminator":{"mapping":{"0.2.4":"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr","0.3.0":"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr","title":"dataset 0.2"},{"$ref":"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr","title":"dataset 0.3"}],"title":"dataset"},"model":{"discriminator":{"mapping":{"0.4.10":"#/$defs/bioimageio__spec__model__v0_4__ModelDescr","0.5.4":"#/$defs/bioimageio__spec__model__v0_5__ModelDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ModelDescr","title":"model 0.4"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ModelDescr","title":"model 0.5"}],"title":"model"},"notebook":{"discriminator":{"mapping":{"0.2.4":"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr","0.3.0":"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr","title":"notebook 0.2"},{"$ref":"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr","title":"notebook 0.3"}],"title":"notebook"}},"propertyName":"type"},"oneOf":[{"discriminator":{"mapping":{"0.2.4":"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr","0.3.0":"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__application__v0_2__ApplicationDescr","title":"application 0.2"},{"$ref":"#/$defs/bioimageio__spec__application__v0_3__ApplicationDescr","title":"application 0.3"}],"title":"application"},{"discriminator":{"mapping":{"0.2.4":"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr","0.3.0":"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__dataset__v0_2__DatasetDescr","title":"dataset 0.2"},{"$ref":"#/$defs/bioimageio__spec__dataset__v0_3__DatasetDescr","title":"dataset 0.3"}],"title":"dataset"},{"discriminator":{"mapping":{"0.4.10":"#/$defs/bioimageio__spec__model__v0_4__ModelDescr","0.5.4":"#/$defs/bioimageio__spec__model__v0_5__ModelDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__model__v0_4__ModelDescr","title":"model 0.4"},{"$ref":"#/$defs/bioimageio__spec__model__v0_5__ModelDescr","title":"model 0.5"}],"title":"model"},{"discriminator":{"mapping":{"0.2.4":"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr","0.3.0":"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr"},"propertyName":"format_version"},"oneOf":[{"$ref":"#/$defs/bioimageio__spec__notebook__v0_2__NotebookDescr","title":"notebook 0.2"},{"$ref":"#/$defs/bioimageio__spec__notebook__v0_3__NotebookDescr","title":"notebook 0.3"}],"title":"notebook"}]}
|
Provide a JSON object that satisfies the schema "bioimageio_schema_latest". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
bioimageio_schema_latest
|
schema-store
|
schema_store_90
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\",\"$id\":\"https://raw.githubusercontent.com/bitmovin/bitmovin-api-sdk-examples/main/bitmovin-encoding-template.json\",\"title\":\"Bitmovin Encoding Template JSON Schema\",\"description\":\"An encoding workflow from a single configuration template\",\"properties\":{\"metaData\":{\"type\":\"object\",\"description\":\"Metadata for the encoding template\",\"properties\":{\"name\":{\"description\":\"Metadata for the encoding template\",\"type\":\"string\"},\"type\":{\"description\":\"The type of the encoding template\",\"enum\":[\"VOD\",\"LIVE\"],\"type\":\"string\"}},\"required\":[\"name\",\"type\"]},\"inputs\":{\"type\":\"object\",\"properties\":{\"redundantRtmp\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"RedundantRtmpInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"delayThreshold\":{\"description\":\"When there is no input signal present and this threshold in seconds is reached it will switch to another ingest point\",\"type\":\"integer\"},\"ingestPoints\":{\"description\":\"Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live\\nEither ingestPoints **or** staticIngestPoints can be set\\n\",\"items\":{\"type\":\"object\",\"title\":\"RtmpIngestPoint\",\"properties\":{\"applicationName\":{\"description\":\"The name of the application where the ingest is streamed to. This has to be unique for each ingest point\",\"type\":\"string\"},\"streamKey\":{\"description\":\"The stream key for the backup input\",\"type\":\"string\"}},\"required\":[\"applicationName\",\"streamKey\"]},\"type\":\"array\"},\"staticIngestPoints\":{\"description\":\"Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live\\nEither ingestPoints **or** staticIngestPoints can be set\\n\",\"items\":{\"type\":\"object\",\"title\":\"StaticRtmpIngestPoint\",\"properties\":{\"id\":{\"description\":\"The ID of the created static rtmp ingest point\\n\",\"type\":\"string\"},\"name\":{\"description\":\"Name of the ingest point. This can be helpful for easier identifying your ingest points\\n\",\"type\":\"string\"},\"streamKeyConfiguration\":{\"type\":\"object\",\"properties\":{\"type\":{\"title\":\"StreamKeyConfigurationType\",\"enum\":[\"GENERATE\",\"ASSIGN\"],\"type\":\"string\"},\"streamKeyId\":{\"description\":\"Id of the previously generated stream key. \\nOnly needed when the type is `ASSIGN`.\\n\",\"type\":\"string\"}},\"required\":[\"type\"]}}},\"type\":\"array\"}}}},\"required\":[\"properties\"]}}},\"s3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"S3Input\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"cloudRegion\":{\"description\":\"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.\",\"enum\":[\"US_EAST_1\",\"US_EAST_2\",\"US_WEST_1\",\"US_WEST_2\",\"EU_WEST_1\",\"EU_CENTRAL_1\",\"AP_SOUTHEAST_1\",\"AP_SOUTHEAST_2\",\"AP_NORTHEAST_1\",\"AP_NORTHEAST_2\",\"AP_SOUTH_1\",\"SA_EAST_1\",\"EU_WEST_2\",\"EU_WEST_3\",\"CA_CENTRAL_1\",\"EU_NORTH_1\"],\"type\":\"string\"},\"bucketName\":{\"description\":\"Name of the bucket\",\"type\":\"string\"},\"accessKey\":{\"description\":\"Amazon access key\",\"type\":\"string\"},\"secretKey\":{\"description\":\"Amazon secret key\",\"type\":\"string\"}},\"required\":[\"accessKey\",\"bucketName\",\"secretKey\"]}},\"required\":[\"properties\"]}}},\"s3RoleBased\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"S3RoleBasedInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bucketName\":{\"description\":\"Amazon S3 bucket name\",\"type\":\"string\"},\"roleArn\":{\"description\":\"Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access.\\n\\nThis role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added\\nto the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\n\\nwhere \\\"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\\\" is the Bitmovin user used for the access.\\nThe `Condition` is optional but we highly recommend it, see property `externalId` below for more information.\\n\\nThis setup allows Bitmovin assume the provided IAM role and to read data from your S3 bucket. Please note that the IAM role has to have read access on S3.\\n\\nFor more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume S3 access.\\n\\nThis ID is provided by the API if `externalIdMode` is set to `GLOBAL` or `GENERATED`. If present, it has to be added to the trust policy of the IAM role `roleArn` configured above, otherwise the API won't be able to read from the S3 bucket. An appropriate trust policy would look like this:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\n\\nwhere \\\"{{externalId}}\\\" is the generated ID.\\n\\nThis property is optional but we recommend it as an additional security feature. We will use both the `roleArn` and the `externalId` to access your S3 data.\\nIf the Amazon IAM role has an external ID configured but it is not provided in the input configuration Bitmovin won't be able to read from the S3 bucket. Also if the\\nexternal ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket.\\n\\nIf you need to change the external ID that is used by your IAM role, you need to create a new input, and use the external ID provided by the API to update your IAM role.\\n\\nFor more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"cloudRegion\":{\"enum\":[\"US_EAST_1\",\"US_EAST_2\",\"US_WEST_1\",\"US_WEST_2\",\"EU_WEST_1\",\"EU_CENTRAL_1\",\"AP_SOUTHEAST_1\",\"AP_SOUTHEAST_2\",\"AP_NORTHEAST_1\",\"AP_NORTHEAST_2\",\"AP_SOUTH_1\",\"SA_EAST_1\",\"EU_WEST_2\",\"EU_WEST_3\",\"CA_CENTRAL_1\",\"EU_NORTH_1\"],\"type\":\"string\"}},\"required\":[\"bucketName\",\"roleArn\"]}},\"required\":[\"properties\"]}}},\"genericS3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"GenericS3Input\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bucketName\":{\"description\":\"Your generic S3 bucket name\",\"type\":\"string\"},\"host\":{\"description\":\"The generic S3 server hostname (or IP address)\",\"type\":\"string\"},\"port\":{\"description\":\"The port on which the generic S3 server is running on (if not provided 8000 will be used)\",\"type\":\"integer\"},\"ssl\":{\"type\":\"boolean\",\"description\":\"Controls whether SSL is used or not\"},\"signingRegion\":{\"description\":\"The signing region to use\",\"type\":\"string\"},\"signatureVersion\":{\"description\":\"Specifies the method used for authentication\",\"enum\":[\"S3_V2\",\"S3_V4\"],\"type\":\"string\"},\"accessKey\":{\"description\":\"Your generic S3 access key\",\"type\":\"string\"},\"secretKey\":{\"description\":\"Your generic S3 secret key\",\"type\":\"string\"},\"accessStyle\":{\"description\":\"Specifies the URL access style to use\",\"enum\":[\"VIRTUAL_HOSTED\",\"PATH\"],\"type\":\"string\"}},\"required\":[\"accessKey\",\"bucketName\",\"host\",\"secretKey\"]}},\"required\":[\"properties\"]}}},\"local\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"LocalInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"path\":{\"description\":\"Path to your local storage\",\"type\":\"string\"}},\"required\":[\"path\"]}},\"required\":[\"properties\"]}}},\"gcs\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"GcsInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bucketName\":{\"description\":\"Name of the bucket\",\"type\":\"string\"},\"cloudRegion\":{\"description\":\"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.\",\"enum\":[\"US_CENTRAL_1\",\"US_EAST_1\",\"ASIA_EAST_1\",\"EUROPE_WEST_1\",\"US_WEST_1\",\"ASIA_EAST_2\",\"ASIA_NORTHEAST_1\",\"ASIA_SOUTH_1\",\"ASIA_SOUTHEAST_1\",\"AUSTRALIA_SOUTHEAST_1\",\"EUROPE_NORTH_1\",\"EUROPE_WEST_2\",\"EUROPE_WEST_3\",\"EUROPE_WEST_4\",\"NORTHAMERICA_NORTHEAST_1\",\"SOUTHAMERICA_EAST_1\",\"US_EAST_4\",\"US_WEST_2\",\"ME_CENTRAL_2\"],\"type\":\"string\"},\"accessKey\":{\"description\":\"GCS access key\",\"type\":\"string\"},\"secretKey\":{\"description\":\"GCS secret key\",\"type\":\"string\"}},\"required\":[\"accessKey\",\"bucketName\",\"secretKey\"]}},\"required\":[\"properties\"]}}},\"gcsServiceAccount\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"GcsServiceAccountInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"serviceAccountCredentials\":{\"description\":\"GCS projectId\",\"type\":\"string\"},\"bucketName\":{\"description\":\"Name of the bucket\",\"type\":\"string\"},\"cloudRegion\":{\"description\":\"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.\",\"enum\":[\"US_CENTRAL_1\",\"US_EAST_1\",\"ASIA_EAST_1\",\"EUROPE_WEST_1\",\"US_WEST_1\",\"ASIA_EAST_2\",\"ASIA_NORTHEAST_1\",\"ASIA_SOUTH_1\",\"ASIA_SOUTHEAST_1\",\"AUSTRALIA_SOUTHEAST_1\",\"EUROPE_NORTH_1\",\"EUROPE_WEST_2\",\"EUROPE_WEST_3\",\"EUROPE_WEST_4\",\"NORTHAMERICA_NORTHEAST_1\",\"SOUTHAMERICA_EAST_1\",\"US_EAST_4\",\"US_WEST_2\",\"ME_CENTRAL_2\"],\"type\":\"string\"}},\"required\":[\"bucketName\",\"serviceAccountCredentials\"]}},\"required\":[\"properties\"]}}},\"azure\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AzureInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"accountName\":{\"description\":\"Azure Account Name\",\"type\":\"string\"},\"accountKey\":{\"description\":\"Azure Account Key\",\"type\":\"string\"},\"container\":{\"description\":\"Name of the bucket\",\"type\":\"string\"}},\"required\":[\"accountKey\",\"accountName\",\"container\"]}},\"required\":[\"properties\"]}}},\"ftp\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FtpInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"host\":{\"description\":\"Host URL or IP of the FTP server\",\"type\":\"string\"},\"port\":{\"description\":\"Port to use, standard for FTP: 21\",\"type\":\"integer\"},\"passive\":{\"type\":\"boolean\",\"description\":\"Use passive mode. Default is true.\"},\"username\":{\"description\":\"Your FTP Username\",\"type\":\"string\"},\"password\":{\"description\":\"Your FTP password\",\"type\":\"string\"},\"remoteVerificationEnabled\":{\"type\":\"boolean\",\"description\":\"Ensure that connections originate from the declared ftp host. Default is true.\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"hls\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HlsInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"url\":{\"description\":\"URL of HLS input\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"sftp\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SftpInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"host\":{\"description\":\"Host Url or IP of the SFTP server\",\"type\":\"string\"},\"port\":{\"description\":\"Port to use, standard for SFTP: 22\",\"type\":\"integer\"},\"passive\":{\"type\":\"boolean\",\"description\":\"Use passive mode. Default is true.\"},\"username\":{\"description\":\"Your SFTP Username\",\"type\":\"string\"},\"password\":{\"description\":\"Your SFTP password\",\"type\":\"string\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"http\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HttpInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"host\":{\"description\":\"Host Url or IP of the HTTP server\",\"type\":\"string\"},\"username\":{\"description\":\"Basic Auth Username, if required\",\"type\":\"string\"},\"password\":{\"description\":\"Basic Auth Password, if required\",\"type\":\"string\"},\"port\":{\"description\":\"Custom Port\",\"type\":\"integer\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"https\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HttpsInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"host\":{\"description\":\"Host Url or IP of the HTTP server\",\"type\":\"string\"},\"username\":{\"description\":\"Basic Auth Username, if required\",\"type\":\"string\"},\"password\":{\"description\":\"Basic Auth Password, if required\",\"type\":\"string\"},\"port\":{\"description\":\"Custom Port\",\"type\":\"integer\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"aspera\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AsperaInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"minBandwidth\":{\"description\":\"Minimal download bandwidth. Examples: 100k, 100m, 100g\",\"type\":\"string\"},\"maxBandwidth\":{\"description\":\"Maximal download bandwidth. Examples: 100k, 100m, 100g\",\"type\":\"string\"},\"host\":{\"description\":\"Host to use for Aspera transfers\",\"type\":\"string\"},\"username\":{\"description\":\"Username to log into Aspera host (either password and user must be set or token)\",\"type\":\"string\"},\"password\":{\"description\":\"corresponding password (either password and user must be set or token)\",\"type\":\"string\"},\"token\":{\"description\":\"Token used for authentication (either password and user must be set or token)\",\"type\":\"string\"},\"sshPort\":{\"description\":\"Set the TCP port to be used for fasp session initiation\",\"type\":\"integer\"},\"faspPort\":{\"description\":\"Set the UDP port to be used by fasp for data transfer\",\"type\":\"integer\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"akamaiNetstorage\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AkamaiNetStorageInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"host\":{\"description\":\"Host to use for Akamai NetStorage transfers\",\"type\":\"string\"},\"username\":{\"description\":\"Your Akamai NetStorage Username\",\"type\":\"string\"},\"password\":{\"description\":\"Your Akamai NetStorage password\",\"type\":\"string\"}},\"required\":[\"host\",\"password\",\"username\"]}},\"required\":[\"properties\"]}}},\"srt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SrtInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"backupSrtInputs\":{\"items\":{\"type\":\"object\",\"title\":\"SrtInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"mode\":{\"description\":\"The SRT mode to use\",\"enum\":[\"LISTENER\",\"CALLER\"],\"type\":\"string\"},\"host\":{\"description\":\"The name or IP of the host providing the SRT stream (only used in CALLER mode)\",\"type\":\"string\"},\"port\":{\"description\":\"The port to connect to or listen on. Has to be one of [2088, 2089, 2090, 2091] when using LISTENER mode.\",\"type\":\"integer\"},\"path\":{\"description\":\"The path parameter of the SRT stream\",\"type\":\"string\"},\"latency\":{\"description\":\"The maximum accepted transmission latency in milliseconds (when both parties set different values, the maximum of the two is used for both)\",\"type\":\"integer\"},\"passphrase\":{\"description\":\"The passphrase used to secure the SRT stream. For AES-128 encryption, you must enter a 16-character passphrase; for AES-256, you must enter a 32-character passphrase\",\"type\":\"string\"},\"keyLength\":{\"description\":\"The type of AES encryption determines the length of the key (passphrase). AES-128 uses a 16-character (128-bit) passphrase, and AES-256 uses a 32-character (256-bit) passphrase.\",\"type\":\"integer\"}},\"required\":[\"mode\",\"port\"]},\"type\":\"array\"}}}},\"required\":[\"properties\"]}}},\"zixi\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ZixiInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"host\":{\"type\":\"string\"},\"port\":{\"type\":\"integer\"},\"stream\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"latency\":{\"type\":\"integer\"},\"minBitrate\":{\"type\":\"integer\"},\"decryptionType\":{\"type\":\"string\"},\"decryptionKey\":{\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"directFileUpload\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DirectFileUploadInput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"}}}},\"required\":[\"properties\"]}}}}},\"outputs\":{\"type\":\"object\",\"properties\":{\"checkPermissions\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CheckOutputPermissionsRequest\",\"properties\":{\"path\":{\"description\":\"The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a \\\"prefix\\\". To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory.\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"s3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"S3Output\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"bucketName\":{\"description\":\"Amazon S3 bucket name\",\"type\":\"string\"},\"accessKey\":{\"description\":\"Amazon S3 access key\",\"type\":\"string\"},\"secretKey\":{\"description\":\"Amazon S3 secret key\",\"type\":\"string\"},\"md5MetaTag\":{\"description\":\"If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.\",\"type\":\"string\"},\"cloudRegion\":{\"description\":\"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.\",\"enum\":[\"US_EAST_1\",\"US_EAST_2\",\"US_WEST_1\",\"US_WEST_2\",\"EU_WEST_1\",\"EU_CENTRAL_1\",\"AP_SOUTHEAST_1\",\"AP_SOUTHEAST_2\",\"AP_NORTHEAST_1\",\"AP_NORTHEAST_2\",\"AP_SOUTH_1\",\"SA_EAST_1\",\"EU_WEST_2\",\"EU_WEST_3\",\"CA_CENTRAL_1\",\"EU_NORTH_1\"],\"type\":\"string\"},\"signatureVersion\":{\"description\":\"Specifies the method used for authentication. Must be set to S3_V2 if the region supports both V2 and V4, but the bucket allows V2 only (see https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)\",\"enum\":[\"S3_V2\",\"S3_V4\"],\"type\":\"string\"}},\"required\":[\"accessKey\",\"bucketName\",\"secretKey\"]}},\"required\":[\"properties\"]}}},\"s3RoleBased\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"S3RoleBasedOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"bucketName\":{\"description\":\"Amazon S3 bucket name\",\"type\":\"string\"},\"roleArn\":{\"description\":\"Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access.\\n\\nThis role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added\\nto the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\n\\nwhere \\\"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\\\" is the Bitmovin user used for the access.\\nThe `Condition` is optional but we highly recommend it, see property `externalId` below for more information.\\n\\nThis setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3.\\n\\nFor more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume S3 access.\\n\\nThis ID is provided by the API if `externalIdMode` is set to `GLOBAL` or `GENERATED`. If present, it has to be added to the trust policy of the IAM role `roleArn` configured above, otherwise the API won't be able to write to the S3 bucket. An appropriate trust policy would look like this:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\n\\nwhere \\\"{{externalId}}\\\" is the generated ID.\\n\\nThis property is optional but we recommend it as an additional security feature. We will use both the `roleArn` and the `externalId` to access your S3 data.\\nIf the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won't be able to write to the S3 bucket. Also if the\\nexternal ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket.\\n\\nIf you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role.\\n\\nFor more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"md5MetaTag\":{\"description\":\"If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.\",\"type\":\"string\"},\"cloudRegion\":{\"enum\":[\"US_EAST_1\",\"US_EAST_2\",\"US_WEST_1\",\"US_WEST_2\",\"EU_WEST_1\",\"EU_CENTRAL_1\",\"AP_SOUTHEAST_1\",\"AP_SOUTHEAST_2\",\"AP_NORTHEAST_1\",\"AP_NORTHEAST_2\",\"AP_SOUTH_1\",\"SA_EAST_1\",\"EU_WEST_2\",\"EU_WEST_3\",\"CA_CENTRAL_1\",\"EU_NORTH_1\"],\"type\":\"string\"},\"signatureVersion\":{\"description\":\"Specifies the method used for authentication\",\"enum\":[\"S3_V2\",\"S3_V4\"],\"type\":\"string\"}},\"required\":[\"bucketName\",\"roleArn\"]}},\"required\":[\"properties\"]}}},\"genericS3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"GenericS3Output\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"accessKey\":{\"description\":\"Your generic S3 access key\",\"type\":\"string\"},\"secretKey\":{\"description\":\"Your generic S3 secret key\",\"type\":\"string\"},\"bucketName\":{\"description\":\"Name of the bucket\",\"type\":\"string\"},\"host\":{\"description\":\"The Generic S3 server hostname (or IP address)\",\"type\":\"string\"},\"port\":{\"description\":\"The port on which the Generic S3 server is running on (if not provided 8000 will be used)\",\"type\":\"integer\"},\"ssl\":{\"type\":\"boolean\",\"description\":\"Controls whether SSL is used or not\"},\"signingRegion\":{\"description\":\"The signing region to use\",\"type\":\"string\"},\"signatureVersion\":{\"description\":\"Specifies the method used for authentication\",\"enum\":[\"S3_V2\",\"S3_V4\"],\"type\":\"string\"},\"accessStyle\":{\"description\":\"Specifies the URL access style to use\",\"enum\":[\"VIRTUAL_HOSTED\",\"PATH\"],\"type\":\"string\"}},\"required\":[\"accessKey\",\"bucketName\",\"host\",\"secretKey\"]}},\"required\":[\"properties\"]}}},\"local\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"LocalOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"path\":{\"description\":\"Path to your local storage\",\"type\":\"string\"}},\"required\":[\"path\"]}},\"required\":[\"properties\"]}}},\"gcs\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"GcsOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"accessKey\":{\"description\":\"GCS access key\",\"type\":\"string\"},\"secretKey\":{\"description\":\"GCS secret key\",\"type\":\"string\"},\"bucketName\":{\"description\":\"Name of the bucket\",\"type\":\"string\"},\"cloudRegion\":{\"description\":\"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.\",\"enum\":[\"US_CENTRAL_1\",\"US_EAST_1\",\"ASIA_EAST_1\",\"EUROPE_WEST_1\",\"US_WEST_1\",\"ASIA_EAST_2\",\"ASIA_NORTHEAST_1\",\"ASIA_SOUTH_1\",\"ASIA_SOUTHEAST_1\",\"AUSTRALIA_SOUTHEAST_1\",\"EUROPE_NORTH_1\",\"EUROPE_WEST_2\",\"EUROPE_WEST_3\",\"EUROPE_WEST_4\",\"NORTHAMERICA_NORTHEAST_1\",\"SOUTHAMERICA_EAST_1\",\"US_EAST_4\",\"US_WEST_2\",\"ME_CENTRAL_2\"],\"type\":\"string\"}},\"required\":[\"accessKey\",\"bucketName\",\"secretKey\"]}},\"required\":[\"properties\"]}}},\"gcsServiceAccount\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"GcsServiceAccountOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"serviceAccountCredentials\":{\"description\":\"GCS projectId\",\"type\":\"string\"},\"bucketName\":{\"description\":\"Name of the bucket\",\"type\":\"string\"},\"cloudRegion\":{\"description\":\"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.\",\"enum\":[\"US_CENTRAL_1\",\"US_EAST_1\",\"ASIA_EAST_1\",\"EUROPE_WEST_1\",\"US_WEST_1\",\"ASIA_EAST_2\",\"ASIA_NORTHEAST_1\",\"ASIA_SOUTH_1\",\"ASIA_SOUTHEAST_1\",\"AUSTRALIA_SOUTHEAST_1\",\"EUROPE_NORTH_1\",\"EUROPE_WEST_2\",\"EUROPE_WEST_3\",\"EUROPE_WEST_4\",\"NORTHAMERICA_NORTHEAST_1\",\"SOUTHAMERICA_EAST_1\",\"US_EAST_4\",\"US_WEST_2\",\"ME_CENTRAL_2\"],\"type\":\"string\"}},\"required\":[\"bucketName\",\"serviceAccountCredentials\"]}},\"required\":[\"properties\"]}}},\"azure\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AzureOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"accountName\":{\"description\":\"Azure Account Name\",\"type\":\"string\"},\"accountKey\":{\"description\":\"Azure Account Key\",\"type\":\"string\"},\"container\":{\"description\":\"Name of the bucket\",\"type\":\"string\"}},\"required\":[\"accountKey\",\"accountName\",\"container\"]}},\"required\":[\"properties\"]}}},\"ftp\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FtpOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"host\":{\"description\":\"Host URL or IP of the FTP server\",\"type\":\"string\"},\"port\":{\"description\":\"Port to use, standard for FTP: 21\",\"type\":\"integer\"},\"passive\":{\"type\":\"boolean\",\"description\":\"Use passive mode. Default is true.\"},\"username\":{\"description\":\"Your FTP Username\",\"type\":\"string\"},\"password\":{\"description\":\"Your FTP password\",\"type\":\"string\"},\"transferVersion\":{\"description\":\"Controls which transfer version should be used\",\"enum\":[\"DEFAULT\",\"POOL\"],\"type\":\"string\"},\"maxConcurrentConnections\":{\"description\":\"Restrict maximum concurrent connections. Requires at least version 1.1.0.\",\"type\":\"integer\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"sftp\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SftpOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"host\":{\"description\":\"Host Url or IP of the SFTP server\",\"type\":\"string\"},\"port\":{\"description\":\"Port to use, standard for SFTP: 22\",\"type\":\"integer\"},\"passive\":{\"type\":\"boolean\",\"description\":\"Use passive mode. Default is true.\"},\"username\":{\"description\":\"Your SFTP Username\",\"type\":\"string\"},\"password\":{\"description\":\"Your SFTP password\",\"type\":\"string\"},\"transferVersion\":{\"description\":\"Controls which transfer version should be used\",\"enum\":[\"DEFAULT\",\"POOL\"],\"type\":\"string\"},\"maxConcurrentConnections\":{\"description\":\"Restrict maximum concurrent connections. Requires at least version 1.1.0.\",\"type\":\"integer\"}},\"required\":[\"host\"]}},\"required\":[\"properties\"]}}},\"akamaiMsl\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AkamaiMslOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"streamId\":{\"description\":\"The Akamai stream ID\",\"type\":\"integer\"},\"eventName\":{\"description\":\"The Akamai event name\",\"type\":\"string\"},\"streamFormat\":{\"description\":\"- DASH: configure the Encoding with fMP4 or CMAF muxings and a DASH manifest.\\n- HLS: configure the Encoding with TS muxings and an HLS manifest.\\n- CMAF: configure the Encoding with fMP4 or CMAF muxings with both DASH and HLS manifests.\\n\",\"enum\":[\"DASH\",\"HLS\",\"CMAF\"],\"type\":\"string\"},\"mslVersion\":{\"description\":\"The Akamai MSL Version. Only MSL4 is supported at the moment.\",\"enum\":[\"MSL4\"],\"type\":\"string\"}},\"required\":[\"eventName\",\"mslVersion\",\"streamFormat\",\"streamId\"]}},\"required\":[\"properties\"]}}},\"akamaiNetstorage\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AkamaiNetStorageOutput\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"host\":{\"description\":\"Host to use for Akamai NetStorage transfers\",\"type\":\"string\"},\"username\":{\"description\":\"Your Akamai NetStorage Username\",\"type\":\"string\"},\"password\":{\"description\":\"Your Akamai NetStorage password\",\"type\":\"string\"}},\"required\":[\"host\",\"password\",\"username\"]}},\"required\":[\"properties\"]}}},\"liveMediaIngest\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"LiveMediaIngestOutput\",\"description\":\"Live Media and Metadata Ingest Protocol. See https://tools.ietf.org/html/draft-mekuria-mmediaingest-01.\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"acl\":{\"description\":\"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"},\"publishingPoint\":{\"description\":\"URL specifying the publishing point for the output. Can use either http or https.\",\"type\":\"string\"}},\"required\":[\"publishingPoint\"]}},\"required\":[\"properties\"]}}}}},\"configurations\":{\"type\":\"object\",\"properties\":{\"video\":{\"type\":\"object\",\"properties\":{\"h262\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"H262VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"presetConfiguration\":{\"description\":\"Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.\",\"enum\":[\"XDCAM_HD_422\"],\"type\":\"string\"},\"profile\":{\"description\":\"When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen.\",\"enum\":[\"MPEG2_422\"],\"type\":\"string\"},\"bframes\":{\"description\":\"Amount of b frames.\",\"minimum\":0,\"maximum\":16,\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"Maximum Bitrate\",\"type\":\"integer\"},\"minBitrate\":{\"description\":\"Minimum Bitrate\",\"type\":\"integer\"},\"bufsize\":{\"description\":\"Playback device buffer size\",\"type\":\"integer\"},\"gopSize\":{\"description\":\"Minimum GOP length, the minimum distance between I-frames\",\"type\":\"integer\"},\"level\":{\"description\":\"Specified set of constraints that indicate a degree of required decoder performance for a profile\",\"enum\":[\"MAIN\",\"HIGH\"],\"type\":\"string\"},\"interlaceMode\":{\"description\":\"Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video\",\"enum\":[\"NONE\",\"TOP_FIELD_FIRST\",\"BOTTOM_FIELD_FIRST\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"h264\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"H264VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"presetConfiguration\":{\"description\":\"Choose from a set of preset configurations tailored for common use cases. Check out [H264 Presets](https://bitmovin.com/docs/encoding/tutorials/h264-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.\",\"enum\":[\"LIVE_ULTRAHIGH_QUALITY\",\"LIVE_VERYHIGH_QUALITY\",\"LIVE_HIGH_QUALITY\",\"LIVE_STANDARD\",\"LIVE_LOW_LATENCY\",\"LIVE_LOWER_LATENCY\",\"LIVE_VERYLOW_LATENCY\",\"VOD_HIGH_QUALITY\",\"VOD_QUALITY\",\"VOD_STANDARD\",\"VOD_SPEED\",\"VOD_HIGH_SPEED\",\"VOD_VERYHIGH_SPEED\",\"VOD_EXTRAHIGH_SPEED\",\"VOD_SUPERHIGH_SPEED\",\"VOD_ULTRAHIGH_SPEED\",\"VOD_HARDWARE_SHORTFORM\"],\"type\":\"string\"},\"dynamicRangeFormat\":{\"description\":\"Automatically configures the H264 Video Codec to be compatible with the given SDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.\",\"enum\":[\"SDR\"],\"type\":\"string\"},\"crf\":{\"description\":\"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.\",\"minimum\":0,\"maximum\":51,\"format\":\"double\",\"type\":\"number\"},\"profile\":{\"description\":\"When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen.\",\"enum\":[\"BASELINE\",\"MAIN\",\"HIGH\",\"HIGH422\"],\"type\":\"string\"},\"bframes\":{\"description\":\"Amount of b frames\",\"minimum\":0,\"maximum\":16,\"type\":\"integer\"},\"refFrames\":{\"description\":\"Amount of reference frames.\",\"minimum\":1,\"maximum\":16,\"type\":\"integer\"},\"qpMin\":{\"description\":\"Minimum quantization factor\",\"minimum\":0,\"maximum\":69,\"type\":\"integer\"},\"qpMax\":{\"description\":\"Maximum quantization factor\",\"minimum\":0,\"maximum\":69,\"type\":\"integer\"},\"mvPredictionMode\":{\"enum\":[\"NONE\",\"SPATIAL\",\"TEMPORAL\",\"AUTO\"],\"type\":\"string\"},\"mvSearchRangeMax\":{\"description\":\"Maximum motion vector search range\",\"minimum\":16,\"maximum\":24,\"type\":\"integer\"},\"cabac\":{\"type\":\"boolean\",\"description\":\"Enable or disable CABAC\"},\"maxBitrate\":{\"description\":\"Maximum Bitrate (bps)\",\"type\":\"integer\"},\"minBitrate\":{\"description\":\"Minimum Bitrate (bps)\",\"type\":\"integer\"},\"bufsize\":{\"description\":\"Playback device buffer size (bits)\",\"type\":\"integer\"},\"minGop\":{\"description\":\"Minimum GOP length, the minimum distance between I-frames\",\"type\":\"integer\"},\"maxGop\":{\"description\":\"Maximum GOP length, the maximum distance between I-frames\",\"type\":\"integer\"},\"openGop\":{\"type\":\"boolean\",\"description\":\"Enable open-gop, allows referencing frames from a previous gop\"},\"minKeyframeInterval\":{\"description\":\"Minimum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"maxKeyframeInterval\":{\"description\":\"Maximum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"level\":{\"description\":\"If three-pass encoding is used and a level is set for the encoder, the bitrate for some segments may exceed the bitrate limit which is defined by the level.\",\"enum\":[\"1\",\"1b\",\"1.1\",\"1.2\",\"1.3\",\"2\",\"2.1\",\"2.2\",\"3\",\"3.1\",\"3.2\",\"4\",\"4.1\",\"4.2\",\"5\",\"5.1\",\"5.2\"],\"type\":\"string\"},\"bAdaptiveStrategy\":{\"enum\":[\"NONE\",\"FAST\",\"FULL\"],\"type\":\"string\"},\"motionEstimationMethod\":{\"enum\":[\"DIA\",\"HEX\",\"UMH\"],\"type\":\"string\"},\"rcLookahead\":{\"description\":\"Number of frames for frame-type decision lookahead\",\"minimum\":0,\"maximum\":250,\"type\":\"integer\"},\"subMe\":{\"description\":\"Subpixel motion estimation and mode decision\",\"enum\":[\"FULLPEL\",\"SAD\",\"SATD\",\"QPEL3\",\"QPEL4\",\"QPEL5\",\"RD_IP\",\"RD_ALL\",\"RD_REF_IP\",\"RD_REF_ALL\"],\"type\":\"string\"},\"trellis\":{\"description\":\"Enables or disables Trellis quantization. NOTE: This requires cabac\",\"enum\":[\"DISABLED\",\"ENABLED_FINAL_MB\",\"ENABLED_ALL\"],\"type\":\"string\"},\"partitions\":{\"description\":\"Partitions to consider. Analyzing more partition options improves quality at the cost of speed.\",\"items\":{\"type\":\"string\",\"title\":\"H264Partition\"},\"type\":\"array\"},\"slices\":{\"description\":\"Number of slices per frame.\",\"minimum\":1,\"maximum\":45,\"type\":\"integer\"},\"interlaceMode\":{\"description\":\"Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video\",\"enum\":[\"NONE\",\"TOP_FIELD_FIRST\",\"BOTTOM_FIELD_FIRST\"],\"type\":\"string\"},\"sceneCutThreshold\":{\"description\":\"Scene change sensitivity. The higher the value, the more likely an I-frame will be inserted. Set to 0 to disable it which is advised for scenarios where fixed GOP is required, e.g., adaptive streaming outputs like DASH, HLS and Smooth. Having this setting enabled can improve quality for progressive output with an increased internal chunk length (see `internalChunkLength` of muxings).\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"nalHrd\":{\"description\":\"Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)\",\"enum\":[\"NONE\",\"VBR\",\"CBR\"],\"type\":\"string\"},\"bPyramid\":{\"description\":\"Keep some B-frames as references\",\"enum\":[\"NONE\",\"STRICT\",\"NORMAL\"],\"type\":\"string\"},\"cea608708SubtitleConfig\":{\"type\":\"object\",\"description\":\"Defines whether CEA 608/708 subtitles are copied from the input video stream\",\"properties\":{\"passthroughActivated\":{\"type\":\"boolean\",\"description\":\"If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)\"},\"passthroughMode\":{\"enum\":[\"VIDEO_STREAM\",\"CAPTION_STREAM\",\"VIDEO_CAPTION_STREAM\"],\"type\":\"string\"}}},\"deblockAlpha\":{\"description\":\"Strength of the in-loop deblocking filter. Higher values deblock more effectively but also soften the image\",\"type\":\"integer\"},\"deblockBeta\":{\"description\":\"Threshold of the in-loop deblocking filter. Higher values apply deblocking stronger on non flat blocks, lower values on flat blocks\",\"type\":\"integer\"},\"adaptiveQuantizationMode\":{\"description\":\"Controls the adaptive quantization algorithm\",\"enum\":[\"DISABLED\",\"VARIANCE\",\"AUTO_VARIANCE\",\"AUTO_VARIANCE_DARK_SCENES\"],\"type\":\"string\"},\"adaptiveQuantizationStrength\":{\"description\":\"Values greater than 1 reduce blocking and blurring in flat and textured areas. Values less than 1 reduces ringing artifacts at the cost of more banding artifacts. Negative values are not allowed\",\"format\":\"double\",\"type\":\"number\"},\"mixedReferences\":{\"type\":\"boolean\",\"description\":\"Allow references on a per partition basis, rather than per-macroblock basis\"},\"adaptiveSpatialTransform\":{\"type\":\"boolean\",\"description\":\"Enables adaptive spatial transform (high profile 8x8 transform)\"},\"fastSkipDetectionPFrames\":{\"type\":\"boolean\",\"description\":\"Enables fast skip detection on P-frames. Disabling this very slightly increases quality but at a large speed loss\"},\"weightedPredictionBFrames\":{\"type\":\"boolean\",\"description\":\"Enable open-gop, allows referencing frames from a previous gop\"},\"weightedPredictionPFrames\":{\"description\":\"Defines the mode for weighted prediction for P-frames\",\"enum\":[\"DISABLED\",\"SIMPLE\",\"SMART\"],\"type\":\"string\"},\"macroblockTreeRatecontrol\":{\"type\":\"boolean\",\"description\":\"Enable macroblock tree ratecontrol. Macroblock tree rate control tracks how often blocks of the frame are used for prediciting future frames\"},\"quantizerCurveCompression\":{\"description\":\"Ratio between constant bitrate (0.0) and constant quantizer (1.0). Valid range 0.0 - 1.0\",\"format\":\"double\",\"type\":\"number\"},\"psyRateDistortionOptimization\":{\"description\":\"Psychovisual Rate Distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP or RD_REF_ALL\",\"format\":\"double\",\"type\":\"number\"},\"psyTrellis\":{\"description\":\"Higher values will improve sharpness and detail retention but might come at costs of artifacts. Needs to have trellis enabled\",\"format\":\"double\",\"type\":\"number\"},\"autoLevelSetup\":{\"description\":\"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"hardwareEncodingMode\":{\"description\":\"Hardware encoding mode. Not set means no hardware encoding.\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"h265\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"H265VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"presetConfiguration\":{\"description\":\"Choose from a set of preset configurations tailored for common use cases. Check out [H265 Presets](https://bitmovin.com/docs/encoding/tutorials/h265-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.\",\"enum\":[\"LIVE_ULTRAHIGH_QUALITY\",\"LIVE_VERYHIGH_QUALITY\",\"LIVE_HIGH_QUALITY\",\"LIVE_STANDARD\",\"LIVE_LOW_LATENCY\",\"LIVE_LOWER_LATENCY\",\"LIVE_VERYLOW_LATENCY\",\"VOD_HIGH_QUALITY\",\"VOD_QUALITY\",\"VOD_STANDARD\",\"VOD_SPEED\",\"VOD_HIGH_SPEED\",\"VOD_VERYHIGH_SPEED\",\"VOD_EXTRAHIGH_SPEED\",\"VOD_SUPERHIGH_SPEED\",\"VOD_ULTRAHIGH_SPEED\",\"VOD_HARDWARE_SHORTFORM\"],\"type\":\"string\"},\"dynamicRangeFormat\":{\"description\":\"Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.\",\"enum\":[\"DOLBY_VISION\",\"DOLBY_VISION_PROFILE_5\",\"DOLBY_VISION_PROFILE_8_1\",\"HDR10\",\"HLG\",\"SDR\"],\"type\":\"string\"},\"crf\":{\"description\":\"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.\",\"minimum\":0,\"maximum\":51,\"format\":\"double\",\"type\":\"number\"},\"profile\":{\"enum\":[\"main\",\"main10\"],\"type\":\"string\"},\"bframes\":{\"description\":\"Amount of b frames\",\"minimum\":0,\"maximum\":16,\"type\":\"integer\"},\"refFrames\":{\"description\":\"Amount of reference frames\",\"minimum\":0,\"maximum\":16,\"type\":\"integer\"},\"qp\":{\"description\":\"Quantization factor\",\"minimum\":0,\"maximum\":51,\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"Maximum Bitrate (bps)\",\"type\":\"integer\"},\"minBitrate\":{\"description\":\"Minimum Bitrate (bps)\",\"type\":\"integer\"},\"bufsize\":{\"description\":\"Size of the VBV buffer (bits)\",\"type\":\"integer\"},\"minGop\":{\"description\":\"Minimum GOP length, the minimum distance between I-frames\",\"type\":\"integer\"},\"maxGop\":{\"description\":\"Maximum GOP length, the maximum distance between I-frames\",\"type\":\"integer\"},\"openGop\":{\"type\":\"boolean\",\"description\":\"Enable open-gop, allows referencing frames from a previous gop\"},\"minKeyframeInterval\":{\"description\":\"Minimum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"maxKeyframeInterval\":{\"description\":\"Maximum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"level\":{\"enum\":[\"1\",\"2\",\"2.1\",\"3\",\"3.1\",\"4\",\"4.1\",\"5\",\"5.1\",\"5.2\",\"6\",\"6.1\",\"6.2\"],\"type\":\"string\"},\"rcLookahead\":{\"description\":\"Number of frames for slice-type decision lookahead\",\"minimum\":1,\"maximum\":250,\"type\":\"integer\"},\"bAdapt\":{\"description\":\"Set the level of effort in determining B frame placement\",\"enum\":[\"NONE\",\"FAST\",\"FULL\"],\"type\":\"string\"},\"maxCTUSize\":{\"enum\":[\"16\",\"32\",\"64\"],\"type\":\"string\"},\"tuIntraDepth\":{\"enum\":[\"1\",\"2\",\"3\",\"4\"],\"type\":\"string\"},\"tuInterDepth\":{\"enum\":[\"1\",\"2\",\"3\",\"4\"],\"type\":\"string\"},\"motionSearch\":{\"enum\":[\"DIA\",\"HEX\",\"UMH\",\"STAR\",\"FULL\"],\"type\":\"string\"},\"subMe\":{\"description\":\"Set the amount of subpel refinement to perform.\",\"minimum\":0,\"maximum\":7,\"type\":\"integer\"},\"motionSearchRange\":{\"description\":\"Set the Motion search range.\",\"minimum\":0,\"maximum\":32768,\"type\":\"integer\"},\"weightPredictionOnPSlice\":{\"type\":\"boolean\",\"description\":\"Enable weighted prediction in P slices\"},\"weightPredictionOnBSlice\":{\"type\":\"boolean\",\"description\":\"Enable weighted prediction in B slices\"},\"sao\":{\"type\":\"boolean\",\"description\":\"Toggle sample adaptive offset loop filter\"},\"masterDisplay\":{\"description\":\"Set the mastering display color volume SEI info (SMPTE ST 2086). For example `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)` describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)`.\",\"type\":\"string\"},\"maxContentLightLevel\":{\"description\":\"Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.\",\"type\":\"integer\"},\"maxPictureAverageLightLevel\":{\"description\":\"Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.\",\"type\":\"integer\"},\"hdr\":{\"type\":\"boolean\",\"description\":\"Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel.\"},\"sceneCutThreshold\":{\"description\":\"Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.\",\"minimum\":0,\"type\":\"integer\"},\"adaptiveQuantizationMode\":{\"description\":\"Controls the adaptive quantization algorithm\",\"enum\":[\"DISABLED\",\"VARIANCE\",\"AUTO_VARIANCE\",\"AUTO_VARIANCE_DARK_SCENES\"],\"type\":\"string\"},\"enableHlgSignaling\":{\"type\":\"boolean\",\"description\":\"Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message.\"},\"videoFormat\":{\"description\":\"Specifies the source format of the original analog video prior to digitizing and encoding\",\"enum\":[\"UNDEFINED\",\"COMPONENT\",\"PAL\",\"NTSC\",\"SECAM\",\"MAC\"],\"type\":\"string\"},\"psyRateDistortionOptimization\":{\"description\":\"Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD\",\"minimum\":0,\"maximum\":5,\"format\":\"double\",\"type\":\"number\"},\"psyRateDistortionOptimizedQuantization\":{\"description\":\"Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical\",\"minimum\":0,\"maximum\":50,\"format\":\"double\",\"type\":\"number\"},\"enableHrdSignaling\":{\"type\":\"boolean\",\"description\":\"Signal hypothetical reference decoder (HRD) information\"},\"cutree\":{\"type\":\"boolean\",\"description\":\"Enables the use of lookahead\\u2019s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors.\"},\"minCodingUnitSize\":{\"description\":\"Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.\",\"enum\":[\"MCU_8x8\",\"MCU_16x16\",\"MCU_32x32\"],\"type\":\"string\"},\"lookaheadSlices\":{\"description\":\"Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16\",\"type\":\"integer\"},\"limitReferences\":{\"description\":\"If enabled, limit references per depth, CU or both.\",\"enum\":[\"DISABLED\",\"DEPTH\",\"CU\",\"DEPTH_AND_CU\"],\"type\":\"string\"},\"rectangularMotionPartitionsAnalysis\":{\"type\":\"boolean\",\"description\":\"Enable analysis of rectangular motion partitions Nx2N and 2NxN.\"},\"asymetricMotionPartitionsAnalysis\":{\"type\":\"boolean\",\"description\":\"Enable analysis of asymmetric motion partitions.\"},\"limitModes\":{\"type\":\"boolean\",\"description\":\"When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when `rectangularMotionPartitionsAnalysis` and/or `asymetricMotionPartitionsAnalysis` are enabled at minimal compression efficiency loss.\"},\"maxMerge\":{\"description\":\"Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5\",\"type\":\"integer\"},\"earlySkip\":{\"type\":\"boolean\",\"description\":\"Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed.\"},\"recursionSkip\":{\"type\":\"boolean\",\"description\":\"If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion.\"},\"fastSearchForAngularIntraPredictions\":{\"type\":\"boolean\",\"description\":\"Enable faster search method for angular intra predictions.\"},\"evaluationOfIntraModesInBSlices\":{\"type\":\"boolean\",\"description\":\"Enables the evaluation of intra modes in B slices.\"},\"signHide\":{\"type\":\"boolean\",\"description\":\"Hide sign bit of one coefficient per coding tree unit.\"},\"rateDistortionLevelForModeDecision\":{\"description\":\"Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4\",\"type\":\"integer\"},\"rateDistortionLevelForQuantization\":{\"description\":\"Specifies the amount of rate-distortion analysis to use within quantization.\",\"enum\":[\"DISABLED\",\"LEVELS\",\"LEVELS_AND_CODING_GROUPS\"],\"type\":\"string\"},\"qpMin\":{\"description\":\"Minimum quantization factor. Valid value range: 0 - 69\",\"minimum\":0,\"maximum\":69,\"type\":\"integer\"},\"qpMax\":{\"description\":\"Maximum quantization factor. Valid value range: 0 - 69\",\"minimum\":0,\"maximum\":69,\"type\":\"integer\"},\"wavefrontParallelProcessing\":{\"type\":\"boolean\",\"description\":\"The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled.\"},\"slices\":{\"description\":\"Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.\",\"type\":\"integer\"},\"copyPicture\":{\"type\":\"boolean\",\"description\":\"Copy buffers of input picture in frame. Default is enabled.\"},\"levelHighTier\":{\"type\":\"boolean\",\"description\":\"If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled.\"},\"skipSplitRateDistortionAnalysis\":{\"type\":\"boolean\",\"description\":\"Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled.\"},\"codingUnitLossless\":{\"type\":\"boolean\",\"description\":\"If enabled, consider lossless mode in CU RDO decisions. Default is disabled.\"},\"transformSkip\":{\"description\":\"Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.\",\"enum\":[\"NONE\",\"NORMAL\",\"FAST\"],\"type\":\"string\"},\"refineRateDistortionCost\":{\"type\":\"boolean\",\"description\":\"Enable QP based rate distortion refinement. Default is disabled.\"},\"limitTransformUnitDepthRecursion\":{\"description\":\"Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.\",\"enum\":[\"DISABLED\",\"LEVEL_1\",\"LEVEL_2\",\"LEVEL_3\",\"LEVEL_4\"],\"type\":\"string\"},\"noiseReductionIntra\":{\"description\":\"An integer value, which denotes strength of noise reduction in intra CUs. Default 0.\",\"minimum\":0,\"maximum\":2000,\"type\":\"integer\"},\"noiseReductionInter\":{\"description\":\"An integer value, which denotes strength of noise reduction in inter CUs. Default 0.\",\"minimum\":0,\"maximum\":2000,\"type\":\"integer\"},\"rateDistortionPenalty\":{\"description\":\"Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.\",\"enum\":[\"DISABLED\",\"NORMAL\",\"MAXIMUM\"],\"type\":\"string\"},\"maximumTransformUnitSize\":{\"description\":\"Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.\",\"enum\":[\"MTU_4x4\",\"MTU_8x8\",\"MTU_16x16\",\"MTU_32x32\"],\"type\":\"string\"},\"dynamicRateDistortionStrength\":{\"description\":\"Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.\",\"minimum\":0,\"maximum\":4,\"type\":\"integer\"},\"ssimRateDistortionOptimization\":{\"type\":\"boolean\",\"description\":\"It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false.\"},\"temporalMotionVectorPredictors\":{\"type\":\"boolean\",\"description\":\"Enable temporal motion vector predictors in P and B slices. Default true.\"},\"analyzeSourceFramePixels\":{\"type\":\"boolean\",\"description\":\"Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false.\"},\"strongIntraSmoothing\":{\"type\":\"boolean\",\"description\":\"Enable strong intra smoothing for 32x32 intra blocks. Default true.\"},\"constrainedIntraPrediction\":{\"type\":\"boolean\",\"description\":\"When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false.\"},\"scenecutBias\":{\"description\":\"This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.\",\"minimum\":0,\"maximum\":100,\"format\":\"double\",\"type\":\"number\"},\"allowedRADLBeforeIDR\":{\"description\":\"Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - `bframes`. Default 0.\",\"type\":\"integer\"},\"gopLookahead\":{\"description\":\"Number of frames for GOP boundary decision lookahead. Valid values 0 - `rcLookahead`. Default 0\",\"type\":\"integer\"},\"bframeBias\":{\"description\":\"Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0\",\"minimum\":-90,\"maximum\":100,\"type\":\"integer\"},\"forceFlush\":{\"description\":\"Force the encoder to flush frames. Default is DISABLED.\",\"enum\":[\"DISABLED\",\"ALL_FRAMES\",\"SLICE_TYPE\"],\"type\":\"string\"},\"adaptiveQuantizationStrength\":{\"description\":\"Adjust the strength of the adaptive quantization offsets. Default 1.0.\",\"minimum\":0,\"maximum\":3,\"format\":\"double\",\"type\":\"number\"},\"adaptiveQuantizationMotion\":{\"type\":\"boolean\",\"description\":\"Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false.\"},\"quantizationGroupSize\":{\"description\":\"Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as `maxCTUSize`.\",\"enum\":[\"QGS_8x8\",\"QGS_16x16\",\"QGS_32x32\",\"QGS_64x64\"],\"type\":\"string\"},\"strictCbr\":{\"type\":\"boolean\",\"description\":\"Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false.\"},\"qpOffsetChromaCb\":{\"description\":\"Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0\",\"minimum\":-12,\"maximum\":12,\"type\":\"integer\"},\"qpOffsetChromaCr\":{\"description\":\"Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0\",\"minimum\":-12,\"maximum\":12,\"type\":\"integer\"},\"ipRatio\":{\"description\":\"QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4\",\"format\":\"double\",\"type\":\"number\"},\"pbRatio\":{\"description\":\"QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3\",\"format\":\"double\",\"type\":\"number\"},\"quantizerCurveCompressionFactor\":{\"description\":\"Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6\",\"minimum\":0.5,\"maximum\":1,\"format\":\"double\",\"type\":\"number\"},\"qpStep\":{\"description\":\"The maximum single adjustment in QP allowed to rate control. Default 4\",\"type\":\"integer\"},\"grainOptimizedRateControl\":{\"type\":\"boolean\",\"description\":\"Enables a specialised ratecontrol algorithm for film grain content. Default false.\"},\"blurQuants\":{\"description\":\"Temporally blur quants. Default 0.5\",\"format\":\"double\",\"type\":\"number\"},\"blurComplexity\":{\"description\":\"Temporally blur complexity. Default 20.0\",\"format\":\"double\",\"type\":\"number\"},\"saoNonDeblock\":{\"type\":\"boolean\",\"description\":\"Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false.\"},\"limitSao\":{\"type\":\"boolean\",\"description\":\"Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false.\"},\"lowpassDct\":{\"type\":\"boolean\",\"description\":\"Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false.\"},\"cea608708SubtitleConfig\":{\"type\":\"object\",\"description\":\"Defines whether CEA 608/708 subtitles are extracted from the input video stream\",\"properties\":{\"passthroughActivated\":{\"type\":\"boolean\",\"description\":\"If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)\"},\"passthroughMode\":{\"enum\":[\"VIDEO_STREAM\",\"CAPTION_STREAM\",\"VIDEO_CAPTION_STREAM\"],\"type\":\"string\"}}},\"autoLevelSetup\":{\"description\":\"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"hardwareEncodingMode\":{\"description\":\"Hardware encoding mode. Not set means no hardware encoding.\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"h266\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"H266VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"presetConfiguration\":{\"enum\":[\"LIVE_ULTRAHIGH_QUALITY\",\"LIVE_VERYHIGH_QUALITY\",\"LIVE_HIGH_QUALITY\",\"LIVE_STANDARD\",\"LIVE_LOW_LATENCY\",\"LIVE_LOWER_LATENCY\",\"LIVE_VERYLOW_LATENCY\",\"VOD_HIGH_QUALITY\",\"VOD_QUALITY\",\"VOD_STANDARD\",\"VOD_SPEED\",\"VOD_HIGH_SPEED\",\"VOD_VERYHIGH_SPEED\",\"VOD_EXTRAHIGH_SPEED\",\"VOD_SUPERHIGH_SPEED\",\"VOD_ULTRAHIGH_SPEED\",\"VOD_HARDWARE_SHORTFORM\"],\"type\":\"string\"},\"crf\":{\"description\":\"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.\",\"minimum\":0,\"maximum\":51,\"format\":\"double\",\"type\":\"number\"},\"maxBitrate\":{\"description\":\"Maximum Bitrate\",\"type\":\"integer\"},\"minBitrate\":{\"description\":\"Minimum Bitrate\",\"type\":\"integer\"}}}},\"required\":[\"properties\"]}}},\"vp8\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Vp8VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"crf\":{\"description\":\"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.\",\"minimum\":0,\"maximum\":63,\"type\":\"integer\"},\"lagInFrames\":{\"description\":\"Number of frames to look ahead for alternate reference frame selection.\",\"minimum\":0,\"maximum\":25,\"type\":\"integer\"},\"maxIntraRate\":{\"description\":\"Maximum I-frame bitrate (percentage) 0=unlimited\",\"type\":\"integer\"},\"qpMin\":{\"description\":\"Minimum quantization factor.\",\"minimum\":0,\"maximum\":63,\"type\":\"integer\"},\"qpMax\":{\"description\":\"Maximum quantization factor.\",\"minimum\":0,\"maximum\":63,\"type\":\"integer\"},\"rateUndershootPct\":{\"description\":\"Datarate undershoot (min) target (percentage).\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"rateOvershootPct\":{\"description\":\"Datarate overshoot (max) target (percentage).\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"noiseSensitivity\":{\"enum\":[\"OFF\",\"ON_Y_ONLY\",\"ON_YUV\",\"ON_YUV_AGGRESSIVE\",\"ADAPTIVE\"],\"type\":\"string\"},\"sharpness\":{\"description\":\"Loop filter sharpness.\",\"minimum\":0,\"maximum\":7,\"type\":\"integer\"},\"minGop\":{\"description\":\"Minimum GOP length, the minimum distance between I-frames.\",\"type\":\"integer\"},\"maxGop\":{\"description\":\"Maximum GOP length, the maximum distance between I-frames\",\"type\":\"integer\"},\"minKeyframeInterval\":{\"description\":\"Minimum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"maxKeyframeInterval\":{\"description\":\"Maximum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"quality\":{\"enum\":[\"REALTIME\",\"GOOD\",\"BEST\"],\"type\":\"string\"},\"staticThresh\":{\"description\":\"A change threshold on blocks below which they will be skipped by the encoder.\",\"minimum\":0,\"type\":\"integer\"},\"arnrMaxFrames\":{\"description\":\"altref noise reduction max frame count.\",\"minimum\":0,\"maximum\":15,\"type\":\"integer\"},\"arnrStrength\":{\"description\":\"altref noise reduction filter strength.\",\"minimum\":0,\"maximum\":6,\"type\":\"integer\"},\"arnrType\":{\"enum\":[\"BACKWARD\",\"FORWARD\",\"CENTERED\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"vp9\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Vp9VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"presetConfiguration\":{\"description\":\"Choose from a set of preset configurations tailored for common use cases. Check out [VP9 Presets](https://bitmovin.com/docs/encoding/tutorials/vp9-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.\",\"enum\":[\"LIVE_ULTRAHIGH_QUALITY\",\"LIVE_VERYHIGH_QUALITY\",\"LIVE_HIGH_QUALITY\",\"LIVE_STANDARD\",\"LIVE_LOW_LATENCY\",\"LIVE_LOWER_LATENCY\",\"LIVE_VERYLOW_LATENCY\",\"VOD_HIGH_QUALITY\",\"VOD_QUALITY\",\"VOD_STANDARD\",\"VOD_SPEED\",\"VOD_HIGH_SPEED\",\"VOD_VERYHIGH_SPEED\",\"VOD_EXTRAHIGH_SPEED\",\"VOD_SUPERHIGH_SPEED\",\"VOD_ULTRAHIGH_SPEED\",\"VOD_HARDWARE_SHORTFORM\"],\"type\":\"string\"},\"dynamicRangeFormat\":{\"description\":\"Automatically configures the VP9 Video Codec to be compatible with the given SDR/HLG format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.\",\"enum\":[\"HLG\",\"SDR\"],\"type\":\"string\"},\"crf\":{\"description\":\"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.\",\"minimum\":0,\"maximum\":63,\"type\":\"integer\"},\"lagInFrames\":{\"description\":\"Number of frames to look ahead for alternate reference frame selection.\",\"minimum\":0,\"maximum\":25,\"type\":\"integer\"},\"errorResiliencyEnabled\":{\"type\":\"boolean\",\"description\":\"Enables error resiliency feature\"},\"tileColumns\":{\"description\":\"Number of tile columns to use, log2. Depending on the encoding width there are limitations on this value. The minimum values are 2 for width >= 1920 and 1 for width >= 1280. The minimum width of each tile is 256 pixels so the maximum values are 0 for width < 256, 1 for width < 512, 2 for width < 1024, 3 for width < 2048, 4 for width < 4096, 5 for width < 8192. If the value is too high or too low it will be overridden.\",\"minimum\":0,\"maximum\":6,\"type\":\"integer\"},\"tileRows\":{\"description\":\"Number of tile rows to use, log2.\",\"minimum\":0,\"maximum\":2,\"type\":\"integer\"},\"frameParallel\":{\"type\":\"boolean\",\"description\":\"Enable frame parallel decodability features\"},\"maxIntraRate\":{\"description\":\"Maximum I-frame bitrate (percentage) 0=unlimited\",\"type\":\"integer\"},\"qpMin\":{\"description\":\"Minimum quantization factor.\",\"minimum\":0,\"maximum\":63,\"type\":\"integer\"},\"qpMax\":{\"description\":\"Maximum quantization factor.\",\"minimum\":0,\"maximum\":63,\"type\":\"integer\"},\"rateUndershootPct\":{\"description\":\"Datarate undershoot (min) target (percentage).\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"rateOvershootPct\":{\"description\":\"Datarate overshoot (max) target (percentage).\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"clientBufferSize\":{\"description\":\"Client buffer size (ms)\",\"minimum\":0,\"type\":\"integer\"},\"clientInitialBufferSize\":{\"description\":\"Client initial buffer size (ms)\",\"minimum\":0,\"type\":\"integer\"},\"biasPct\":{\"description\":\"CBR/VBR bias (0=CBR, 100=VBR)\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"noiseSensitivity\":{\"type\":\"boolean\",\"description\":\"Enable noise sensitivity on Y channel\"},\"cpuUsed\":{\"description\":\"Controls the tradeoff between compression efficiency and encoding speed. Higher values indicate a faster encoding. The minimum value for width * height >= 1280 * 720 is 2. If the value is too low it will be overridden.\",\"minimum\":1,\"maximum\":8,\"type\":\"integer\"},\"automaticAltRefFramesEnabled\":{\"type\":\"boolean\",\"description\":\"Enable automatic alternate reference frames (2pass only)\"},\"targetLevel\":{\"description\":\"Target level (255: off, 0: only keep level stats; 10: level 1.0; 11: level 1.1; ... 62: level 6.2)\",\"minimum\":0,\"maximum\":255,\"type\":\"integer\"},\"rowMultiThreadingEnabled\":{\"type\":\"boolean\",\"description\":\"Enable row based non-deterministic multi-threading\"},\"sharpness\":{\"description\":\"Loop filter sharpness.\",\"minimum\":0,\"maximum\":7,\"type\":\"integer\"},\"minGop\":{\"description\":\"Minimum GOP length, the minimum distance between I-frames.\",\"type\":\"integer\"},\"maxGop\":{\"description\":\"Maximum GOP length, the maximum distance between I-frames\",\"type\":\"integer\"},\"minKeyframeInterval\":{\"description\":\"Minimum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"maxKeyframeInterval\":{\"description\":\"Maximum interval in seconds between key frames\",\"format\":\"double\",\"type\":\"number\"},\"quality\":{\"enum\":[\"REALTIME\",\"GOOD\",\"BEST\"],\"type\":\"string\"},\"lossless\":{\"type\":\"boolean\",\"description\":\"Lossless mode\"},\"staticThresh\":{\"description\":\"A change threshold on blocks below which they will be skipped by the encoder.\",\"minimum\":0,\"type\":\"integer\"},\"aqMode\":{\"enum\":[\"NONE\",\"VARIANCE\",\"COMPLEXITY\",\"CYCLIC\"],\"type\":\"string\"},\"arnrMaxFrames\":{\"description\":\"altref noise reduction max frame count.\",\"minimum\":0,\"maximum\":15,\"type\":\"integer\"},\"arnrStrength\":{\"description\":\"altref noise reduction filter strength.\",\"minimum\":0,\"maximum\":6,\"type\":\"integer\"},\"arnrType\":{\"enum\":[\"BACKWARD\",\"FORWARD\",\"CENTERED\"],\"type\":\"string\"},\"autoLevelSetup\":{\"description\":\"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting rateOvershootPct, or clientBufferSize properties will disable the automatic calculation.\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"av1\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Av1VideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video in pixels\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video in pixels\",\"type\":\"integer\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded video in bps. Either bitrate or crf is required.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video. Must be set for live encodings\",\"format\":\"double\",\"type\":\"number\"},\"pixelFormat\":{\"description\":\"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.\",\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"},\"colorConfig\":{\"type\":\"object\",\"properties\":{\"copyChromaLocationFlag\":{\"type\":\"boolean\",\"description\":\"Copy the chroma location setting from the input source\"},\"copyColorSpaceFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color space setting from the input source\"},\"copyColorPrimariesFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color primaries setting from the input source\"},\"copyColorRangeFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color range setting from the input source\"},\"copyColorTransferFlag\":{\"type\":\"boolean\",\"description\":\"Copy the color transfer setting from the input source\"},\"chromaLocation\":{\"description\":\"The chroma location to be applied\",\"enum\":[\"UNSPECIFIED\",\"LEFT\",\"CENTER\",\"TOPLEFT\",\"TOP\",\"BOTTOMLEFT\",\"BOTTOM\"],\"type\":\"string\"},\"colorSpace\":{\"description\":\"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"colorPrimaries\":{\"description\":\"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"colorRange\":{\"description\":\"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"colorTransfer\":{\"description\":\"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"},\"inputColorSpace\":{\"description\":\"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"RGB\",\"BT709\",\"FCC\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"YCGCO\",\"YCOCG\",\"BT2020_NCL\",\"BT2020_CL\",\"SMPTE2085\"],\"type\":\"string\"},\"inputColorRange\":{\"description\":\"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"MPEG\",\"JPEG\"],\"type\":\"string\"},\"inputColorPrimaries\":{\"description\":\"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"BT470M\",\"BT470BG\",\"SMPTE170M\",\"SMPTE240M\",\"FILM\",\"BT2020\",\"SMPTE428\",\"SMPTEST428_1\",\"SMPTE431\",\"SMPTE432\",\"JEDEC_P22\"],\"type\":\"string\"},\"inputColorTransfer\":{\"description\":\"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.\",\"enum\":[\"UNSPECIFIED\",\"BT709\",\"GAMMA22\",\"GAMMA28\",\"SMPTE170M\",\"SMPTE240M\",\"LINEAR\",\"LOG\",\"LOG_SQRT\",\"IEC61966_2_4\",\"BT1361_ECG\",\"IEC61966_2_1\",\"BT2020_10\",\"BT2020_12\",\"SMPTE2084\",\"SMPTE428\",\"ARIB_STD_B67\"],\"type\":\"string\"}}},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.\",\"type\":\"integer\"},\"displayAspectRatio\":{\"type\":\"object\",\"description\":\"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.\",\"properties\":{\"numerator\":{\"description\":\"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.\",\"minimum\":1,\"type\":\"integer\"},\"denominator\":{\"description\":\"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.\",\"minimum\":1,\"type\":\"integer\"}},\"required\":[\"denominator\",\"numerator\"]},\"encodingMode\":{\"description\":\"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"presetConfiguration\":{\"description\":\"Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.\",\"enum\":[\"VOD_QUALITY\",\"VOD_STANDARD\",\"VOD_SPEED\"],\"type\":\"string\"},\"autoLevelSetup\":{\"description\":\"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"keyPlacementMode\":{\"enum\":[\"AUTO\",\"FIXED\",\"DISABLED\"],\"type\":\"string\"},\"adaptiveQuantMode\":{\"enum\":[\"OFF\",\"VARIANCE\",\"COMPLEXITY\",\"CYCLIC_REFRESH\",\"DELTA_QUANT\"],\"type\":\"string\"},\"lagInFrames\":{\"description\":\"Number of frames to look ahead for alternate reference frame selection\",\"minimum\":0,\"maximum\":25,\"type\":\"integer\"},\"minQ\":{\"description\":\"Minimum (best quality) quantizer\",\"type\":\"integer\"},\"maxQ\":{\"description\":\"Maximum (worst quality) quantizer\",\"type\":\"integer\"},\"undershootPct\":{\"description\":\"Rate control adaptation undershoot control\",\"minimum\":0,\"maximum\":1000,\"type\":\"integer\"},\"overshootPct\":{\"description\":\"Rate control adaptation overshoot control\",\"minimum\":0,\"maximum\":1000,\"type\":\"integer\"},\"clientBufferSize\":{\"description\":\"Decoder buffer size in milliseconds\",\"type\":\"integer\"},\"clientInitialBufferSize\":{\"description\":\"Decoder buffer initial size in milliseconds\",\"type\":\"integer\"},\"clientOptimalBufferSize\":{\"description\":\"Decoder buffer optimal size in milliseconds\",\"type\":\"integer\"},\"tileColumns\":{\"description\":\"Number of tile columns to use, log2\",\"minimum\":0,\"maximum\":6,\"type\":\"integer\"},\"tileRows\":{\"description\":\"Number of tile rows to use, log2\",\"minimum\":0,\"maximum\":2,\"type\":\"integer\"},\"isAutomaticAltRefFramesEnabled\":{\"type\":\"boolean\",\"description\":\"Enable automatic set and use alf frames\"},\"arnrMaxFrames\":{\"description\":\"The max number of frames to create arf\",\"type\":\"integer\"},\"arnrStrength\":{\"description\":\"The filter strength for the arf\",\"type\":\"integer\"},\"maxIntraRate\":{\"description\":\"Maximum data rate for intra frames, expressed as a percentage of the average per-frame bitrate. Default value 0 meaning unlimited\",\"type\":\"integer\"},\"isLossless\":{\"type\":\"boolean\",\"description\":\"Lossless encoding mode\"},\"isFrameParallel\":{\"type\":\"boolean\",\"description\":\"Enable frame parallel decoding feature\"},\"sharpness\":{\"description\":\"Sharpness\",\"type\":\"integer\"},\"isFrameBoostEnabled\":{\"type\":\"boolean\",\"description\":\"Enable quality boost by lowering frame level Q periodically\"},\"noiseSensitivity\":{\"type\":\"boolean\",\"description\":\"Enable noise sensitivity on Y channel\"},\"minGfInterval\":{\"description\":\"Minimum interval between GF/ARF frames\",\"type\":\"integer\"},\"maxGfInterval\":{\"description\":\"Maximum interval between GF/ARF frames\",\"type\":\"integer\"},\"numTileGroups\":{\"description\":\"Maximum number of tile groups\",\"type\":\"integer\"},\"mtuSize\":{\"description\":\"Maximum number of bytes in a tile group\",\"type\":\"integer\"}}}},\"required\":[\"properties\"]}}},\"mjpeg\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"MjpegVideoConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"Width of the encoded video\",\"type\":\"integer\"},\"height\":{\"description\":\"Height of the encoded video\",\"type\":\"integer\"},\"rate\":{\"description\":\"Target frame rate of the encoded video!\",\"format\":\"double\",\"type\":\"number\"},\"qScale\":{\"description\":\"The quality scale parameter\",\"type\":\"integer\"},\"pixelFormat\":{\"enum\":[\"YUV410P\",\"YUV411P\",\"YUV420P\",\"YUV422P\",\"YUV440P\",\"YUV444P\",\"YUVJ411P\",\"YUVJ420P\",\"YUVJ422P\",\"YUVJ440P\",\"YUVJ444P\",\"YUV420P10LE\",\"YUV422P10LE\",\"YUV440P10LE\",\"YUV444P10LE\",\"YUV420P12LE\",\"YUV422P12LE\",\"YUV440P12LE\",\"YUV444P12LE\",\"YUV420P10BE\",\"YUV422P10BE\",\"YUV440P10BE\",\"YUV444P10BE\",\"YUV420P12BE\",\"YUV422P12BE\",\"YUV440P12BE\",\"YUV444P12BE\"],\"type\":\"string\"}},\"required\":[\"qScale\",\"rate\"]}},\"required\":[\"properties\"]}}}}},\"audio\":{\"type\":\"object\",\"properties\":{\"aac\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AacAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"4.0\",\"5.0_BACK\",\"5.1_BACK\",\"7.1\",\"7.1_WIDE_BACK\"],\"type\":\"string\"},\"cutoffFrequency\":{\"description\":\"The highest frequency that will pass the audio encoder. This value is optional.\",\"type\":\"integer\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"dtsPassthrough\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DtsPassthroughAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"}}}},\"required\":[\"properties\"]}}},\"dts\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DtsAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps. Allowed values are: 255000, 384000, for DTS Express Audio. For DTS Digital Surround only 768000 is allowed.\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz. Only 48000 is allowed.\",\"format\":\"double\",\"type\":\"number\"},\"mode\":{\"description\":\"There are two DTS modes available: DTS Express Audio (EXPRESS_AUDIO) and DTS Digital Surround (DIGITAL_SURROUND)\",\"enum\":[\"EXPRESS_AUDIO\",\"DIGITAL_SURROUND\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"dtsx\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DtsXAudioConfiguration\",\"description\":\"The configuration for the DTS:X\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"enum\":[\"160000\",\"192000\",\"224000\",\"256000\",\"288000\",\"320000\",\"384000\",\"448000\"],\"type\":\"string\"},\"rate\":{\"description\":\"Audio sampling rate in Hz. Must be 48000\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"enum\":[\"5.1\",\"5.1.4\"],\"type\":\"string\"},\"lkfsValue\":{\"description\":\"Loudness relative to full scale (K-weighted).\",\"minimum\":-40,\"maximum\":0,\"format\":\"double\",\"type\":\"number\"},\"ottLoudnessMode\":{\"enum\":[\"DTSX_OTT_LOUDNESS_DETECT\",\"DTSX_OTT_LOUDNESS_INPUT\",\"DTSX_OTT_LOUDNESS_TARGET\"],\"type\":\"string\"},\"syncInterval\":{\"description\":\"Specifies the sync interval which ranges from 1 to 10\",\"minimum\":1,\"maximum\":10,\"type\":\"integer\"}},\"required\":[\"channelLayout\",\"ottLoudnessMode\",\"bitrate\"]}},\"required\":[\"properties\"]}}},\"dolbyAtmos\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyAtmosAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps. Allowed values are: 384000, 448000, 576000, 640000, 768000, 1024000\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz. Only 48000 is allowed.\",\"format\":\"double\",\"type\":\"number\"},\"loudnessControl\":{\"type\":\"object\",\"description\":\"Settings for loudness control\",\"properties\":{\"meteringMode\":{\"description\":\"Algorithm to be used for measuring loudness. Recommended value is \\\"ITU_R_BS_1770_4\\\"\",\"enum\":[\"ITU-R BS.1770-1\",\"ITU-R BS.1770-2\",\"ITU-R BS.1770-3\",\"ITU-R BS.1770-4\",\"Leq (A)\"],\"type\":\"string\"},\"dialogueIntelligence\":{\"description\":\"Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating. Must not be \\\"DISABLED\\\" for meteringMode \\\"ITU-R BS.1770-1\\\" or \\\"Leq (A)\\\", otherwise recommended value is \\\"ENABLED\\\"\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"speechThreshold\":{\"description\":\"Specifies the percentage of speech that must be detected in the metered content before using the measured speech loudness as the overall program loudness. Given as an integer percentage between 0 and 100 (0% to 100%). Recommended value is 15\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"}},\"required\":[\"dialogueIntelligence\",\"meteringMode\",\"speechThreshold\"]}},\"required\":[\"loudnessControl\",\"bitrate\"]}},\"required\":[\"properties\"]}}},\"heAacV1\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HeAacV1AudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"4.0\",\"5.0_BACK\",\"5.1_BACK\",\"7.1\",\"7.1_WIDE_BACK\"],\"type\":\"string\"},\"signaling\":{\"description\":\"Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.\",\"enum\":[\"IMPLICIT\",\"EXPLICIT_SBR\",\"EXPLICIT_HIERARCHICAL\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"heAacV2\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HeAacV2AudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"4.0\",\"5.0_BACK\",\"5.1_BACK\",\"7.1\",\"7.1_WIDE_BACK\"],\"type\":\"string\"},\"signaling\":{\"description\":\"Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.\",\"enum\":[\"IMPLICIT\",\"EXPLICIT_SBR\",\"EXPLICIT_PS\",\"EXPLICIT_HIERARCHICAL\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"passthrough\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PassthroughAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"}}}},\"required\":[\"properties\"]}}},\"vorbis\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"VorbisAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"QUAD\",\"2.1\",\"2.2\",\"3.1\",\"4.0\",\"5.1\",\"5.1_BACK\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"opus\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"OpusAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"QUAD\",\"4.1\",\"5.0_BACK\",\"5.1_BACK\",\"6.1\",\"7.1\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"pcm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PcmAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"presetConfiguration\":{\"description\":\"Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.\",\"enum\":[\"XDCAM\"],\"type\":\"string\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"MONO\",\"STEREO\"],\"type\":\"string\"},\"sampleFormat\":{\"description\":\"Sampling format of the audio codec configuration\",\"enum\":[\"S16LE\",\"S24LE\",\"S32LE\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"ac3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Ac3AudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"QUAD\",\"2.1\",\"2.2\",\"3.1\",\"4.0\",\"4.1\",\"5.0\",\"5.0_BACK\",\"5.1\",\"5.1_BACK\"],\"type\":\"string\"},\"cutoffFrequency\":{\"description\":\"The highest frequency that will pass the audio encoder. This value is optional.\",\"type\":\"integer\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"dolbyDigital\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyDigitalAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"bitstreamInfo\":{\"type\":\"object\",\"description\":\"BitstreamInfo defines metadata parameters contained in the Dolby Digital audio bitstream\",\"properties\":{\"surroundMode\":{\"description\":\"This parameter indicates to a decoder whether the two\\u2010channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding.\\n\\nWhen downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: `ENABLED`, Lo/Ro: `DISABLED`).\\nWhen transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream.\\nWhen transcoding a third-party stereo input to stereo Dolby Digital set the value to `NOT_INDICATED`.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\",\"NOT_INDICATED\"],\"type\":\"string\"},\"surroundExMode\":{\"description\":\"This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX.\\nThis parameter is used only if the encoded audio has two surround channels.\\n\\nAn amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically.\\nThe behavior is similar to that of the `surroundMode` parameter.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\",\"NOT_INDICATED\"],\"type\":\"string\"}}},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration.\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"3.1\",\"BACK_SURROUND\",\"BACK_SURROUND_LFE\",\"QUAD\",\"QUAD_LFE\",\"4.0\",\"4.1\",\"5.0\",\"5.1\"],\"type\":\"string\"},\"downmixing\":{\"type\":\"object\",\"properties\":{\"loRoCenterMixLevel\":{\"description\":\"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.\",\"enum\":[\"PLUS_3_DB\",\"PLUS_1_5_DB\",\"ZERO_DB\",\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"ltRtCenterMixLevel\":{\"description\":\"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.\",\"enum\":[\"PLUS_3_DB\",\"PLUS_1_5_DB\",\"ZERO_DB\",\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"loRoSurroundMixLevel\":{\"description\":\"The level shift applied to the surround channels when downmixing to one Lo/Ro output.\",\"enum\":[\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"ltRtSurroundMixLevel\":{\"description\":\"The level shift applied to the surround channels when downmixing to one Lt/Rt output.\",\"enum\":[\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"preferredMode\":{\"enum\":[\"LO_RO\",\"LT_RT\",\"PRO_LOGIC_II\"],\"type\":\"string\"}}},\"evolutionFrameworkControl\":{\"description\":\"It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"loudnessControl\":{\"type\":\"object\",\"description\":\"Settings for loudness control\",\"properties\":{\"dialnorm\":{\"description\":\"Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations dialnorm must not be set.\",\"minimum\":-31,\"maximum\":-1,\"type\":\"integer\"},\"dialogueIntelligence\":{\"description\":\"This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations dialogueIntelligence must not be set.\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"PASSTHROUGH\",\"CORRECTION\"],\"type\":\"string\"},\"peakLimit\":{\"description\":\"The peak value in dB to use for loudness correction. This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations peakLimit must not be set.\",\"minimum\":-8,\"maximum\":-0.1,\"format\":\"double\",\"type\":\"number\"},\"regulationType\":{\"description\":\"This is only allowed if the mode is CORRECTION. <table> <tr><th colspan=4 align=\\\"left\\\"> Predefined values for each regulation type: </th></tr> <tr><td> Regulation Type </td><td> EBU R128 </td><td> ATSC A/85 Fixed </td><td> ATSC A/85 Agile</td></tr> <tr><td> Limit Mode </td><td> `True Peak` </td><td> `True Peak` </td><td> `True Peak` </td></tr> <tr><td> Correction Mode </td><td> `PCM Normalization` </td><td> `PCM Normalization` </td><td> `Metadata Update` </td></tr> <tr><td> Peak Limit </td><td> `\\u20133 dBTP` </td><td> `\\u20132 dBTP` </td><td> `N/A` </td></tr> <tr><td> Dialogue Intelligence </td><td> `Off` </td><td> `On` </td><td> `On` </td></tr> <tr><td> Meter Mode </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td></tr> <tr><td> Speech Threshold </td><td> `20` </td><td> `20` </td><td> `20` </td></tr> <tr><td> Dialogue Normalization </td><td> `-23 dB` </td><td> `-24 dB` </td><td> `Set to measured loudness` </td></tr> </table>\\n\",\"enum\":[\"EBU_R128\",\"ATSC_A85_FIXED\",\"ATSC_A85_AGILE\",\"MANUAL\"],\"type\":\"string\"}}},\"preprocessing\":{\"type\":\"object\",\"properties\":{\"dynamicRangeCompression\":{\"type\":\"object\",\"description\":\"It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression.\\n\\nThe values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.\\n\",\"properties\":{\"lineMode\":{\"description\":\"Line mode is intended for use in products providing line\\u2010level or speaker\\u2010level outputs, and is applicable to the widest range of products.\\nProducts such as set\\u2010top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.\",\"enum\":[\"NONE\",\"FILM_STANDARD\",\"FILM_LIGHT\",\"MUSIC_STANDARD\",\"MUSIC_LIGHT\",\"SPEECH\"],\"type\":\"string\"},\"rfMode\":{\"description\":\"RF mode is intended for products such as a low\\u2010cost television receivers.\",\"enum\":[\"NONE\",\"FILM_STANDARD\",\"FILM_LIGHT\",\"MUSIC_STANDARD\",\"MUSIC_LIGHT\",\"SPEECH\"],\"type\":\"string\"}}},\"lfeLowPassFilter\":{\"description\":\"It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel.\\n\\nThis is only allowed if the `channelLayout` contains a LFE channel.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"ninetyDegreePhaseShift\":{\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"threeDbAttenuation\":{\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"}}}},\"required\":[\"loudnessControl\",\"bitrate\"]}},\"required\":[\"properties\"]}}},\"dolbyDigitalPlus\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyDigitalPlusAudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"bitstreamInfo\":{\"type\":\"object\",\"description\":\"BitstreamInfo defines metadata parameters contained in the Dolby Digital Plus audio bitstream\",\"properties\":{\"surroundMode\":{\"description\":\"This parameter indicates to a decoder whether the two\\u2010channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding.\\n\\nWhen downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: `ENABLED`, Lo/Ro: `DISABLED`).\\nWhen transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream.\\nWhen transcoding a third-party stereo input to stereo Dolby Digital set the value to `NOT_INDICATED`.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\",\"NOT_INDICATED\"],\"type\":\"string\"},\"surroundExMode\":{\"description\":\"This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX.\\nThis parameter is used only if the encoded audio has two surround channels.\\n\\nAn amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically.\\nThe behavior is similar to that of the `surroundMode` parameter.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\",\"NOT_INDICATED\"],\"type\":\"string\"}}},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration.\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"3.1\",\"BACK_SURROUND\",\"BACK_SURROUND_LFE\",\"QUAD\",\"QUAD_LFE\",\"4.0\",\"4.1\",\"5.0\",\"5.1\"],\"type\":\"string\"},\"downmixing\":{\"type\":\"object\",\"properties\":{\"loRoCenterMixLevel\":{\"description\":\"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.\",\"enum\":[\"PLUS_3_DB\",\"PLUS_1_5_DB\",\"ZERO_DB\",\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"ltRtCenterMixLevel\":{\"description\":\"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.\",\"enum\":[\"PLUS_3_DB\",\"PLUS_1_5_DB\",\"ZERO_DB\",\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"loRoSurroundMixLevel\":{\"description\":\"The level shift applied to the surround channels when downmixing to one Lo/Ro output.\",\"enum\":[\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"ltRtSurroundMixLevel\":{\"description\":\"The level shift applied to the surround channels when downmixing to one Lt/Rt output.\",\"enum\":[\"MINUS_1_5_DB\",\"MINUS_3_DB\",\"MINUS_4_5_DB\",\"MINUS_6_DB\",\"MINUS_INFINITY_DB\"],\"type\":\"string\"},\"preferredMode\":{\"enum\":[\"LO_RO\",\"LT_RT\",\"PRO_LOGIC_II\"],\"type\":\"string\"}}},\"evolutionFrameworkControl\":{\"description\":\"It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"loudnessControl\":{\"type\":\"object\",\"description\":\"Settings for loudness control\",\"properties\":{\"dialnorm\":{\"description\":\"Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations dialnorm must not be set.\",\"minimum\":-31,\"maximum\":-1,\"type\":\"integer\"},\"dialogueIntelligence\":{\"description\":\"This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other regulationType values dialogueIntelligence must not be set.\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"PASSTHROUGH\",\"CORRECTION\"],\"type\":\"string\"},\"peakLimit\":{\"description\":\"The peak value in dB to use for loudness correction. This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other regulationType values peakLimit must not be set.\",\"minimum\":-8,\"maximum\":-0.1,\"format\":\"double\",\"type\":\"number\"},\"regulationType\":{\"description\":\"This is only allowed if the mode is CORRECTION. <table> <tr><th colspan=4 align=\\\"left\\\"> Predefined values for each regulation type: </th></tr> <tr><td> Regulation Type </td><td> EBU R128 </td><td> ATSC A/85 Fixed </td><td> ATSC A/85 Agile</td></tr> <tr><td> Limit Mode </td><td> `True Peak` </td><td> `True Peak` </td><td> `True Peak` </td></tr> <tr><td> Correction Mode </td><td> `PCM Normalization` </td><td> `PCM Normalization` </td><td> `Metadata Update` </td></tr> <tr><td> Peak Limit </td><td> `\\u20133 dBTP` </td><td> `\\u20132 dBTP` </td><td> `N/A` </td></tr> <tr><td> Dialogue Intelligence </td><td> `Off` </td><td> `On` </td><td> `On` </td></tr> <tr><td> Meter Mode </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td></tr> <tr><td> Speech Threshold </td><td> `20` </td><td> `20` </td><td> `20` </td></tr> <tr><td> Dialogue Normalization </td><td> `-23 dB` </td><td> `-24 dB` </td><td> `Set to measured loudness` </td></tr> </table>\\n\",\"enum\":[\"EBU_R128\",\"ATSC_A85_FIXED\",\"ATSC_A85_AGILE\",\"MANUAL\"],\"type\":\"string\"}}},\"preprocessing\":{\"type\":\"object\",\"properties\":{\"dynamicRangeCompression\":{\"type\":\"object\",\"description\":\"It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression.\\n\\nThe values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.\\n\",\"properties\":{\"lineMode\":{\"description\":\"Line mode is intended for use in products providing line\\u2010level or speaker\\u2010level outputs, and is applicable to the widest range of products.\\n\\nProducts such as set\\u2010top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.\\n\",\"enum\":[\"NONE\",\"FILM_STANDARD\",\"FILM_LIGHT\",\"MUSIC_STANDARD\",\"MUSIC_LIGHT\",\"SPEECH\"],\"type\":\"string\"},\"rfMode\":{\"description\":\"RF mode is intended for products such as a low\\u2010cost television receiver.\",\"enum\":[\"NONE\",\"FILM_STANDARD\",\"FILM_LIGHT\",\"MUSIC_STANDARD\",\"MUSIC_LIGHT\",\"SPEECH\"],\"type\":\"string\"}}},\"lfeLowPassFilter\":{\"description\":\"It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel.\\n\\nThis is only allowed if the `channelLayout` contains a LFE channel.\\n\",\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"ninetyDegreePhaseShift\":{\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"},\"threeDbAttenuation\":{\"enum\":[\"ENABLED\",\"DISABLED\"],\"type\":\"string\"}}}},\"required\":[\"loudnessControl\",\"bitrate\"]}},\"required\":[\"properties\"]}}},\"eac3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Eac3AudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"QUAD\",\"2.1\",\"2.2\",\"3.1\",\"4.0\",\"4.1\",\"5.0\",\"5.0_BACK\",\"5.1\",\"5.1_BACK\"],\"type\":\"string\"},\"cutoffFrequency\":{\"description\":\"The highest frequency that will pass the audio encoder. This value is optional.\",\"type\":\"integer\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"mp2\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Mp2AudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}},\"mp3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Mp3AudioConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"bitrate\":{\"description\":\"Target bitrate for the encoded audio in bps\",\"type\":\"integer\"},\"rate\":{\"description\":\"Audio sampling rate in Hz\",\"format\":\"double\",\"type\":\"number\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\"],\"type\":\"string\"}},\"required\":[\"bitrate\"]}},\"required\":[\"properties\"]}}}}},\"subtitles\":{\"type\":\"object\",\"properties\":{\"dvbSubtitle\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DvbSubtitleConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"}}}},\"required\":[\"properties\"]}}},\"webvtt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WebVttConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"appendOptionalZeroHour\":{\"type\":\"boolean\",\"description\":\"If set to true, the hours section on webvtt timestamp values will explicitely have zeroes instead of being omitted for values where hours = 0.\"},\"ignoreRegion\":{\"type\":\"boolean\",\"description\":\"If set to true, the region information of the resulting webvtt file will be omitted. Defaults to false.\"},\"cueIdentifierPolicy\":{\"enum\":[\"INCLUDE_IDENTIFIERS\",\"OMIT_IDENTIFIERS\"],\"type\":\"string\"},\"styling\":{\"type\":\"object\",\"properties\":{\"mode\":{\"enum\":[\"PASSTHROUGH\",\"DROP_STYLING\"],\"type\":\"string\"}}}}}},\"required\":[\"properties\"]}}},\"imsc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ImscConfiguration\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"styling\":{\"type\":\"object\",\"properties\":{\"mode\":{\"enum\":[\"PASSTHROUGH\",\"DROP_STYLING\"],\"type\":\"string\"}}}}}},\"required\":[\"properties\"]}}}}}}},\"filters\":{\"type\":\"object\",\"properties\":{\"conform\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ConformFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"targetFps\":{\"description\":\"The FPS the input should be changed to.\",\"format\":\"double\",\"type\":\"number\"}}}},\"required\":[\"properties\"]}}},\"watermark\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WatermarkFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"image\":{\"description\":\"URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF\",\"type\":\"string\"},\"left\":{\"description\":\"Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.\",\"type\":\"integer\"},\"right\":{\"description\":\"Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.\",\"type\":\"integer\"},\"top\":{\"description\":\"Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.\",\"type\":\"integer\"},\"bottom\":{\"description\":\"Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.\",\"type\":\"integer\"},\"unit\":{\"description\":\"Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.\",\"enum\":[\"PIXELS\",\"PERCENTS\"],\"type\":\"string\"}},\"required\":[\"image\"]}},\"required\":[\"properties\"]}}},\"audioVolume\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AudioVolumeFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"volume\":{\"description\":\"Audio volume value\",\"format\":\"double\",\"type\":\"number\"},\"unit\":{\"enum\":[\"PERCENT\",\"DB\"],\"type\":\"string\"},\"format\":{\"enum\":[\"U8\",\"S16\",\"S32\",\"U8P\",\"S16P\",\"S32P\",\"S64\",\"S64P\",\"FLT\",\"FLTP\",\"NONE\",\"DBL\",\"DBLP\"],\"type\":\"string\"}},\"required\":[\"unit\",\"volume\"]}},\"required\":[\"properties\"]}}},\"azureSpeechToCaptions\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AzureSpeechToCaptionsFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"azureSpeechToCaptionsSettings\":{\"type\":\"object\",\"properties\":{\"azureSpeechServicesCredentials\":{\"type\":\"object\",\"description\":\"Credential settings to access Azure Speech Services\\n\",\"properties\":{\"subscriptionKey\":{\"description\":\"Azure Speech Services resource key\\n\",\"type\":\"string\"}},\"required\":[\"subscriptionKey\"]},\"region\":{\"description\":\"Azure Speech Services Region Identifier. The list of speech service supported regions can be\\nfound at Azure's official documentation.\\n\",\"type\":\"string\"},\"apiEndpoint\":{\"description\":\"Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.\\n\",\"type\":\"string\"},\"language\":{\"description\":\"Azure Speech to captions supported language (IETF BCP 47 language tag).\\nThe list of supported languages can be found at Azure's official documentation.\\n\",\"type\":\"string\"},\"captionDelay\":{\"description\":\"How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience.\\nThe minimum value is 0.\\n\",\"type\":\"integer\"},\"captionRemainTime\":{\"description\":\"How many MILLISECONDS a caption should remain on screen if it is not replaced by another.\\nThe minimum value is 0.\\n\",\"type\":\"integer\"},\"captionMaxLineLength\":{\"description\":\"The maximum number of characters per line for a caption. \\nThe minimum value is 20.\\n\",\"type\":\"integer\"},\"captionLines\":{\"description\":\"The number of lines for a caption.\\nThe minimum value is 1.\\n\",\"type\":\"integer\"},\"profanityOption\":{\"description\":\"The profanity filter options are:\\n\\n- Masked: Replaces letters in profane words with asterisk (*) characters.\\n- Raw: Include the profane words verbatim.\\n- Removed: Removes profane words.\\n\",\"enum\":[\"MASKED\",\"REMOVED\",\"RAW\"],\"type\":\"string\"}}}},\"required\":[\"azureSpeechToCaptionsSettings\"]}},\"required\":[\"properties\"]}}},\"enhancedWatermark\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"EnhancedWatermarkFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"image\":{\"description\":\"URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF\",\"type\":\"string\"},\"left\":{\"description\":\"Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.\",\"format\":\"double\",\"type\":\"number\"},\"right\":{\"description\":\"Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.\",\"format\":\"double\",\"type\":\"number\"},\"top\":{\"description\":\"Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.\",\"format\":\"double\",\"type\":\"number\"},\"bottom\":{\"description\":\"Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.\",\"format\":\"double\",\"type\":\"number\"},\"unit\":{\"enum\":[\"PIXELS\",\"PERCENTS\"],\"type\":\"string\"},\"opacity\":{\"description\":\"Opacity to apply on the watermark image. Valid values are from 0.0 (completely transparent) to 1.0 (not transparent at all)\",\"format\":\"double\",\"type\":\"number\"},\"width\":{\"description\":\"Desired width of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it\",\"format\":\"double\",\"type\":\"number\"},\"height\":{\"description\":\"Desired height of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it\",\"format\":\"double\",\"type\":\"number\"}},\"required\":[\"image\"]}},\"required\":[\"properties\"]}}},\"crop\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CropFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"left\":{\"description\":\"Amount of pixels that will be cropped of the input video from the left side. Must be zero or a positive value.\",\"type\":\"integer\"},\"right\":{\"description\":\"Amount of pixels that will be cropped of the input video from the right side. Must be zero or a positive value.\",\"type\":\"integer\"},\"top\":{\"description\":\"Amount of pixels that will be cropped of the input video from the top. Must be zero or a positive value.\",\"type\":\"integer\"},\"bottom\":{\"description\":\"Amount of pixels that will be cropped of the input video from the bottom. Must be zero or a positive value.\",\"type\":\"integer\"},\"unit\":{\"enum\":[\"PIXELS\",\"PERCENTS\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"rotate\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"RotateFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"rotation\":{\"description\":\"Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise.\",\"type\":\"integer\"}},\"required\":[\"rotation\"]}},\"required\":[\"properties\"]}}},\"deinterlace\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DeinterlaceFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"parity\":{\"enum\":[\"AUTO\",\"TOP_FIELD_FIRST\",\"BOTTOM_FIELD_FIRST\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"FRAME\",\"FIELD\",\"FRAME_NOSPATIAL\",\"FIELD_NOSPATIAL\"],\"type\":\"string\"},\"frameSelectionMode\":{\"enum\":[\"ALL\",\"INTERLACED\"],\"type\":\"string\"},\"autoEnable\":{\"enum\":[\"ALWAYS_ON\",\"META_DATA_BASED\",\"META_DATA_AND_CONTENT_BASED\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"enhancedDeinterlace\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"EnhancedDeinterlaceFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"parity\":{\"enum\":[\"AUTO\",\"TOP_FIELD_FIRST\",\"BOTTOM_FIELD_FIRST\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"FRAME\",\"FIELD\"],\"type\":\"string\"},\"autoEnable\":{\"enum\":[\"ALWAYS_ON\",\"META_DATA_BASED\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"audioMix\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AudioMixFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"channelLayout\":{\"description\":\"Channel layout of the audio codec configuration\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"QUAD\",\"OCTAGONAL\",\"HEXAGONAL\",\"STEREO_DOWNMIX\",\"2.1\",\"2.2\",\"3.1\",\"4.0\",\"4.1\",\"5.0\",\"5.1\",\"5.0_BACK\",\"5.1_BACK\",\"6.0\",\"6.0_FRONT\",\"6.1\",\"6.1_BACK\",\"6.1_FRONT\",\"7.0\",\"7.0_FRONT\",\"7.1\",\"7.1_WIDE\",\"7.1_WIDE_BACK\"],\"type\":\"string\"},\"audioMixChannels\":{\"description\":\"List of mixed channels that matches the channel layout\",\"items\":{\"type\":\"object\",\"title\":\"AudioMixChannel\",\"properties\":{\"channelNumber\":{\"description\":\"Channel number of this mix (starting with 0)\",\"type\":\"integer\"},\"sourceChannels\":{\"description\":\"List of source channels to be mixed\",\"items\":{\"type\":\"object\",\"title\":\"SourceChannel\",\"properties\":{\"gain\":{\"description\":\"Gain for this source channel. Default is 1.0.\",\"format\":\"double\",\"type\":\"number\"},\"type\":{\"enum\":[\"CHANNEL_NUMBER\",\"FRONT_LEFT\",\"FRONT_RIGHT\",\"CENTER\",\"LOW_FREQUENCY\",\"BACK_LEFT\",\"BACK_RIGHT\",\"SURROUND_LEFT\",\"SURROUND_RIGHT\"],\"type\":\"string\"},\"channelNumber\":{\"description\":\"Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.\",\"type\":\"integer\"}},\"required\":[\"type\"]},\"type\":\"array\"}},\"required\":[\"channelNumber\",\"sourceChannels\"]},\"type\":\"array\"}},\"required\":[\"audioMixChannels\",\"channelLayout\"]}},\"required\":[\"properties\"]}}},\"denoiseHqdn3d\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DenoiseHqdn3dFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"lumaSpatial\":{\"description\":\"A non-negative floating point number which specifies spatial luma strength. It defaults to 4.0.\",\"format\":\"double\",\"type\":\"number\"},\"chromaSpatial\":{\"description\":\"A non-negative floating point number which specifies spatial chroma strength. It defaults to 3.0*luma_spatial/4.0.\",\"format\":\"double\",\"type\":\"number\"},\"lumaTmp\":{\"description\":\"A floating point number which specifies luma temporal strength. It defaults to 6.0*luma_spatial/4.0.\",\"format\":\"double\",\"type\":\"number\"},\"chromaTmp\":{\"description\":\"A floating point number which specifies chroma temporal strength. It defaults to luma_tmp*chroma_spatial/luma_spatial.\",\"format\":\"double\",\"type\":\"number\"}}}},\"required\":[\"properties\"]}}},\"ebuR128SinglePass\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"EbuR128SinglePassFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"integratedLoudness\":{\"description\":\"Set the targeted integrated loudness value. Range is from '-70.0' to '-5.0'. Default value is '-24.0'. Value is measured in LUFS (Loudness Units, referenced to Full Scale)\",\"format\":\"double\",\"type\":\"number\"},\"loudnessRange\":{\"description\":\"Set the targeted loudness range target. Range is from '1.0' to '20.0'. Default value is '7.0'. Loudness range measures the variation of loudness on a macroscopic time-scale in units of LU (Loudness Units). For programmes shorter than 1 minute, the use of the measure Loudness Range is not recommended due to too few data points (Loudness Range is based on the Short-term-Loudness values (3-seconds-window)).\",\"format\":\"double\",\"type\":\"number\"},\"maximumTruePeakLevel\":{\"description\":\"Set maximum true peak. Range is from '-9.0' to '0.0'. Default value is '-2.0'. Values are measured in dBTP (db True Peak)\",\"format\":\"double\",\"type\":\"number\"}}}},\"required\":[\"properties\"]}}},\"text\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"TextFilter\",\"description\":\"Only one of those properties may be set: fontSize, fontSizeExpression.\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"font\":{\"enum\":[\"DEJAVUSANS\",\"DEJAVUSERIF\",\"DEJAVUSANSMONO\",\"ROBOTOMONO\",\"ROBOTOBLACK\",\"ROBOTO\",\"ROBOTOCONDENSED\"],\"type\":\"string\"},\"box\":{\"type\":\"boolean\",\"description\":\"If set to true a box is drawn around the text using the background color.\"},\"boxBorderWidth\":{\"description\":\"The width of the box drawn around the text.\",\"type\":\"integer\"},\"boxColor\":{\"description\":\"The background color to be used for drawing the box.\",\"type\":\"string\"},\"lineSpacing\":{\"description\":\"Line spacing of the border around the box in pixels\",\"type\":\"integer\"},\"borderWidth\":{\"description\":\"Width of the border around the text\",\"type\":\"integer\"},\"fixBounds\":{\"type\":\"boolean\",\"description\":\"If set to true, it will fix text coordinates to avoid clipping if necessary\"},\"fontColor\":{\"description\":\"The color to be used to draw the text\",\"type\":\"string\"},\"fontSize\":{\"description\":\"Font size to be used to draw the text\",\"type\":\"integer\"},\"fontSizeExpression\":{\"description\":\"An expression for the Font size. Either fontSize or fontSizeExpression can be set at the same time. The following variables are valid: main_h, h, H for input height and main_w, w, W for the input_width\",\"type\":\"string\"},\"alpha\":{\"description\":\"If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.\",\"format\":\"double\",\"type\":\"number\"},\"shadowColor\":{\"description\":\"Color of the shadow\",\"type\":\"string\"},\"shadowX\":{\"description\":\"X offset of the shadow\",\"type\":\"integer\"},\"shadowY\":{\"description\":\"Y offset of the shadow\",\"type\":\"integer\"},\"timecode\":{\"description\":\"If set, the timecode representation in \\\"hh:mm:ss[:;.]ff\\\" format will be applied. Drop-frame timecodes (containing \\\";\\\" or \\\".\\\") must only be used with video frame rates of 29.97, 30, 59.94 or 60 FPS, according to the SMPTE standard\",\"type\":\"string\"},\"text\":{\"description\":\"String to be drawn\",\"type\":\"string\"},\"x\":{\"description\":\"X position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width\",\"type\":\"string\"},\"y\":{\"description\":\"Y position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width\",\"type\":\"string\"},\"rate\":{\"description\":\"Video frame rate\",\"type\":\"string\"}},\"required\":[\"x\",\"y\"]}},\"required\":[\"properties\"]}}},\"interlace\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"InterlaceFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"mode\":{\"enum\":[\"TOP\",\"BOTTOM\",\"DROP_EVEN\",\"DROP_ODD\",\"PAD\",\"INTERLACE_X2\",\"MERGE\",\"MERGE_X2\"],\"type\":\"string\"},\"verticalLowPassFilteringMode\":{\"enum\":[\"DISABLED\",\"LOW_PASS\",\"COMPLEX\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}},\"unsharp\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"UnsharpFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"lumaMatrixHorizontalSize\":{\"description\":\"Must be an odd integer between 3 and 23\",\"type\":\"integer\"},\"lumaMatrixVerticalSize\":{\"description\":\"Must be an odd integer between 3 and 23\",\"type\":\"integer\"},\"lumaEffectStrength\":{\"description\":\"Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5\",\"format\":\"double\",\"type\":\"number\"},\"chromaMatrixHorizontalSize\":{\"description\":\"Must be an odd integer between 3 and 23\",\"type\":\"integer\"},\"chromaMatrixVerticalSize\":{\"description\":\"Must be an odd integer between 3 and 23\",\"type\":\"integer\"},\"chromaEffectStrength\":{\"description\":\"Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5\",\"format\":\"double\",\"type\":\"number\"}}}},\"required\":[\"properties\"]}}},\"scale\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ScaleFilter\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"width\":{\"description\":\"The width of the output frame in pixels. If not set it will be based on the configured height by maintaining the original aspect ratio. If height is also not set, the original source dimensions will be applied.\",\"type\":\"integer\"},\"height\":{\"description\":\"The height of the output frame in pixels. If not set it will be based on the configured width by maintaining the original aspect ratio. If width is also not set, the original source dimensions will be applied.\",\"type\":\"integer\"},\"scalingAlgorithm\":{\"enum\":[\"FAST_BILINEAR\",\"BILINEAR\",\"BICUBIC\",\"EXPERIMENTAL\",\"NEAREST_NEIGHBOR\",\"AVERAGING_AREA\",\"BICUBIC_LUMA_BILINEAR_CHROMA\",\"GAUSS\",\"SINC\",\"LANCZOS\",\"SPLINE\"],\"type\":\"string\"},\"sampleAspectRatioNumerator\":{\"description\":\"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set.\",\"type\":\"integer\"},\"sampleAspectRatioDenominator\":{\"description\":\"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set.\",\"type\":\"integer\"}}}},\"required\":[\"properties\"]}}}}},\"encodings\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Encoding\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"description\":\"Type of the encoding\",\"enum\":[\"LIVE\",\"VOD\",\"NONE\"],\"type\":\"string\"},\"cloudRegion\":{\"enum\":[\"AWS_US_EAST_1\",\"AWS_US_EAST_2\",\"AWS_US_WEST_1\",\"AWS_US_WEST_2\",\"AWS_EU_WEST_1\",\"AWS_EU_CENTRAL_1\",\"AWS_AP_SOUTHEAST_1\",\"AWS_AP_SOUTHEAST_2\",\"AWS_AP_NORTHEAST_1\",\"AWS_AP_NORTHEAST_2\",\"AWS_AP_SOUTH_1\",\"AWS_SA_EAST_1\",\"AWS_EU_WEST_2\",\"AWS_EU_WEST_3\",\"AWS_CA_CENTRAL_1\",\"AWS_EU_NORTH_1\",\"GOOGLE_US_CENTRAL_1\",\"GOOGLE_US_EAST_1\",\"GOOGLE_ASIA_EAST_1\",\"GOOGLE_EUROPE_WEST_1\",\"GOOGLE_US_WEST_1\",\"GOOGLE_ASIA_EAST_2\",\"GOOGLE_ASIA_NORTHEAST_1\",\"GOOGLE_ASIA_SOUTH_1\",\"GOOGLE_ASIA_SOUTHEAST_1\",\"GOOGLE_AUSTRALIA_SOUTHEAST_1\",\"GOOGLE_EUROPE_NORTH_1\",\"GOOGLE_EUROPE_WEST_2\",\"GOOGLE_EUROPE_WEST_3\",\"GOOGLE_EUROPE_WEST_4\",\"GOOGLE_NORTHAMERICA_NORTHEAST_1\",\"GOOGLE_SOUTHAMERICA_EAST_1\",\"GOOGLE_US_EAST_4\",\"GOOGLE_US_WEST_2\",\"GOOGLE_ME_CENTRAL_2\",\"AZURE_ASIA_EAST\",\"AZURE_ASIA_SOUTHEAST\",\"AZURE_AUSTRALIA_EAST\",\"AZURE_AUSTRALIA_SOUTHEAST\",\"AZURE_BRAZIL_SOUTH\",\"AZURE_CANADA_CENTRAL\",\"AZURE_EUROPE_NORTH\",\"AZURE_EUROPE_WEST\",\"AZURE_FRANCE_CENTRAL\",\"AZURE_GERMANY_WESTCENTRAL\",\"AZURE_INDIA_CENTRAL\",\"AZURE_INDIA_SOUTH\",\"AZURE_JAPAN_EAST\",\"AZURE_JAPAN_WEST\",\"AZURE_KOREA_CENTRAL\",\"AZURE_UAE_NORTH\",\"AZURE_US_CENTRAL\",\"AZURE_US_EAST\",\"AZURE_US_EAST2\",\"AZURE_US_WEST\",\"AZURE_US_WEST2\",\"AZURE_US_SOUTH_CENTRAL\",\"AZURE_US_NORTH_CENTRAL\",\"AZURE_UK_SOUTH\",\"AKAMAI_BR_GRU\",\"AKAMAI_ES_MAD\",\"AKAMAI_FR_PAR\",\"AKAMAI_ID_CGK\",\"AKAMAI_IN_MAA\",\"AKAMAI_IT_MIL\",\"AKAMAI_JP_OSA\",\"AKAMAI_NL_AMS\",\"AKAMAI_SE_STO\",\"AKAMAI_US_LAX\",\"AKAMAI_US_MIA\",\"AKAMAI_US_ORD\",\"AKAMAI_US_SEA\",\"OCI_EU_FRANKFURT_1\",\"OCI_US_ASHBURN_1\",\"NORTH_AMERICA\",\"SOUTH_AMERICA\",\"EUROPE\",\"AFRICA\",\"ASIA\",\"AUSTRALIA\",\"AWS\",\"GOOGLE\",\"KUBERNETES\",\"EXTERNAL\",\"AUTO\"],\"type\":\"string\"},\"fallbackCloudRegions\":{\"description\":\"Specify a list of regions which are used in case the preferred region is down. Currently there are several restrictions.\\n- The region has to be specific or AUTO\\n- The region has to be for the same cloud provider as the default one\\n- You can only configure at most 3 fallback regions\\n\",\"items\":{\"type\":\"string\",\"title\":\"CloudRegion\"},\"type\":\"array\"},\"encoderVersion\":{\"description\":\"Version of the encoder\",\"type\":\"string\"},\"infrastructureId\":{\"description\":\"Define an external infrastructure to run the encoding on. Note If you set this value, the `cloudRegion` must be 'EXTERNAL'.\",\"type\":\"string\"},\"infrastructure\":{\"type\":\"object\",\"properties\":{\"infrastructureId\":{\"description\":\"Id of a custom infrastructure, e.g., AWS Cloud Connect\",\"type\":\"string\"},\"cloudRegion\":{\"enum\":[\"AWS_US_EAST_1\",\"AWS_US_EAST_2\",\"AWS_US_WEST_1\",\"AWS_US_WEST_2\",\"AWS_EU_WEST_1\",\"AWS_EU_CENTRAL_1\",\"AWS_AP_SOUTHEAST_1\",\"AWS_AP_SOUTHEAST_2\",\"AWS_AP_NORTHEAST_1\",\"AWS_AP_NORTHEAST_2\",\"AWS_AP_SOUTH_1\",\"AWS_SA_EAST_1\",\"AWS_EU_WEST_2\",\"AWS_EU_WEST_3\",\"AWS_CA_CENTRAL_1\",\"AWS_EU_NORTH_1\",\"GOOGLE_US_CENTRAL_1\",\"GOOGLE_US_EAST_1\",\"GOOGLE_ASIA_EAST_1\",\"GOOGLE_EUROPE_WEST_1\",\"GOOGLE_US_WEST_1\",\"GOOGLE_ASIA_EAST_2\",\"GOOGLE_ASIA_NORTHEAST_1\",\"GOOGLE_ASIA_SOUTH_1\",\"GOOGLE_ASIA_SOUTHEAST_1\",\"GOOGLE_AUSTRALIA_SOUTHEAST_1\",\"GOOGLE_EUROPE_NORTH_1\",\"GOOGLE_EUROPE_WEST_2\",\"GOOGLE_EUROPE_WEST_3\",\"GOOGLE_EUROPE_WEST_4\",\"GOOGLE_NORTHAMERICA_NORTHEAST_1\",\"GOOGLE_SOUTHAMERICA_EAST_1\",\"GOOGLE_US_EAST_4\",\"GOOGLE_US_WEST_2\",\"GOOGLE_ME_CENTRAL_2\",\"AZURE_ASIA_EAST\",\"AZURE_ASIA_SOUTHEAST\",\"AZURE_AUSTRALIA_EAST\",\"AZURE_AUSTRALIA_SOUTHEAST\",\"AZURE_BRAZIL_SOUTH\",\"AZURE_CANADA_CENTRAL\",\"AZURE_EUROPE_NORTH\",\"AZURE_EUROPE_WEST\",\"AZURE_FRANCE_CENTRAL\",\"AZURE_GERMANY_WESTCENTRAL\",\"AZURE_INDIA_CENTRAL\",\"AZURE_INDIA_SOUTH\",\"AZURE_JAPAN_EAST\",\"AZURE_JAPAN_WEST\",\"AZURE_KOREA_CENTRAL\",\"AZURE_UAE_NORTH\",\"AZURE_US_CENTRAL\",\"AZURE_US_EAST\",\"AZURE_US_EAST2\",\"AZURE_US_WEST\",\"AZURE_US_WEST2\",\"AZURE_US_SOUTH_CENTRAL\",\"AZURE_US_NORTH_CENTRAL\",\"AZURE_UK_SOUTH\",\"AKAMAI_BR_GRU\",\"AKAMAI_ES_MAD\",\"AKAMAI_FR_PAR\",\"AKAMAI_ID_CGK\",\"AKAMAI_IN_MAA\",\"AKAMAI_IT_MIL\",\"AKAMAI_JP_OSA\",\"AKAMAI_NL_AMS\",\"AKAMAI_SE_STO\",\"AKAMAI_US_LAX\",\"AKAMAI_US_MIA\",\"AKAMAI_US_ORD\",\"AKAMAI_US_SEA\",\"OCI_EU_FRANKFURT_1\",\"OCI_US_ASHBURN_1\",\"NORTH_AMERICA\",\"SOUTH_AMERICA\",\"EUROPE\",\"AFRICA\",\"ASIA\",\"AUSTRALIA\",\"AWS\",\"GOOGLE\",\"KUBERNETES\",\"EXTERNAL\",\"AUTO\"],\"type\":\"string\"}}},\"staticIpId\":{\"description\":\"Specify an ID of a Static IP infrastructure resource this encoding should use. A Static IP cannot be used by multiple encodings at once. The encoding will go to an error state if the Static IP is already in use. This is currently only supported for live encodings.\",\"type\":\"string\"},\"selectedEncodingMode\":{\"description\":\"After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when `encodingMode` was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"selectedCloudRegion\":{\"description\":\"After the encoding has been started, this will contain the cloud region that was actually used. This will differ from cloudRegion if cloudRegion was set to an unspecific region (e.g. 'AUTO')\",\"enum\":[\"AWS_US_EAST_1\",\"AWS_US_EAST_2\",\"AWS_US_WEST_1\",\"AWS_US_WEST_2\",\"AWS_EU_WEST_1\",\"AWS_EU_CENTRAL_1\",\"AWS_AP_SOUTHEAST_1\",\"AWS_AP_SOUTHEAST_2\",\"AWS_AP_NORTHEAST_1\",\"AWS_AP_NORTHEAST_2\",\"AWS_AP_SOUTH_1\",\"AWS_SA_EAST_1\",\"AWS_EU_WEST_2\",\"AWS_EU_WEST_3\",\"AWS_CA_CENTRAL_1\",\"AWS_EU_NORTH_1\",\"GOOGLE_US_CENTRAL_1\",\"GOOGLE_US_EAST_1\",\"GOOGLE_ASIA_EAST_1\",\"GOOGLE_EUROPE_WEST_1\",\"GOOGLE_US_WEST_1\",\"GOOGLE_ASIA_EAST_2\",\"GOOGLE_ASIA_NORTHEAST_1\",\"GOOGLE_ASIA_SOUTH_1\",\"GOOGLE_ASIA_SOUTHEAST_1\",\"GOOGLE_AUSTRALIA_SOUTHEAST_1\",\"GOOGLE_EUROPE_NORTH_1\",\"GOOGLE_EUROPE_WEST_2\",\"GOOGLE_EUROPE_WEST_3\",\"GOOGLE_EUROPE_WEST_4\",\"GOOGLE_NORTHAMERICA_NORTHEAST_1\",\"GOOGLE_SOUTHAMERICA_EAST_1\",\"GOOGLE_US_EAST_4\",\"GOOGLE_US_WEST_2\",\"GOOGLE_ME_CENTRAL_2\",\"AZURE_ASIA_EAST\",\"AZURE_ASIA_SOUTHEAST\",\"AZURE_AUSTRALIA_EAST\",\"AZURE_AUSTRALIA_SOUTHEAST\",\"AZURE_BRAZIL_SOUTH\",\"AZURE_CANADA_CENTRAL\",\"AZURE_EUROPE_NORTH\",\"AZURE_EUROPE_WEST\",\"AZURE_FRANCE_CENTRAL\",\"AZURE_GERMANY_WESTCENTRAL\",\"AZURE_INDIA_CENTRAL\",\"AZURE_INDIA_SOUTH\",\"AZURE_JAPAN_EAST\",\"AZURE_JAPAN_WEST\",\"AZURE_KOREA_CENTRAL\",\"AZURE_UAE_NORTH\",\"AZURE_US_CENTRAL\",\"AZURE_US_EAST\",\"AZURE_US_EAST2\",\"AZURE_US_WEST\",\"AZURE_US_WEST2\",\"AZURE_US_SOUTH_CENTRAL\",\"AZURE_US_NORTH_CENTRAL\",\"AZURE_UK_SOUTH\",\"AKAMAI_BR_GRU\",\"AKAMAI_ES_MAD\",\"AKAMAI_FR_PAR\",\"AKAMAI_ID_CGK\",\"AKAMAI_IN_MAA\",\"AKAMAI_IT_MIL\",\"AKAMAI_JP_OSA\",\"AKAMAI_NL_AMS\",\"AKAMAI_SE_STO\",\"AKAMAI_US_LAX\",\"AKAMAI_US_MIA\",\"AKAMAI_US_ORD\",\"AKAMAI_US_SEA\",\"OCI_EU_FRANKFURT_1\",\"OCI_US_ASHBURN_1\",\"NORTH_AMERICA\",\"SOUTH_AMERICA\",\"EUROPE\",\"AFRICA\",\"ASIA\",\"AUSTRALIA\",\"AWS\",\"GOOGLE\",\"KUBERNETES\",\"EXTERNAL\",\"AUTO\"],\"type\":\"string\"},\"status\":{\"description\":\"The current status of the encoding.\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"labels\":{\"description\":\"You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"liveOptionsType\":{\"description\":\"The chosen live option type of the live encoding\",\"enum\":[\"HD\"],\"type\":\"string\"}}},\"streams\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Stream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputStreams\":{\"description\":\"Determines the input source(s) for the stream. All video streams of an encoding need to have identical input configurations\",\"items\":{\"type\":\"object\",\"title\":\"StreamInput\",\"properties\":{\"inputId\":{\"description\":\"ID of an Input resource defining the input storage. Required if 'inputStreamId' is not set.\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to an input media file. Required if 'inputStreamId' is not set.\",\"type\":\"string\"},\"selectionMode\":{\"description\":\"Specifies the strategy for selecting a stream from the input file. Must not be set when 'inputStreamId' is set.\",\"enum\":[\"AUTO\",\"POSITION_ABSOLUTE\",\"VIDEO_RELATIVE\",\"AUDIO_RELATIVE\",\"SUBTITLE_RELATIVE\"],\"type\":\"string\"},\"position\":{\"description\":\"Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.\",\"minimum\":0,\"type\":\"integer\"},\"inputStreamId\":{\"description\":\"Set this property instead of all others to reference an InputStream resource (e.g. an Ingest-, Trimming- or ConcatenationInputStream)\",\"type\":\"string\"},\"analysisDetails\":{\"type\":\"object\",\"description\":\"Input analysis details\\n\\nThis property is populated after the encoding has finished\\n\",\"properties\":{\"tags\":{\"type\":\"object\",\"description\":\"Additional metadata saved in the input file\"}}}}},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"createQualityMetaData\":{\"type\":\"boolean\",\"description\":\"Set true to create quality metadata for this stream\"},\"codecConfigId\":{\"description\":\"Id of the codec configuration\",\"type\":\"string\"},\"conditions\":{\"type\":\"object\",\"description\":\"Defines a condition that is evaluated against the input of the Stream. If the condition is not fulfilled, the Stream will be ignored during the encoding process. The 'streamConditionMode' of a Muxing allows to control how ignored Streams affect the Muxing. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored. See [Stream Conditions](https://bitmovin.com/docs/encoding/articles/stream-conditions) for more information\"},\"mode\":{\"description\":\"Mode of the stream\",\"enum\":[\"STANDARD\",\"PER_TITLE_TEMPLATE\",\"PER_TITLE_TEMPLATE_FIXED_RESOLUTION\",\"PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE\",\"PER_TITLE_RESULT\"],\"type\":\"string\"},\"selectedEncodingMode\":{\"description\":\"The encoding mode that was used for this stream. This is derived from `encodingMode`, which can be specified in the codec configuration or in the encoding start request. Note that all streams of an encoding need to use the same encoding mode. This will therefore always match `selectedEncodingMode` of the related Encoding resource. Especially useful when `encodingMode` was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"perTitleSettings\":{\"type\":\"object\",\"description\":\"Settings to configure Per-Title on stream level\",\"properties\":{\"fixedResolutionAndBitrateSettings\":{\"type\":\"object\",\"description\":\"Settings for PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE mode\",\"properties\":{\"minBitrate\":{\"description\":\"The minimum bitrate that will be used for that template.\",\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"The maximum bitrate that will be used for that template.\",\"type\":\"integer\"},\"bitrateSelectionMode\":{\"description\":\"Bitrate selection mode\",\"enum\":[\"OPTIMIZED\",\"COMPLEXITY_RANGE\"],\"type\":\"string\"},\"lowComplexityBoundaryForMaxBitrate\":{\"description\":\"Low complexity boundary for max bitrate\",\"type\":\"integer\"},\"highComplexityBoundaryForMaxBitrate\":{\"description\":\"High complexity boundary for max bitrate\",\"type\":\"integer\"}}},\"codecMaxBitrateFactor\":{\"description\":\"This factor is used to calculate the maxBitrate of the codec configuration for the generated representation as a multiple of the targetBitrate(generated by Per-Title algorithm). This value will take precedence over the 'codecMaxBitrateFactor' from the pertitleStartConfiguration. This value will only have an impact on streams with h264 or h265 video configurations.\",\"format\":\"double\",\"type\":\"number\"},\"codecBufsizeFactor\":{\"description\":\"This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate(generated by Per-Title algorithm). This value will take precedence over the 'codecBufsizeFactor' from the pertitleStartConfiguration.. This value will only have an impact on streams with h264 or h265 video configurations.\",\"format\":\"double\",\"type\":\"number\"}}},\"metadata\":{\"type\":\"object\",\"properties\":{\"language\":{\"description\":\"Language of the media contained in the stream. If the value is not set, then no metadata tag is set for the media stream.\",\"type\":\"string\"}}},\"decodingErrorMode\":{\"description\":\"Determines how to react to errors during decoding\",\"enum\":[\"FAIL_ON_ERROR\",\"DUPLICATE_FRAMES\"],\"type\":\"string\"},\"appliedSettings\":{\"type\":\"object\",\"description\":\"Contains stream properties which may not have been defined in the configuration\",\"properties\":{\"width\":{\"description\":\"The applied width. Useful if the width in the configuration was undefined\",\"type\":\"integer\"},\"height\":{\"description\":\"The applied height. Useful if the height in the configuration was undefined\",\"type\":\"integer\"}}}},\"required\":[\"codecConfigId\",\"inputStreams\"]},\"filters\":{\"type\":\"object\",\"properties\":{\"properties\":{\"items\":{\"type\":\"object\",\"title\":\"StreamFilter\",\"properties\":{\"id\":{\"description\":\"The id of the filter that should be used in the stream\",\"type\":\"string\"},\"position\":{\"description\":\"Defines the order in which filters are applied. Filters are applied in ascending order.\",\"type\":\"integer\"}},\"required\":[\"id\",\"position\"]},\"type\":\"array\"}},\"required\":[\"properties\"]},\"burnInSubtitles\":{\"type\":\"object\",\"properties\":{\"dvbsub\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"BurnInSubtitleDvbSub\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputStreamId\":{\"description\":\"Id of an IngestInputStream which specifies the stream of the DVB-SUB subtitles\",\"type\":\"string\"}},\"required\":[\"inputStreamId\"]}},\"required\":[\"properties\"]}}},\"srt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"BurnInSubtitleSrt\",\"properties\":{\"id\":{\"type\":\"object\",\"description\":\"Id of the burn-in SRT subtitle\"},\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"characterEncoding\":{\"description\":\"Character encoding of the SRT file\",\"enum\":[\"ANSI_X3.4-1968\",\"ANSI_X3.4-1986\",\"ARABIC\",\"ARMSCII-8\",\"ASCII\",\"ASMO-708\",\"BIG-5\",\"BIG-FIVE\",\"BIG5\",\"BIG5-HKSCS\",\"BIG5-HKSCS:1999\",\"BIG5-HKSCS:2001\",\"BIG5-HKSCS:2004\",\"BIG5-HKSCS:2008\",\"BIG5HKSCS\",\"BIGFIVE\",\"C99\",\"CHAR\",\"CHINESE\",\"CN\",\"CN-BIG5\",\"CN-GB\",\"CN-GB-ISOIR165\",\"CP1131\",\"CP1133\",\"CP1250\",\"CP1251\",\"CP1252\",\"CP1253\",\"CP1254\",\"CP1255\",\"CP1256\",\"CP1257\",\"CP1258\",\"CP1361\",\"CP154\",\"CP367\",\"CP819\",\"CP850\",\"CP862\",\"CP866\",\"CP874\",\"CP932\",\"CP936\",\"CP949\",\"CP950\",\"CSASCII\",\"CSBIG5\",\"CSEUCKR\",\"CSEUCPKDFMTJAPANESE\",\"CSEUCTW\",\"CSGB2312\",\"CSHALFWIDTHKATAKANA\",\"CSHPROMAN8\",\"CSIBM866\",\"CSISO14JISC6220RO\",\"CSISO159JISX02121990\",\"CSISO2022CN\",\"CSISO2022JP\",\"CSISO2022JP2\",\"CSISO2022KR\",\"CSISO57GB1988\",\"CSISO58GB231280\",\"CSISO87JISX0208\",\"CSISOLATIN1\",\"CSISOLATIN2\",\"CSISOLATIN3\",\"CSISOLATIN4\",\"CSISOLATIN5\",\"CSISOLATIN6\",\"CSISOLATINARABIC\",\"CSISOLATINCYRILLIC\",\"CSISOLATINGREEK\",\"CSISOLATINHEBREW\",\"CSKOI8R\",\"CSKSC56011987\",\"CSKZ1048\",\"CSMACINTOSH\",\"CSPC850MULTILINGUAL\",\"CSPC862LATINHEBREW\",\"CSPTCP154\",\"CSSHIFTJIS\",\"CSUCS4\",\"CSUNICODE\",\"CSUNICODE11\",\"CSUNICODE11UTF7\",\"CSVISCII\",\"CYRILLIC\",\"CYRILLIC-ASIAN\",\"ECMA-114\",\"ECMA-118\",\"ELOT_928\",\"EUC-CN\",\"EUC-JP\",\"EUC-KR\",\"EUC-TW\",\"EUCCN\",\"EUCJP\",\"EUCKR\",\"EUCTW\",\"EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE\",\"GB_1988-80\",\"GB_2312-80\",\"GB18030\",\"GB2312\",\"GBK\",\"GEORGIAN-ACADEMY\",\"GEORGIAN-PS\",\"GREEK\",\"GREEK8\",\"HEBREW\",\"HP-ROMAN8\",\"HZ\",\"HZ-GB-2312\",\"IBM-CP1133\",\"IBM367\",\"IBM819\",\"IBM850\",\"IBM862\",\"IBM866\",\"ISO-10646-UCS-2\",\"ISO-10646-UCS-4\",\"ISO-2022-CN\",\"ISO-2022-CN-EXT\",\"ISO-2022-JP\",\"ISO-2022-JP-1\",\"ISO-2022-JP-2\",\"ISO-2022-KR\",\"ISO-8859-1\",\"ISO-8859-10\",\"ISO-8859-11\",\"ISO-8859-13\",\"ISO-8859-14\",\"ISO-8859-15\",\"ISO-8859-16\",\"ISO-8859-2\",\"ISO-8859-3\",\"ISO-8859-4\",\"ISO-8859-5\",\"ISO-8859-6\",\"ISO-8859-7\",\"ISO-8859-8\",\"ISO-8859-9\",\"ISO-CELTIC\",\"ISO-IR-100\",\"ISO-IR-101\",\"ISO-IR-109\",\"ISO-IR-110\",\"ISO-IR-126\",\"ISO-IR-127\",\"ISO-IR-138\",\"ISO-IR-14\",\"ISO-IR-144\",\"ISO-IR-148\",\"ISO-IR-149\",\"ISO-IR-157\",\"ISO-IR-159\",\"ISO-IR-165\",\"ISO-IR-166\",\"ISO-IR-179\",\"ISO-IR-199\",\"ISO-IR-203\",\"ISO-IR-226\",\"ISO-IR-57\",\"ISO-IR-58\",\"ISO-IR-6\",\"ISO-IR-87\",\"ISO_646.IRV:1991\",\"ISO_8859-1:1987\",\"ISO_8859-10:1992\",\"ISO_8859-14:1998\",\"ISO_8859-15:1998\",\"ISO_8859-16:2001\",\"ISO_8859-2:1987\",\"ISO_8859-3:1988\",\"ISO_8859-4:1988\",\"ISO_8859-5:1988\",\"ISO_8859-6:1987\",\"ISO_8859-7:1987\",\"ISO_8859-7:2003\",\"ISO_8859-8:1988\",\"ISO_8859-9:1989\",\"ISO646-CN\",\"ISO646-JP\",\"ISO646-US\",\"ISO8859-1\",\"ISO8859-10\",\"ISO8859-11\",\"ISO8859-13\",\"ISO8859-14\",\"ISO8859-15\",\"ISO8859-16\",\"ISO8859-2\",\"ISO8859-3\",\"ISO8859-4\",\"ISO8859-5\",\"ISO8859-6\",\"ISO8859-7\",\"ISO8859-8\",\"ISO8859-9\",\"JAVA\",\"JIS_C6220-1969-RO\",\"JIS_C6226-1983\",\"JIS_X0201\",\"JIS_X0208\",\"JIS_X0208-1983\",\"JIS_X0208-1990\",\"JIS_X0212\",\"JIS_X0212-1990\",\"JIS_X0212.1990-0\",\"JIS0208\",\"JISX0201-1976\",\"JOHAB\",\"JP\",\"KOI8-R\",\"KOI8-RU\",\"KOI8-T\",\"KOI8-U\",\"KOREAN\",\"KS_C_5601-1987\",\"KS_C_5601-1989\",\"KSC_5601\",\"KZ-1048\",\"L1\",\"L10\",\"L2\",\"L3\",\"L4\",\"L5\",\"L6\",\"L7\",\"L8\",\"LATIN-9\",\"LATIN1\",\"LATIN10\",\"LATIN2\",\"LATIN3\",\"LATIN4\",\"LATIN5\",\"LATIN6\",\"LATIN7\",\"LATIN8\",\"MAC\",\"MACARABIC\",\"MACCENTRALEUROPE\",\"MACCROATIAN\",\"MACCYRILLIC\",\"MACGREEK\",\"MACHEBREW\",\"MACICELAND\",\"MACINTOSH\",\"MACROMAN\",\"MACROMANIA\",\"MACTHAI\",\"MACTURKISH\",\"MACUKRAINE\",\"MS-ANSI\",\"MS-ARAB\",\"MS-CYRL\",\"MS-EE\",\"MS-GREEK\",\"MS-HEBR\",\"MS-TURK\",\"MS_KANJI\",\"MS936\",\"MULELAO-1\",\"NEXTSTEP\",\"PT154\",\"PTCP154\",\"R8\",\"RK1048\",\"ROMAN8\",\"SHIFT-JIS\",\"SJIS\",\"STRK1048-2002\",\"TCVN\",\"TCVN-5712\",\"TCVN5712-1\",\"TCVN5712-1:1993\",\"TIS-620\",\"TIS620\",\"TIS620-0\",\"TIS620.2529-1\",\"TIS620.2533-0\",\"TIS620.2533-1\",\"UCS-2\",\"UCS-2-INTERNAL\",\"UCS-2-SWAPPED\",\"UCS-2BE\",\"UCS-2LE\",\"UCS-4\",\"UCS-4-INTERNAL\",\"UCS-4-SWAPPED\",\"UCS-4BE\",\"UCS-4LE\",\"UHC\",\"UNICODE-1-1\",\"UNICODE-1-1-UTF-7\",\"UNICODEBIG\",\"UNICODELITTLE\",\"US\",\"US-ASCII\",\"UTF-16\",\"UTF-16BE\",\"UTF-16LE\",\"UTF-32\",\"UTF-32BE\",\"UTF-32LE\",\"UTF-7\",\"UTF-8\",\"VISCII\",\"VISCII1.1-1\",\"WCHAR_T\",\"WINBALTRIM\",\"WINDOWS-1250\",\"WINDOWS-1251\",\"WINDOWS-1252\",\"WINDOWS-1253\",\"WINDOWS-1254\",\"WINDOWS-1255\",\"WINDOWS-1256\",\"WINDOWS-1257\",\"WINDOWS-1258\",\"WINDOWS-874\",\"WINDOWS-936\",\"X0201\",\"X0208\",\"X0212\"],\"type\":\"string\"},\"input\":{\"type\":\"object\",\"description\":\"The input location to get the SRT file from\",\"properties\":{\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]}},\"required\":[\"characterEncoding\",\"id\",\"input\"]}},\"required\":[\"properties\"]}}},\"assa\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"BurnInSubtitleAssa\",\"properties\":{\"id\":{\"type\":\"object\",\"description\":\"Id of the burn-in ASSA subtitle\"},\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"characterEncoding\":{\"description\":\"Character encoding of the ASSA file\",\"enum\":[\"ANSI_X3.4-1968\",\"ANSI_X3.4-1986\",\"ARABIC\",\"ARMSCII-8\",\"ASCII\",\"ASMO-708\",\"BIG-5\",\"BIG-FIVE\",\"BIG5\",\"BIG5-HKSCS\",\"BIG5-HKSCS:1999\",\"BIG5-HKSCS:2001\",\"BIG5-HKSCS:2004\",\"BIG5-HKSCS:2008\",\"BIG5HKSCS\",\"BIGFIVE\",\"C99\",\"CHAR\",\"CHINESE\",\"CN\",\"CN-BIG5\",\"CN-GB\",\"CN-GB-ISOIR165\",\"CP1131\",\"CP1133\",\"CP1250\",\"CP1251\",\"CP1252\",\"CP1253\",\"CP1254\",\"CP1255\",\"CP1256\",\"CP1257\",\"CP1258\",\"CP1361\",\"CP154\",\"CP367\",\"CP819\",\"CP850\",\"CP862\",\"CP866\",\"CP874\",\"CP932\",\"CP936\",\"CP949\",\"CP950\",\"CSASCII\",\"CSBIG5\",\"CSEUCKR\",\"CSEUCPKDFMTJAPANESE\",\"CSEUCTW\",\"CSGB2312\",\"CSHALFWIDTHKATAKANA\",\"CSHPROMAN8\",\"CSIBM866\",\"CSISO14JISC6220RO\",\"CSISO159JISX02121990\",\"CSISO2022CN\",\"CSISO2022JP\",\"CSISO2022JP2\",\"CSISO2022KR\",\"CSISO57GB1988\",\"CSISO58GB231280\",\"CSISO87JISX0208\",\"CSISOLATIN1\",\"CSISOLATIN2\",\"CSISOLATIN3\",\"CSISOLATIN4\",\"CSISOLATIN5\",\"CSISOLATIN6\",\"CSISOLATINARABIC\",\"CSISOLATINCYRILLIC\",\"CSISOLATINGREEK\",\"CSISOLATINHEBREW\",\"CSKOI8R\",\"CSKSC56011987\",\"CSKZ1048\",\"CSMACINTOSH\",\"CSPC850MULTILINGUAL\",\"CSPC862LATINHEBREW\",\"CSPTCP154\",\"CSSHIFTJIS\",\"CSUCS4\",\"CSUNICODE\",\"CSUNICODE11\",\"CSUNICODE11UTF7\",\"CSVISCII\",\"CYRILLIC\",\"CYRILLIC-ASIAN\",\"ECMA-114\",\"ECMA-118\",\"ELOT_928\",\"EUC-CN\",\"EUC-JP\",\"EUC-KR\",\"EUC-TW\",\"EUCCN\",\"EUCJP\",\"EUCKR\",\"EUCTW\",\"EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE\",\"GB_1988-80\",\"GB_2312-80\",\"GB18030\",\"GB2312\",\"GBK\",\"GEORGIAN-ACADEMY\",\"GEORGIAN-PS\",\"GREEK\",\"GREEK8\",\"HEBREW\",\"HP-ROMAN8\",\"HZ\",\"HZ-GB-2312\",\"IBM-CP1133\",\"IBM367\",\"IBM819\",\"IBM850\",\"IBM862\",\"IBM866\",\"ISO-10646-UCS-2\",\"ISO-10646-UCS-4\",\"ISO-2022-CN\",\"ISO-2022-CN-EXT\",\"ISO-2022-JP\",\"ISO-2022-JP-1\",\"ISO-2022-JP-2\",\"ISO-2022-KR\",\"ISO-8859-1\",\"ISO-8859-10\",\"ISO-8859-11\",\"ISO-8859-13\",\"ISO-8859-14\",\"ISO-8859-15\",\"ISO-8859-16\",\"ISO-8859-2\",\"ISO-8859-3\",\"ISO-8859-4\",\"ISO-8859-5\",\"ISO-8859-6\",\"ISO-8859-7\",\"ISO-8859-8\",\"ISO-8859-9\",\"ISO-CELTIC\",\"ISO-IR-100\",\"ISO-IR-101\",\"ISO-IR-109\",\"ISO-IR-110\",\"ISO-IR-126\",\"ISO-IR-127\",\"ISO-IR-138\",\"ISO-IR-14\",\"ISO-IR-144\",\"ISO-IR-148\",\"ISO-IR-149\",\"ISO-IR-157\",\"ISO-IR-159\",\"ISO-IR-165\",\"ISO-IR-166\",\"ISO-IR-179\",\"ISO-IR-199\",\"ISO-IR-203\",\"ISO-IR-226\",\"ISO-IR-57\",\"ISO-IR-58\",\"ISO-IR-6\",\"ISO-IR-87\",\"ISO_646.IRV:1991\",\"ISO_8859-1:1987\",\"ISO_8859-10:1992\",\"ISO_8859-14:1998\",\"ISO_8859-15:1998\",\"ISO_8859-16:2001\",\"ISO_8859-2:1987\",\"ISO_8859-3:1988\",\"ISO_8859-4:1988\",\"ISO_8859-5:1988\",\"ISO_8859-6:1987\",\"ISO_8859-7:1987\",\"ISO_8859-7:2003\",\"ISO_8859-8:1988\",\"ISO_8859-9:1989\",\"ISO646-CN\",\"ISO646-JP\",\"ISO646-US\",\"ISO8859-1\",\"ISO8859-10\",\"ISO8859-11\",\"ISO8859-13\",\"ISO8859-14\",\"ISO8859-15\",\"ISO8859-16\",\"ISO8859-2\",\"ISO8859-3\",\"ISO8859-4\",\"ISO8859-5\",\"ISO8859-6\",\"ISO8859-7\",\"ISO8859-8\",\"ISO8859-9\",\"JAVA\",\"JIS_C6220-1969-RO\",\"JIS_C6226-1983\",\"JIS_X0201\",\"JIS_X0208\",\"JIS_X0208-1983\",\"JIS_X0208-1990\",\"JIS_X0212\",\"JIS_X0212-1990\",\"JIS_X0212.1990-0\",\"JIS0208\",\"JISX0201-1976\",\"JOHAB\",\"JP\",\"KOI8-R\",\"KOI8-RU\",\"KOI8-T\",\"KOI8-U\",\"KOREAN\",\"KS_C_5601-1987\",\"KS_C_5601-1989\",\"KSC_5601\",\"KZ-1048\",\"L1\",\"L10\",\"L2\",\"L3\",\"L4\",\"L5\",\"L6\",\"L7\",\"L8\",\"LATIN-9\",\"LATIN1\",\"LATIN10\",\"LATIN2\",\"LATIN3\",\"LATIN4\",\"LATIN5\",\"LATIN6\",\"LATIN7\",\"LATIN8\",\"MAC\",\"MACARABIC\",\"MACCENTRALEUROPE\",\"MACCROATIAN\",\"MACCYRILLIC\",\"MACGREEK\",\"MACHEBREW\",\"MACICELAND\",\"MACINTOSH\",\"MACROMAN\",\"MACROMANIA\",\"MACTHAI\",\"MACTURKISH\",\"MACUKRAINE\",\"MS-ANSI\",\"MS-ARAB\",\"MS-CYRL\",\"MS-EE\",\"MS-GREEK\",\"MS-HEBR\",\"MS-TURK\",\"MS_KANJI\",\"MS936\",\"MULELAO-1\",\"NEXTSTEP\",\"PT154\",\"PTCP154\",\"R8\",\"RK1048\",\"ROMAN8\",\"SHIFT-JIS\",\"SJIS\",\"STRK1048-2002\",\"TCVN\",\"TCVN-5712\",\"TCVN5712-1\",\"TCVN5712-1:1993\",\"TIS-620\",\"TIS620\",\"TIS620-0\",\"TIS620.2529-1\",\"TIS620.2533-0\",\"TIS620.2533-1\",\"UCS-2\",\"UCS-2-INTERNAL\",\"UCS-2-SWAPPED\",\"UCS-2BE\",\"UCS-2LE\",\"UCS-4\",\"UCS-4-INTERNAL\",\"UCS-4-SWAPPED\",\"UCS-4BE\",\"UCS-4LE\",\"UHC\",\"UNICODE-1-1\",\"UNICODE-1-1-UTF-7\",\"UNICODEBIG\",\"UNICODELITTLE\",\"US\",\"US-ASCII\",\"UTF-16\",\"UTF-16BE\",\"UTF-16LE\",\"UTF-32\",\"UTF-32BE\",\"UTF-32LE\",\"UTF-7\",\"UTF-8\",\"VISCII\",\"VISCII1.1-1\",\"WCHAR_T\",\"WINBALTRIM\",\"WINDOWS-1250\",\"WINDOWS-1251\",\"WINDOWS-1252\",\"WINDOWS-1253\",\"WINDOWS-1254\",\"WINDOWS-1255\",\"WINDOWS-1256\",\"WINDOWS-1257\",\"WINDOWS-1258\",\"WINDOWS-874\",\"WINDOWS-936\",\"X0201\",\"X0208\",\"X0212\"],\"type\":\"string\"},\"input\":{\"type\":\"object\",\"description\":\"The input location to get the ASSA file from\",\"properties\":{\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]}},\"required\":[\"characterEncoding\",\"id\",\"input\"]}},\"required\":[\"properties\"]}}}}},\"watermarking\":{\"type\":\"object\",\"properties\":{\"nexguardFileMarker\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"NexGuardFileMarker\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"license\":{\"description\":\"Use the base64 license string that Nagra provides you.\",\"type\":\"string\"},\"watermarkType\":{\"description\":\"The type of watermarking to be used: * `OTT` - A/B watermarking (for video streams only) * `DUPLICATED` - Stream duplication to match A/B video streams in CDN delivery (for audio streams only)\\n\",\"enum\":[\"OTT\",\"DUPLICATED\"],\"type\":\"string\"},\"payload\":{\"description\":\"Specify the payload ID that you want to be associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. For PreRelease Content (NGPR), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of th ID. Neither Nagra nor Bitmovin keep track of this for you.\",\"type\":\"integer\"},\"preset\":{\"description\":\"Enter one of the watermarking preset strings that Nagra provides you.\",\"type\":\"string\"},\"strength\":{\"description\":\"Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.\",\"enum\":[\"LIGHTEST\",\"LIGHTER\",\"DEFAULT\",\"STRONGER\",\"STRONGEST\"],\"type\":\"string\"}},\"required\":[\"license\"]}},\"required\":[\"properties\"]}}}}},\"decodingConfigurations\":{\"type\":\"object\",\"properties\":{\"watermarking\":{\"type\":\"object\",\"properties\":{\"audio\":{\"type\":\"object\",\"properties\":{\"nielsen\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DecodingConfigurationWatermarkingAudioNielsen\",\"properties\":{\"id\":{\"type\":\"object\",\"description\":\"ID of the Nielsen Audio Watermarking decoding-configuration\"},\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"distributorId\":{\"type\":\"object\",\"description\":\"The Distributor ID identifies the end-user of the transcoder, i.e. the final distributor of the media content. It is recommended to set this value to DNS domain name of your company or entity. The Distributor ID string should be less than or equal to 48 characters. If a longer value is provided it will be truncated at the 48th character.\"}},\"required\":[\"distributorId\",\"id\"]}},\"required\":[\"properties\"]}}}}}}}}},\"captions\":{\"type\":\"object\",\"properties\":{\"cea\":{\"type\":\"object\",\"properties\":{\"scc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SccCaption\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"input\":{\"type\":\"object\",\"description\":\"Input location of the SCC file\",\"properties\":{\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]},\"smpteTimecodeFlavor\":{\"description\":\"Flavor of SMPTE timecodes in the SCC file (drop-frame or non-drop)\",\"enum\":[\"AUTO\",\"NON_DROP_FRAME\",\"DROP_FRAME\"],\"type\":\"string\"}},\"required\":[\"input\"]}},\"required\":[\"properties\"]}}},\"srt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SrtToCea608708Caption\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"input\":{\"type\":\"object\",\"description\":\"Input location of the SRT file\",\"properties\":{\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]},\"ccChannel\":{\"description\":\"The channel number to embed the CEA subtitles in\",\"enum\":[\"CC1\",\"CC3\"],\"type\":\"string\"},\"characterEncoding\":{\"description\":\"Character encoding of the input SRT file\",\"enum\":[\"ANSI_X3.4-1968\",\"ANSI_X3.4-1986\",\"ARABIC\",\"ARMSCII-8\",\"ASCII\",\"ASMO-708\",\"BIG-5\",\"BIG-FIVE\",\"BIG5\",\"BIG5-HKSCS\",\"BIG5-HKSCS:1999\",\"BIG5-HKSCS:2001\",\"BIG5-HKSCS:2004\",\"BIG5-HKSCS:2008\",\"BIG5HKSCS\",\"BIGFIVE\",\"C99\",\"CHAR\",\"CHINESE\",\"CN\",\"CN-BIG5\",\"CN-GB\",\"CN-GB-ISOIR165\",\"CP1131\",\"CP1133\",\"CP1250\",\"CP1251\",\"CP1252\",\"CP1253\",\"CP1254\",\"CP1255\",\"CP1256\",\"CP1257\",\"CP1258\",\"CP1361\",\"CP154\",\"CP367\",\"CP819\",\"CP850\",\"CP862\",\"CP866\",\"CP874\",\"CP932\",\"CP936\",\"CP949\",\"CP950\",\"CSASCII\",\"CSBIG5\",\"CSEUCKR\",\"CSEUCPKDFMTJAPANESE\",\"CSEUCTW\",\"CSGB2312\",\"CSHALFWIDTHKATAKANA\",\"CSHPROMAN8\",\"CSIBM866\",\"CSISO14JISC6220RO\",\"CSISO159JISX02121990\",\"CSISO2022CN\",\"CSISO2022JP\",\"CSISO2022JP2\",\"CSISO2022KR\",\"CSISO57GB1988\",\"CSISO58GB231280\",\"CSISO87JISX0208\",\"CSISOLATIN1\",\"CSISOLATIN2\",\"CSISOLATIN3\",\"CSISOLATIN4\",\"CSISOLATIN5\",\"CSISOLATIN6\",\"CSISOLATINARABIC\",\"CSISOLATINCYRILLIC\",\"CSISOLATINGREEK\",\"CSISOLATINHEBREW\",\"CSKOI8R\",\"CSKSC56011987\",\"CSKZ1048\",\"CSMACINTOSH\",\"CSPC850MULTILINGUAL\",\"CSPC862LATINHEBREW\",\"CSPTCP154\",\"CSSHIFTJIS\",\"CSUCS4\",\"CSUNICODE\",\"CSUNICODE11\",\"CSUNICODE11UTF7\",\"CSVISCII\",\"CYRILLIC\",\"CYRILLIC-ASIAN\",\"ECMA-114\",\"ECMA-118\",\"ELOT_928\",\"EUC-CN\",\"EUC-JP\",\"EUC-KR\",\"EUC-TW\",\"EUCCN\",\"EUCJP\",\"EUCKR\",\"EUCTW\",\"EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE\",\"GB_1988-80\",\"GB_2312-80\",\"GB18030\",\"GB2312\",\"GBK\",\"GEORGIAN-ACADEMY\",\"GEORGIAN-PS\",\"GREEK\",\"GREEK8\",\"HEBREW\",\"HP-ROMAN8\",\"HZ\",\"HZ-GB-2312\",\"IBM-CP1133\",\"IBM367\",\"IBM819\",\"IBM850\",\"IBM862\",\"IBM866\",\"ISO-10646-UCS-2\",\"ISO-10646-UCS-4\",\"ISO-2022-CN\",\"ISO-2022-CN-EXT\",\"ISO-2022-JP\",\"ISO-2022-JP-1\",\"ISO-2022-JP-2\",\"ISO-2022-KR\",\"ISO-8859-1\",\"ISO-8859-10\",\"ISO-8859-11\",\"ISO-8859-13\",\"ISO-8859-14\",\"ISO-8859-15\",\"ISO-8859-16\",\"ISO-8859-2\",\"ISO-8859-3\",\"ISO-8859-4\",\"ISO-8859-5\",\"ISO-8859-6\",\"ISO-8859-7\",\"ISO-8859-8\",\"ISO-8859-9\",\"ISO-CELTIC\",\"ISO-IR-100\",\"ISO-IR-101\",\"ISO-IR-109\",\"ISO-IR-110\",\"ISO-IR-126\",\"ISO-IR-127\",\"ISO-IR-138\",\"ISO-IR-14\",\"ISO-IR-144\",\"ISO-IR-148\",\"ISO-IR-149\",\"ISO-IR-157\",\"ISO-IR-159\",\"ISO-IR-165\",\"ISO-IR-166\",\"ISO-IR-179\",\"ISO-IR-199\",\"ISO-IR-203\",\"ISO-IR-226\",\"ISO-IR-57\",\"ISO-IR-58\",\"ISO-IR-6\",\"ISO-IR-87\",\"ISO_646.IRV:1991\",\"ISO_8859-1:1987\",\"ISO_8859-10:1992\",\"ISO_8859-14:1998\",\"ISO_8859-15:1998\",\"ISO_8859-16:2001\",\"ISO_8859-2:1987\",\"ISO_8859-3:1988\",\"ISO_8859-4:1988\",\"ISO_8859-5:1988\",\"ISO_8859-6:1987\",\"ISO_8859-7:1987\",\"ISO_8859-7:2003\",\"ISO_8859-8:1988\",\"ISO_8859-9:1989\",\"ISO646-CN\",\"ISO646-JP\",\"ISO646-US\",\"ISO8859-1\",\"ISO8859-10\",\"ISO8859-11\",\"ISO8859-13\",\"ISO8859-14\",\"ISO8859-15\",\"ISO8859-16\",\"ISO8859-2\",\"ISO8859-3\",\"ISO8859-4\",\"ISO8859-5\",\"ISO8859-6\",\"ISO8859-7\",\"ISO8859-8\",\"ISO8859-9\",\"JAVA\",\"JIS_C6220-1969-RO\",\"JIS_C6226-1983\",\"JIS_X0201\",\"JIS_X0208\",\"JIS_X0208-1983\",\"JIS_X0208-1990\",\"JIS_X0212\",\"JIS_X0212-1990\",\"JIS_X0212.1990-0\",\"JIS0208\",\"JISX0201-1976\",\"JOHAB\",\"JP\",\"KOI8-R\",\"KOI8-RU\",\"KOI8-T\",\"KOI8-U\",\"KOREAN\",\"KS_C_5601-1987\",\"KS_C_5601-1989\",\"KSC_5601\",\"KZ-1048\",\"L1\",\"L10\",\"L2\",\"L3\",\"L4\",\"L5\",\"L6\",\"L7\",\"L8\",\"LATIN-9\",\"LATIN1\",\"LATIN10\",\"LATIN2\",\"LATIN3\",\"LATIN4\",\"LATIN5\",\"LATIN6\",\"LATIN7\",\"LATIN8\",\"MAC\",\"MACARABIC\",\"MACCENTRALEUROPE\",\"MACCROATIAN\",\"MACCYRILLIC\",\"MACGREEK\",\"MACHEBREW\",\"MACICELAND\",\"MACINTOSH\",\"MACROMAN\",\"MACROMANIA\",\"MACTHAI\",\"MACTURKISH\",\"MACUKRAINE\",\"MS-ANSI\",\"MS-ARAB\",\"MS-CYRL\",\"MS-EE\",\"MS-GREEK\",\"MS-HEBR\",\"MS-TURK\",\"MS_KANJI\",\"MS936\",\"MULELAO-1\",\"NEXTSTEP\",\"PT154\",\"PTCP154\",\"R8\",\"RK1048\",\"ROMAN8\",\"SHIFT-JIS\",\"SJIS\",\"STRK1048-2002\",\"TCVN\",\"TCVN-5712\",\"TCVN5712-1\",\"TCVN5712-1:1993\",\"TIS-620\",\"TIS620\",\"TIS620-0\",\"TIS620.2529-1\",\"TIS620.2533-0\",\"TIS620.2533-1\",\"UCS-2\",\"UCS-2-INTERNAL\",\"UCS-2-SWAPPED\",\"UCS-2BE\",\"UCS-2LE\",\"UCS-4\",\"UCS-4-INTERNAL\",\"UCS-4-SWAPPED\",\"UCS-4BE\",\"UCS-4LE\",\"UHC\",\"UNICODE-1-1\",\"UNICODE-1-1-UTF-7\",\"UNICODEBIG\",\"UNICODELITTLE\",\"US\",\"US-ASCII\",\"UTF-16\",\"UTF-16BE\",\"UTF-16LE\",\"UTF-32\",\"UTF-32BE\",\"UTF-32LE\",\"UTF-7\",\"UTF-8\",\"VISCII\",\"VISCII1.1-1\",\"WCHAR_T\",\"WINBALTRIM\",\"WINDOWS-1250\",\"WINDOWS-1251\",\"WINDOWS-1252\",\"WINDOWS-1253\",\"WINDOWS-1254\",\"WINDOWS-1255\",\"WINDOWS-1256\",\"WINDOWS-1257\",\"WINDOWS-1258\",\"WINDOWS-874\",\"WINDOWS-936\",\"X0201\",\"X0208\",\"X0212\"],\"type\":\"string\"}},\"required\":[\"ccChannel\",\"characterEncoding\",\"input\"]}},\"required\":[\"properties\"]}}}}}}},\"bifs\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Bif\",\"description\":\"Either height or width is required. It is also possible to set both properties.\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"height\":{\"description\":\"Height of one thumbnail\",\"type\":\"integer\"},\"width\":{\"description\":\"Width of one thumbnail. Roku recommends a width of 240 for SD and 320 for HD.\",\"type\":\"integer\"},\"distance\":{\"description\":\"Distance in seconds between a screenshot\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"filename\":{\"description\":\"Filename of the Bif image.\",\"type\":\"string\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"aspectMode\":{\"description\":\"Specifies the aspect mode that is used when both height and width are specified\\nOnly supported starting with encoder version `2.85.0`.\\n\",\"enum\":[\"PAD\",\"CROP\",\"STRETCH\"],\"type\":\"string\"}},\"required\":[\"distance\",\"filename\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"hdr\":{\"type\":\"object\",\"properties\":{\"dolbyVision\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyVisionMetadata\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"profile\":{\"description\":\"Dolby Vision Profile\",\"enum\":[\"DVHE_04\",\"DVHE_05\",\"DVHE_07\",\"HEV1_08\",\"AVC3_09\"],\"type\":\"string\"},\"metadataSource\":{\"description\":\"Dolby Vision Metadata Source\",\"enum\":[\"INPUT_STREAM\",\"EMBEDDED\"],\"type\":\"string\"},\"metadataInputStreamId\":{\"description\":\"ID of the Dolby Vision Metadata Ingest Input Stream which provides the XML Metadata file. Required if metadataSource is set to INPUT_STREAM.\",\"type\":\"string\"}},\"required\":[\"metadataSource\"]}},\"required\":[\"properties\"]}}}}},\"thumbnails\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Thumbnail\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"height\":{\"description\":\"Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.\\n\",\"type\":\"integer\"},\"width\":{\"description\":\"Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported\\n\",\"type\":\"integer\"},\"pattern\":{\"description\":\" Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s).\",\"type\":\"string\"},\"interval\":{\"description\":\"The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.\",\"format\":\"double\",\"type\":\"number\"},\"positions\":{\"description\":\"Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.\",\"items\":{\"type\":\"number\"},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"unit\":{\"description\":\"Unit of the values in the positions array.\",\"enum\":[\"SECONDS\",\"PERCENTS\"],\"type\":\"string\"},\"aspectMode\":{\"description\":\"Specifies the aspect mode that is used when both height and width are specified\\nOnly supported starting with encoder version `2.85.0`.\\n\",\"enum\":[\"PAD\",\"CROP\",\"STRETCH\"],\"type\":\"string\"}},\"required\":[\"outputs\",\"pattern\"]}},\"required\":[\"properties\"]}}},\"sprites\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Sprite\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"height\":{\"description\":\"Height of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required\\n\",\"type\":\"integer\"},\"width\":{\"description\":\"Width of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required\\n\",\"type\":\"integer\"},\"unit\":{\"enum\":[\"SECONDS\",\"PERCENTS\"],\"type\":\"string\"},\"distance\":{\"description\":\"Distance in the given unit between a screenshot\",\"format\":\"double\",\"type\":\"number\"},\"spriteName\":{\"description\":\"Name of the sprite image. File extension \\\".jpg\\\"/\\\".jpeg\\\" or \\\".png\\\" is required.\",\"type\":\"string\"},\"filename\":{\"description\":\"Filename of the sprite image. If not set, spriteName will be used, but without an extension.\",\"type\":\"string\"},\"vttName\":{\"description\":\"Filename of the vtt-file. The file-extension \\\".vtt\\\" is required.\",\"type\":\"string\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"imagesPerFile\":{\"description\":\"Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder '%number%' in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.\\n\",\"type\":\"integer\"},\"hTiles\":{\"description\":\"Number of rows of images per file.\\n\\nHas to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set.\\n\\nIt is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites.\\n\\nOnly supported starting with encoder version `2.76.0`.\\n\",\"minimum\":1,\"type\":\"integer\"},\"vTiles\":{\"description\":\"Number of columns of images per file.\\n\\nHas to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set.\\n\\nIt is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites.\\n\\nOnly supported starting with encoder version `2.76.0`.\\n\",\"minimum\":1,\"type\":\"integer\"},\"jpegConfig\":{\"type\":\"object\",\"description\":\"Additional configuration for JPEG sprite generation.\\n\\nIf this property is set the extension of the file must be '.jpg.' or '.jpeg'\\n\\nOnly supported starting with encoder version `2.76.0`\\n\",\"properties\":{\"quality\":{\"description\":\"Quality of the JPEG file in percent. Allowed values 20 - 100\",\"minimum\":20,\"maximum\":100,\"type\":\"integer\"}},\"required\":[\"quality\"]},\"creationMode\":{\"description\":\"The creation mode for the thumbnails in the Sprite.\\n\\nTwo possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period.\\n\\nWhen using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video.\\nWhen using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video.\\n\\nIt is recommended to use 'INTERVAL_START' when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video.\\n\\nOnly supported starting with encoder version `2.76.0`.\\n\",\"enum\":[\"INTERVAL_END\",\"INTERVAL_START\"],\"type\":\"string\"},\"aspectMode\":{\"description\":\"Specifies the aspect mode that is used when both height and width are specified\\nOnly supported starting with encoder version `2.85.0`.\\n\",\"enum\":[\"PAD\",\"CROP\",\"STRETCH\"],\"type\":\"string\"}},\"required\":[\"spriteName\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"inputStreams\":{\"type\":\"object\",\"properties\":{\"audioMix\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AudioMixInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"channelLayout\":{\"description\":\"Channel layout of the audio mix input stream\",\"enum\":[\"NONE\",\"MONO\",\"STEREO\",\"SURROUND\",\"QUAD\",\"HEXAGONAL\",\"OCTAGONAL\",\"STEREO_DOWNMIX\",\"2.1\",\"2.2\",\"3.1\",\"4.0\",\"4.1\",\"5.0\",\"5.1\",\"5.0_BACK\",\"5.1_BACK\",\"6.0\",\"6.0_FRONT\",\"6.1\",\"6.1_FRONT\",\"6.1_BACK\",\"7.0\",\"7.0_FRONT\",\"7.1\",\"7.1_WIDE\",\"7.1_WIDE_BACK\"],\"type\":\"string\"},\"audioMixChannels\":{\"items\":{\"type\":\"object\",\"title\":\"AudioMixInputStreamChannel\",\"properties\":{\"inputStreamId\":{\"description\":\"The id of the input stream that should be used for mixing.\",\"type\":\"string\"},\"outputChannelType\":{\"enum\":[\"CHANNEL_NUMBER\",\"FRONT_LEFT\",\"FRONT_RIGHT\",\"CENTER\",\"LOW_FREQUENCY\",\"BACK_LEFT\",\"BACK_RIGHT\",\"SURROUND_LEFT\",\"SURROUND_RIGHT\"],\"type\":\"string\"},\"outputChannelNumber\":{\"description\":\"Number of this output channel. If type is 'CHANNEL_NUMBER', this must be set.\",\"type\":\"integer\"},\"sourceChannels\":{\"description\":\"List of source channels to be mixed\",\"items\":{\"type\":\"object\",\"title\":\"AudioMixInputStreamSourceChannel\",\"properties\":{\"gain\":{\"description\":\"Gain for this source channel. Default is 1.0.\",\"format\":\"double\",\"type\":\"number\"},\"type\":{\"enum\":[\"CHANNEL_NUMBER\",\"FRONT_LEFT\",\"FRONT_RIGHT\",\"CENTER\",\"LOW_FREQUENCY\",\"BACK_LEFT\",\"BACK_RIGHT\",\"SURROUND_LEFT\",\"SURROUND_RIGHT\"],\"type\":\"string\"},\"channelNumber\":{\"description\":\"Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.\",\"type\":\"integer\"}},\"required\":[\"type\"]},\"type\":\"array\"}},\"required\":[\"outputChannelType\"]},\"type\":\"array\"}}}},\"required\":[\"properties\"]}}},\"ingest\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"IngestInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"ID of an Input resource defining the input storage\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to an input media file\",\"type\":\"string\"},\"selectionMode\":{\"description\":\"Specifies the strategy for selecting a stream from the input file\",\"enum\":[\"AUTO\",\"POSITION_ABSOLUTE\",\"VIDEO_RELATIVE\",\"AUDIO_RELATIVE\",\"SUBTITLE_RELATIVE\"],\"type\":\"string\"},\"position\":{\"description\":\"Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.\",\"minimum\":0,\"type\":\"integer\"}},\"required\":[\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}},\"sidecar\":{\"type\":\"object\",\"properties\":{\"dolbyVisionMetadataIngest\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyVisionMetadataIngestInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to Dolby Vision Metadata file\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}}}},\"concatenation\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ConcatenationInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"concatenation\":{\"description\":\"Concatenation configuration for the output of this stream\",\"items\":{\"type\":\"object\",\"title\":\"ConcatenationInputConfiguration\",\"properties\":{\"inputStreamId\":{\"description\":\"The ID of the input stream to be concatenated. This can be an ingest input stream or a trimming input stream\",\"type\":\"string\"},\"isMain\":{\"type\":\"boolean\",\"description\":\"Exactly one input stream of a concatenation must have this set to true, which will be used as reference for scaling, aspect ratio, FPS, sample rate, etc. \"},\"position\":{\"description\":\"A unique integer value that determines concatenation order\",\"minimum\":0,\"type\":\"integer\"},\"paddingBefore\":{\"type\":\"object\",\"description\":\"Inserts a padding sequence (black frames and/or silent audio) before the input stream.\",\"properties\":{\"duration\":{\"description\":\"Duration of the padding sequence, given in the unit specified by the `unit` property. The maximum duration is 300 frames or 10 seconds. If the unit is `FRAMES`, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). `FRAMES` is not allowed if the encoding does not contain a video output stream.\\n\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"unit\":{\"description\":\"The unit of the `duration` property\",\"enum\":[\"SECONDS\",\"FRAMES\"],\"type\":\"string\"}},\"required\":[\"duration\"]},\"paddingAfter\":{\"type\":\"object\",\"description\":\"Inserts a padding sequence (black frames and/or silent audio) after the input stream.\",\"properties\":{\"duration\":{\"description\":\"Duration of the padding sequence, given in the unit specified by the `unit` property. The maximum duration is 300 frames or 10 seconds. If the unit is `FRAMES`, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). `FRAMES` is not allowed if the encoding does not contain a video output stream.\\n\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"unit\":{\"description\":\"The unit of the `duration` property\",\"enum\":[\"SECONDS\",\"FRAMES\"],\"type\":\"string\"}},\"required\":[\"duration\"]},\"aspectMode\":{\"description\":\"Specifies the aspect mode that is used when adapting to the main input stream's aspect ratio\",\"enum\":[\"PAD\",\"CROP\",\"STRETCH\"],\"type\":\"string\"}},\"required\":[\"inputStreamId\",\"position\"]},\"type\":\"array\"}}}},\"required\":[\"properties\"]}}},\"file\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FileInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to file\",\"type\":\"string\"},\"fileType\":{\"enum\":[\"TTML\",\"WEBVTT\",\"SRT\"],\"type\":\"string\"}},\"required\":[\"fileType\",\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}},\"trimming\":{\"type\":\"object\",\"properties\":{\"timeBased\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"TimeBasedTrimmingInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputStreamId\":{\"description\":\"The id of the ingest input stream that should be trimmed\",\"type\":\"string\"},\"offset\":{\"description\":\"Defines the offset in seconds at which the encoding should start, beginning at 0. The frame indicated by this value will be included in the encoding\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"duration\":{\"description\":\"Defines how many seconds of the input will be encoded. Not defining or setting it to null indicates that the remaining input (considering offset) will be encoded.\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"}}}},\"required\":[\"properties\"]}}},\"timecodeTrack\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"TimecodeTrackTrimmingInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputStreamId\":{\"description\":\"The id of the ingest input stream that should be trimmed\",\"type\":\"string\"},\"startTimeCode\":{\"description\":\"Defines the timecode, in SMPTE-12M format, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding\",\"type\":\"string\"},\"endTimeCode\":{\"description\":\"Defines the timecode, in SMPTE-12M format, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding\",\"type\":\"string\"}},\"required\":[\"endTimeCode\",\"inputStreamId\",\"startTimeCode\"]}},\"required\":[\"properties\"]}}},\"h264PictureTiming\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"H264PictureTimingTrimmingInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputStreamId\":{\"description\":\"The id of the ingest input stream that should be trimmed\",\"type\":\"string\"},\"startPicTiming\":{\"description\":\"Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding\",\"type\":\"string\"},\"endPicTiming\":{\"description\":\"Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}}},\"subtitles\":{\"type\":\"object\",\"properties\":{\"dvbSubtitle\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DvbSubtitleInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"ID of an Input resource defining the input storage\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to an input media file\",\"type\":\"string\"},\"selectionMode\":{\"description\":\"Specifies the strategy for selecting a stream from the input file. Supported values for VOD encodings: AUTO, POSITION_ABSOLUTE, SUBTITLE_RELATIVE. Supported values for LIVE encodings: POSITION_ABSOLUTE\",\"enum\":[\"AUTO\",\"POSITION_ABSOLUTE\",\"VIDEO_RELATIVE\",\"AUDIO_RELATIVE\",\"SUBTITLE_RELATIVE\"],\"type\":\"string\"},\"position\":{\"description\":\"Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.\",\"minimum\":0,\"type\":\"integer\"}}}},\"required\":[\"properties\"]}}}}},\"captions\":{\"type\":\"object\",\"properties\":{\"cea608\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Cea608CaptionInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of the Input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"},\"channel\":{\"description\":\"The channel number of the subtitle on the respective stream position\",\"enum\":[\"CC1\",\"CC3\"],\"type\":\"string\"}},\"required\":[\"channel\",\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}},\"cea708\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Cea708CaptionInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of the Input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"},\"channel\":{\"description\":\"The channel number of the subtitle on the respective stream position. Must not be smaller than 1\",\"type\":\"integer\"}},\"required\":[\"channel\",\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}}}},\"dolbyAtmos\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyAtmosIngestInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to the Dolby Atmos input file\",\"type\":\"string\"},\"inputFormat\":{\"description\":\"Input file format of the Dolby Atmos input file. Set it to DAMF if the given input file is a Dolby Atmos Master File (.atmos). Set it to ADM if the given input file is an Audio Definition Model Broadcast Wave Format file (.wav)\",\"enum\":[\"DAMF\",\"ADM\"],\"type\":\"string\"}},\"required\":[\"inputFormat\",\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}},\"dolbyVision\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DolbyVisionInputStream\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"videoInputPath\":{\"description\":\"Path to Dolby Vision input video file.\",\"type\":\"string\"},\"metadataInputPath\":{\"description\":\"Path to Dolby Vision Metadata file. This field is required when the metadata is not embedded in the video input file.\",\"type\":\"string\"}},\"required\":[\"inputId\",\"videoInputPath\"]}},\"required\":[\"properties\"]}}}}},\"live\":{\"type\":\"object\",\"properties\":{\"insertableContent\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"InsertableContent\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputs\":{\"description\":\"Either a list of movie files to be inserted in the live stream or a single image file. The movie files must have a video stream at stream position 0, which matches the codec, resolution and framerate of the livestream. The number of audio streams must also be the same and they have to match the sample format, number of channels and sample rate of the audio streams of the livestream. Supported image formats are: `.Y.U.V`, `Alias PIX`, `animated GIF`, `APNG`, `BMP`, `DPX`, `FITS`, `JPEG`, `JPEG 2000`, `JPEG-LS`, `PAM`, `PBM`, `PCX`, `PGM`, `PGMYUV`, `PNG`, `PPM`, `SGI`, `Sun Rasterfile`, `TIFF`, `Truevision Targa`, `WebP`, `XBM`, `XFace`, `XPM`, `XWD`\",\"items\":{\"type\":\"object\",\"title\":\"InsertableContentInput\",\"properties\":{\"inputId\":{\"description\":\"Id of the input hosting the video file\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to the file on the input\",\"type\":\"string\"},\"description\":{\"description\":\"Description of this input\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Status of the insertable content.\",\"enum\":[\"CREATED\",\"DOWNLOADING\",\"READY\",\"ERROR\"],\"type\":\"string\"}}},\"schedule\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ScheduledInsertableContent\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"contentId\":{\"description\":\"Id of the insertable content to play instead of the live stream\",\"type\":\"string\"},\"runAt\":{\"type\":\"object\",\"description\":\"Time to play the content in UTC: YYYY-MM-DDThh:mm:ssZ, if this property is not set the content will be played as soon as possible.\"},\"durationInSeconds\":{\"description\":\"Duration for how long to play the content. Cut off if shorter, loop if longer than actual duration. This property is required if the insertable content is an image.\",\"format\":\"double\",\"type\":\"number\"},\"status\":{\"description\":\"Status of the scheduled insertable content.\",\"enum\":[\"CREATED\",\"SCHEDULED\",\"TO_BE_DESCHEDULED\",\"DESCHEDULED\",\"ERROR\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"scte35Cue\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Scte35Cue\",\"properties\":{\"cueDuration\":{\"description\":\"Cue out duration in seconds.\",\"format\":\"double\",\"type\":\"number\"},\"manifestIds\":{\"description\":\"The ids of the manifests to update. If this property is not set, all the manifests tied to the encoding are updated.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"cueDuration\"]}},\"required\":[\"properties\"]}}},\"resetLiveManifestTimeshift\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ResetLiveManifestTimeShift\",\"properties\":{\"residualPeriodInSeconds\":{\"description\":\"Determines how many seconds will be left in the manifest after segments are removed.\\nIf this is not set, all but one segment will be removed.\\n\",\"format\":\"double\",\"type\":\"number\"},\"offsetInSeconds\":{\"description\":\"Offset in seconds from the start of the live event, defining the point from which all segments within that duration will be removed from the given manifests.\\nE.g.: The segment length is 2 seconds and a timeshift of 120 seconds (2 minutes) is configured. \\nThe manifest contains 60 segments with the last segment number being 80 (`segment_80.ts`). \\nThis means the manifest contains `segment_20.ts` to `segment_80.ts` (timeshift of 2 minutes equals 60 segments in manifest)\\nIf you set `offsetInSeconds` to `120`, all segments below segment number 60 (`segment_60.ts`) will be removed. (`targetSegmentNumber = offsetInSeconds / segmentLength`)\\nThe manifests will then contain `segment_60.ts` to `segment_80.ts`\\n*Note:* Only `offsetInSeconds` or `residualPeriodInSeconds` can be set.\\n\",\"format\":\"double\",\"type\":\"number\"},\"manifestIds\":{\"description\":\"The ids of the manifests to update. If this property is not set, all manifests tied to the encoding are updated.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"shiftProgressiveMuxingStartPosition\":{\"type\":\"boolean\",\"description\":\"If set to true, the Progressive muxing start position will be shifted to the start of the first remaining segment after the removal. NOTE: This only works for Progressive MP4 muxings.\"}}}},\"required\":[\"properties\"]}}},\"start\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StartLiveEncodingRequest\",\"properties\":{\"streamKey\":{\"description\":\"Key for the stream. (a-zA-Z, 3-20 characters)\",\"type\":\"string\"},\"hlsManifests\":{\"description\":\"HLS manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"LiveHlsManifest\",\"properties\":{\"manifestId\":{\"description\":\"HLS manifest id\",\"type\":\"string\"},\"timeshift\":{\"description\":\"Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.\\n\",\"format\":\"double\",\"type\":\"number\"},\"liveEdgeOffset\":{\"description\":\"Live edge offset in seconds\",\"format\":\"double\",\"type\":\"number\"},\"insertProgramDateTime\":{\"type\":\"boolean\",\"description\":\"Specifies if the EXT-X-PROGRAM-DATETIME tag will be included\"},\"programDateTimeSettings\":{\"type\":\"object\",\"description\":\"Configuration for the EXT-X-PROGRAM-DATETIME tag\",\"properties\":{\"programDateTimeSource\":{\"title\":\"ProgramDateTimeSource\",\"description\":\"Source for the EXT-X-PROGRAM-DATETIME tag\",\"enum\":[\"SYSTEM_CLOCK\",\"EMBEDDED\"],\"type\":\"string\"},\"programDateTimePlacement\":{\"type\":\"object\",\"title\":\"ProgramDateTimePlacement\",\"properties\":{\"programDateTimePlacementMode\":{\"title\":\"ProgramDateTimePlacementMode\",\"description\":\"Placement mode of the ProgramDateTime tag.\",\"enum\":[\"ONCE_PER_PLAYLIST\",\"SEGMENTS_INTERVAL\",\"SECONDS_INTERVAL\"],\"type\":\"string\"},\"interval\":{\"description\":\"Interval for placing ProgramDateTime. Only required for SEGMENTS_INTERVAL or SECONDS_INTERVAL.\",\"type\":\"integer\"}}}}},\"adMarkerSettings\":{\"type\":\"object\",\"description\":\"Configuration for tags related to ad markers (e.g. Scte35)\",\"properties\":{\"enabledMarkerTypes\":{\"description\":\"Ad marker types that will be inserted. More than one type is possible.\\n\\n- EXT_X_CUE_OUT_IN: Ad markers will be inserted using `#EXT-X-CUE-OUT` and `#EXT-X-CUE-IN` tags\\n- EXT_OATCLS_SCTE35: Ad markers will be inserted using `#EXT-OATCLS-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\\n- EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using `#EXT-X-SPLICEPOINT-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\\n- EXT_X_DATERANGE: Ad markers will be inserted using `#EXT-X-DATERANGE` tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger.\\n- EXT_X_SCTE35: Ad markers will be inserted using `#EXT-X-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\\n\",\"items\":{\"type\":\"string\",\"title\":\"HlsManifestAdMarkerType\"},\"type\":\"array\"}}}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"dashManifests\":{\"description\":\"DASH manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"LiveDashManifest\",\"properties\":{\"manifestId\":{\"description\":\"Dash manifest id\",\"type\":\"string\"},\"timeshift\":{\"description\":\"Timeshift in seconds\",\"format\":\"double\",\"type\":\"number\"},\"liveEdgeOffset\":{\"description\":\"Live edge offset in seconds\",\"format\":\"double\",\"type\":\"number\"},\"suggestedPresentationDelay\":{\"description\":\"The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.\",\"format\":\"double\",\"type\":\"number\"},\"minimumUpdatePeriod\":{\"description\":\"The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.\",\"format\":\"double\",\"type\":\"number\"},\"availabilityStartTimeMode\":{\"description\":\"The mode to trigger the availabilityStartTime initialization.\",\"enum\":[\"ON_FIRST_SEGMENT\",\"ON_STREAM_INGEST\"],\"type\":\"string\"},\"adMarkerSettings\":{\"type\":\"object\",\"properties\":{\"periodOption\":{\"enum\":[\"SINGLE_PERIOD\",\"MULTI_PERIOD\"],\"type\":\"string\"},\"eventStreamSignalling\":{\"enum\":[\"XML\",\"XML_BIN\"],\"type\":\"string\"}}}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"liveEncodingMode\":{\"description\":\"The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"reuploadSettings\":{\"type\":\"object\",\"description\":\"Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage\",\"properties\":{\"dashManifestInterval\":{\"description\":\"Interval in seconds to reupload the DASH manifest. Valid values are either `null` to never reupload the dash manifest or at least `30`.\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"hlsManifestInterval\":{\"description\":\"Interval in seconds to reupload the HLS master file. Valid values are either `0` to never reupload the hls manifest or at least `30`. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.\",\"format\":\"double\",\"type\":\"number\"},\"muxingInitFileInterval\":{\"description\":\"The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either `null` to never reupload the init file for segmented muxings or at least `30`.\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"}}},\"manifestGenerator\":{\"description\":\"Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\\n\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"autoRestartConfiguration\":{\"type\":\"object\",\"description\":\"Configuration for auto restarting the live encoding\",\"properties\":{\"segmentsWrittenTimeout\":{\"description\":\"If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"bytesWrittenTimeout\":{\"description\":\"If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"framesWrittenTimeout\":{\"description\":\"If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"hlsManifestsUpdateTimeout\":{\"description\":\"If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"dashManifestsUpdateTimeout\":{\"description\":\"If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"scheduleExpression\":{\"description\":\"Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)\",\"type\":\"string\"},\"restartOnEncoderError\":{\"type\":\"boolean\",\"description\":\"Defines if the encoding should be restarted in case of an error during encoding.\"}}},\"autoShutdownConfiguration\":{\"type\":\"object\",\"description\":\"Configuration for auto shutdown of the live encoding\",\"properties\":{\"bytesReadTimeoutSeconds\":{\"description\":\"Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.\",\"minimum\":30,\"type\":\"integer\"},\"streamTimeoutMinutes\":{\"description\":\"Automatically shutdown the live stream after a predefined runtime in minutes.\",\"minimum\":5,\"type\":\"integer\"},\"waitingForFirstConnectTimeoutMinutes\":{\"description\":\"Automatically shutdown the live stream if input is never connected for a predefined number of minutes.\",\"minimum\":5,\"type\":\"integer\"}}},\"esamSettings\":{\"type\":\"object\",\"description\":\"Configuration for Event Signaling and Management (ESAM) system, \\nallowing the encoder to communicate with an ESAM server for signal processing and dynamic ad insertion update.'\\n\",\"properties\":{\"poisEndpoint\":{\"description\":\"The URL of the Placement Opportunity Information System (POIS) signal processing endpoint. \\nThe encoder transmits SignalProcessingEvents to this endpoint whenever SCTE-35 messages are detected.\\n\",\"type\":\"string\"},\"acquisitionPointIdentity\":{\"description\":\"A unique identifier representing the `Acquisition Point Identity` defined in the ESAM specification.\\n\",\"type\":\"string\"},\"zoneIdentity\":{\"description\":\"Specifies the `Zone Identity` defined in the ESAM specification.\\n\",\"type\":\"string\"},\"adAvailOffset\":{\"description\":\"Defines an offset (in milliseconds) to be applied to the stream event timestamp. \\nThis offset adjusts the `StreamTime` values (such as PTS) associated with ad opportunities \\nor content insertions. It is used to fine-tune timing for embedded SCTE-104/35 messages \\nto ensure precise frame alignment in the transport stream.\\n\",\"minimum\":0,\"type\":\"integer\"},\"poisEndpointCredentials\":{\"type\":\"object\",\"description\":\"If authentication is required to access the POIS endpoint, credentials must be provided.\\n\",\"properties\":{\"username\":{\"description\":\"The username required to authenticate with the POIS server.\\n\",\"type\":\"string\"},\"password\":{\"description\":\"The password required for authentication with the POIS server.\\n\",\"type\":\"string\"}}}}},\"cacheControlSettings\":{\"type\":\"object\",\"description\":\"Configuration of cache control policies for media segments, HLS, and DASH manifests. \\nYou can set caching for the HLS multivariant playlist, HLS media playlist, DASH timeline manifest, \\nDASH template manifest, initialization segment, and media segment.\\n\",\"properties\":{\"hls\":{\"type\":\"object\",\"description\":\"Cache control settings for HLS manifest.\",\"properties\":{\"multiVariantPlaylist\":{\"type\":\"object\",\"description\":\"Cache control settings for HLS Multivariant playlist.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}},\"variantPlaylist\":{\"type\":\"object\",\"description\":\"Cache control settings for HLS Media playlist.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}}}},\"dash\":{\"type\":\"object\",\"description\":\"Cache control settings for DASH manifest.\",\"properties\":{\"timelineManifest\":{\"type\":\"object\",\"description\":\"Cache control settings for DASH Timeline manifest.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}},\"templateManifest\":{\"type\":\"object\",\"description\":\"Cache control settings for DASH Template manifest.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}}}},\"segments\":{\"type\":\"object\",\"description\":\"Cache control settings for segments.\",\"properties\":{\"initSegment\":{\"type\":\"object\",\"description\":\"Cache control settings for init segment.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}},\"mediaSegment\":{\"type\":\"object\",\"description\":\"Cache control settings for media segment.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}}}}}}},\"required\":[\"streamKey\"]}},\"required\":[\"properties\"]},\"hd\":{\"type\":\"object\",\"properties\":{\"start\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StartLiveChannelEncodingRequest\",\"properties\":{\"streamKey\":{\"description\":\"Key for the stream. (a-zA-Z, 3-20 characters)\",\"type\":\"string\"},\"hlsManifests\":{\"description\":\"HLS manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"LiveHlsManifest\",\"properties\":{\"manifestId\":{\"description\":\"HLS manifest id\",\"type\":\"string\"},\"timeshift\":{\"description\":\"Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.\\n\",\"format\":\"double\",\"type\":\"number\"},\"liveEdgeOffset\":{\"description\":\"Live edge offset in seconds\",\"format\":\"double\",\"type\":\"number\"},\"insertProgramDateTime\":{\"type\":\"boolean\",\"description\":\"Specifies if the EXT-X-PROGRAM-DATETIME tag will be included\"},\"programDateTimeSettings\":{\"type\":\"object\",\"description\":\"Configuration for the EXT-X-PROGRAM-DATETIME tag\",\"properties\":{\"programDateTimeSource\":{\"title\":\"ProgramDateTimeSource\",\"description\":\"Source for the EXT-X-PROGRAM-DATETIME tag\",\"enum\":[\"SYSTEM_CLOCK\",\"EMBEDDED\"],\"type\":\"string\"},\"programDateTimePlacement\":{\"type\":\"object\",\"title\":\"ProgramDateTimePlacement\",\"properties\":{\"programDateTimePlacementMode\":{\"title\":\"ProgramDateTimePlacementMode\",\"description\":\"Placement mode of the ProgramDateTime tag.\",\"enum\":[\"ONCE_PER_PLAYLIST\",\"SEGMENTS_INTERVAL\",\"SECONDS_INTERVAL\"],\"type\":\"string\"},\"interval\":{\"description\":\"Interval for placing ProgramDateTime. Only required for SEGMENTS_INTERVAL or SECONDS_INTERVAL.\",\"type\":\"integer\"}}}}},\"adMarkerSettings\":{\"type\":\"object\",\"description\":\"Configuration for tags related to ad markers (e.g. Scte35)\",\"properties\":{\"enabledMarkerTypes\":{\"description\":\"Ad marker types that will be inserted. More than one type is possible.\\n\\n- EXT_X_CUE_OUT_IN: Ad markers will be inserted using `#EXT-X-CUE-OUT` and `#EXT-X-CUE-IN` tags\\n- EXT_OATCLS_SCTE35: Ad markers will be inserted using `#EXT-OATCLS-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\\n- EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using `#EXT-X-SPLICEPOINT-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\\n- EXT_X_DATERANGE: Ad markers will be inserted using `#EXT-X-DATERANGE` tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger.\\n- EXT_X_SCTE35: Ad markers will be inserted using `#EXT-X-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\\n\",\"items\":{\"type\":\"string\",\"title\":\"HlsManifestAdMarkerType\"},\"type\":\"array\"}}}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"dashManifests\":{\"description\":\"DASH manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"LiveDashManifest\",\"properties\":{\"manifestId\":{\"description\":\"Dash manifest id\",\"type\":\"string\"},\"timeshift\":{\"description\":\"Timeshift in seconds\",\"format\":\"double\",\"type\":\"number\"},\"liveEdgeOffset\":{\"description\":\"Live edge offset in seconds\",\"format\":\"double\",\"type\":\"number\"},\"suggestedPresentationDelay\":{\"description\":\"The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.\",\"format\":\"double\",\"type\":\"number\"},\"minimumUpdatePeriod\":{\"description\":\"The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.\",\"format\":\"double\",\"type\":\"number\"},\"availabilityStartTimeMode\":{\"description\":\"The mode to trigger the availabilityStartTime initialization.\",\"enum\":[\"ON_FIRST_SEGMENT\",\"ON_STREAM_INGEST\"],\"type\":\"string\"},\"adMarkerSettings\":{\"type\":\"object\",\"properties\":{\"periodOption\":{\"enum\":[\"SINGLE_PERIOD\",\"MULTI_PERIOD\"],\"type\":\"string\"},\"eventStreamSignalling\":{\"enum\":[\"XML\",\"XML_BIN\"],\"type\":\"string\"}}}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"liveEncodingMode\":{\"description\":\"The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"reuploadSettings\":{\"type\":\"object\",\"description\":\"Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage\",\"properties\":{\"dashManifestInterval\":{\"description\":\"Interval in seconds to reupload the DASH manifest. Valid values are either `null` to never reupload the dash manifest or at least `30`.\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"hlsManifestInterval\":{\"description\":\"Interval in seconds to reupload the HLS master file. Valid values are either `0` to never reupload the hls manifest or at least `30`. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.\",\"format\":\"double\",\"type\":\"number\"},\"muxingInitFileInterval\":{\"description\":\"The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either `null` to never reupload the init file for segmented muxings or at least `30`.\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"}}},\"manifestGenerator\":{\"description\":\"Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\\n\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"autoRestartConfiguration\":{\"type\":\"object\",\"description\":\"Configuration for auto restarting the live encoding\",\"properties\":{\"segmentsWrittenTimeout\":{\"description\":\"If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"bytesWrittenTimeout\":{\"description\":\"If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"framesWrittenTimeout\":{\"description\":\"If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"hlsManifestsUpdateTimeout\":{\"description\":\"If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"dashManifestsUpdateTimeout\":{\"description\":\"If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0\",\"minimum\":30,\"format\":\"double\",\"type\":\"number\"},\"scheduleExpression\":{\"description\":\"Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)\",\"type\":\"string\"},\"restartOnEncoderError\":{\"type\":\"boolean\",\"description\":\"Defines if the encoding should be restarted in case of an error during encoding.\"}}},\"autoShutdownConfiguration\":{\"type\":\"object\",\"description\":\"Configuration for auto shutdown of the live encoding\",\"properties\":{\"bytesReadTimeoutSeconds\":{\"description\":\"Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.\",\"minimum\":30,\"type\":\"integer\"},\"streamTimeoutMinutes\":{\"description\":\"Automatically shutdown the live stream after a predefined runtime in minutes.\",\"minimum\":5,\"type\":\"integer\"},\"waitingForFirstConnectTimeoutMinutes\":{\"description\":\"Automatically shutdown the live stream if input is never connected for a predefined number of minutes.\",\"minimum\":5,\"type\":\"integer\"}}},\"esamSettings\":{\"type\":\"object\",\"description\":\"Configuration for Event Signaling and Management (ESAM) system, \\nallowing the encoder to communicate with an ESAM server for signal processing and dynamic ad insertion update.'\\n\",\"properties\":{\"poisEndpoint\":{\"description\":\"The URL of the Placement Opportunity Information System (POIS) signal processing endpoint. \\nThe encoder transmits SignalProcessingEvents to this endpoint whenever SCTE-35 messages are detected.\\n\",\"type\":\"string\"},\"acquisitionPointIdentity\":{\"description\":\"A unique identifier representing the `Acquisition Point Identity` defined in the ESAM specification.\\n\",\"type\":\"string\"},\"zoneIdentity\":{\"description\":\"Specifies the `Zone Identity` defined in the ESAM specification.\\n\",\"type\":\"string\"},\"adAvailOffset\":{\"description\":\"Defines an offset (in milliseconds) to be applied to the stream event timestamp. \\nThis offset adjusts the `StreamTime` values (such as PTS) associated with ad opportunities \\nor content insertions. It is used to fine-tune timing for embedded SCTE-104/35 messages \\nto ensure precise frame alignment in the transport stream.\\n\",\"minimum\":0,\"type\":\"integer\"},\"poisEndpointCredentials\":{\"type\":\"object\",\"description\":\"If authentication is required to access the POIS endpoint, credentials must be provided.\\n\",\"properties\":{\"username\":{\"description\":\"The username required to authenticate with the POIS server.\\n\",\"type\":\"string\"},\"password\":{\"description\":\"The password required for authentication with the POIS server.\\n\",\"type\":\"string\"}}}}},\"cacheControlSettings\":{\"type\":\"object\",\"description\":\"Configuration of cache control policies for media segments, HLS, and DASH manifests. \\nYou can set caching for the HLS multivariant playlist, HLS media playlist, DASH timeline manifest, \\nDASH template manifest, initialization segment, and media segment.\\n\",\"properties\":{\"hls\":{\"type\":\"object\",\"description\":\"Cache control settings for HLS manifest.\",\"properties\":{\"multiVariantPlaylist\":{\"type\":\"object\",\"description\":\"Cache control settings for HLS Multivariant playlist.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}},\"variantPlaylist\":{\"type\":\"object\",\"description\":\"Cache control settings for HLS Media playlist.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}}}},\"dash\":{\"type\":\"object\",\"description\":\"Cache control settings for DASH manifest.\",\"properties\":{\"timelineManifest\":{\"type\":\"object\",\"description\":\"Cache control settings for DASH Timeline manifest.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}},\"templateManifest\":{\"type\":\"object\",\"description\":\"Cache control settings for DASH Template manifest.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}}}},\"segments\":{\"type\":\"object\",\"description\":\"Cache control settings for segments.\",\"properties\":{\"initSegment\":{\"type\":\"object\",\"description\":\"Cache control settings for init segment.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}},\"mediaSegment\":{\"type\":\"object\",\"description\":\"Cache control settings for media segment.\",\"properties\":{\"cacheControl\":{\"description\":\"Cache control for storing data on CDN. Example \\\"public, max-age=0, no-cache\\\". Cache control is supported on S3, GCS and Azure output storage providers.\",\"type\":\"string\"}}}}}}}},\"required\":[\"streamKey\"]}},\"required\":[\"properties\"]}}}}}}},\"muxings\":{\"type\":\"object\",\"properties\":{\"fmp4\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Fmp4Muxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the fragments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy\",\"type\":\"string\"},\"segmentNamingTemplate\":{\"description\":\"Segment naming policy containing one or both of the following placeholders:\\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\\n Intended to avoid re-use of segment names after restarting a live encoding.\\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\\n\\nIf segmentNamingTemplate is set, segmentNaming must not be set.\\n\",\"type\":\"string\"},\"initSegmentName\":{\"description\":\"Init segment name\",\"type\":\"string\"},\"initSegmentNameTemplate\":{\"description\":\"Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.\",\"type\":\"string\"},\"writeDurationPerSample\":{\"type\":\"boolean\",\"description\":\"Writes the duration per sample into the sample entry in the Track Fragment Run Box. This could help to fix playback issues on legacy players. Enabling this flag increases the muxing overhead by 4 bytes per sample/frame.\"},\"signalScte35AsEmsg\":{\"type\":\"boolean\",\"description\":\"Insert scte35 triggers as emsg boxes into the fMP4 segments.\"},\"ptsAlignMode\":{\"description\":\"Alignment mode for composition / presentation timestamps (CTS/PTS). Only applies to h.264 and h.265\",\"enum\":[\"ALIGN_ZERO_NEGATIVE_CTO\"],\"type\":\"string\"}},\"required\":[\"segmentLength\",\"streams\"]},\"drm\":{\"type\":\"object\",\"properties\":{\"widevine\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WidevineDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte Key id, 32 hexadecimal characters\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base 64 Encoded\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"pssh\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"playready\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PlayReadyDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required\",\"type\":\"string\"},\"keySeed\":{\"description\":\"Key seed to generate key. Either key or keySeed is required\",\"type\":\"string\"},\"laUrl\":{\"description\":\"URL of the license server\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base64 encoded pssh payload\",\"type\":\"string\"},\"method\":{\"enum\":[\"MPEG_CENC\",\"PIFF_CTR\"],\"type\":\"string\"},\"kid\":{\"description\":\"Key identifier\",\"type\":\"string\"},\"additionalInformation\":{\"type\":\"object\",\"properties\":{\"wrmHeaderCustomAttributes\":{\"description\":\"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.\",\"type\":\"string\"}}}},\"required\":[\"outputs\"]}},\"required\":[\"properties\"]}}},\"primetime\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PrimeTimeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte Key id, 32 hexadecimal characters\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base 64 Encoded\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"pssh\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"fairplay\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FairPlayDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"uri\":{\"description\":\"Url of the licensing server\",\"type\":\"string\"}},\"required\":[\"iv\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"marlin\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"MarlinDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte key in hex (32 characters)\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte key in hex (32 characters)\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"clearkey\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ClearKeyDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte key id\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"cenc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CencDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte encryption key id. Required for any other DRM but FairPlay\",\"type\":\"string\"},\"encryptionMode\":{\"description\":\"The encryption method to use. Default is `CTR`\",\"enum\":[\"CTR\",\"CBC\"],\"type\":\"string\"},\"ivSize\":{\"description\":\"Size of the initialization vector\",\"enum\":[\"8_BYTES\",\"16_BYTES\"],\"type\":\"string\"},\"enablePiffCompatibility\":{\"type\":\"boolean\",\"description\":\"Enables compatibility with the Protected Interoperable File Format (PIFF) specification\"},\"widevine\":{\"type\":\"object\",\"description\":\"Configuration for Widevine DRM\",\"properties\":{\"pssh\":{\"description\":\"Base64 encoded pssh payload\",\"type\":\"string\"}},\"required\":[\"pssh\"]},\"playReady\":{\"type\":\"object\",\"description\":\"Configuration for PlayReady DRM\",\"properties\":{\"laUrl\":{\"description\":\"Url of the license server. Either the laUrl or the pssh needs to be provided.\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base64 encoded pssh payload.\",\"type\":\"string\"},\"additionalInformation\":{\"type\":\"object\",\"properties\":{\"wrmHeaderCustomAttributes\":{\"description\":\"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.\",\"type\":\"string\"}}}}},\"marlin\":{\"type\":\"object\",\"description\":\"Configuration for Marlin DRM\"},\"fairPlay\":{\"type\":\"object\",\"description\":\"Configuration for FairPlay DRM\",\"properties\":{\"iv\":{\"description\":\"Initialization vector as hexadecimal string\",\"type\":\"string\"},\"uri\":{\"description\":\"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.\",\"type\":\"string\"}}}},\"required\":[\"encryptionMode\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"aes\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AesEncryptionDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"keyFileUri\":{\"description\":\"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.\",\"type\":\"string\"},\"method\":{\"enum\":[\"SAMPLE_AES\",\"AES_128\"],\"type\":\"string\"}},\"required\":[\"key\",\"method\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"speke\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpekeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"contentId\":{\"description\":\"Unique Identifier of the content, will be generated if not set\",\"type\":\"string\"},\"kid\":{\"description\":\"Optional key identifier, will be generated if not set.\\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\\nwill provide the same keys.\\n\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector represented by a 32-character text string.\\nIt is mandatory if systemIds contains AES128 or FairPlay.\\n\",\"type\":\"string\"},\"provider\":{\"type\":\"object\",\"description\":\"Key provider configuration for SPEKE\",\"properties\":{\"url\":{\"description\":\"URL of the endpoint\",\"type\":\"string\"},\"username\":{\"description\":\"Your username for Basic Authentication\",\"type\":\"string\"},\"password\":{\"description\":\"Your password for Basic Authentication\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Your API key for authentication via X-API-Key HTTP Header\",\"type\":\"string\"},\"roleArn\":{\"description\":\"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\\n\\nDuring the key exchange the role will be assumed to be able to access the key provider.\\n\\nThis role is to be created in the customer's account and must be granted access to the\\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\\nhas to be added to the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\\nommitted.\\n\\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\\n```\\n{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": [\\n \\\"execute-api:Invoke\\\"\\n ],\\n \\\"Resource\\\": [\\n \\\"arn:aws:execute-api:{{region}}:*:*/*/POST/*\\\"\\n ]\\n }\\n ]\\n}\\n```\\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\\ngive the role access to all regions.\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume access to\\nthe SPEKE server on AWS.\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"gatewayRegion\":{\"description\":\"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\\nin the execute-api policy for the role as described in 'roleArn'.\\n\",\"type\":\"string\"}},\"required\":[\"url\"]},\"systemIds\":{\"description\":\"DRM system identifier of the content protection scheme. At minimum one is expected.\\nNot all systemIds are currently supported, support depends on the muxing type.\\n\\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\\n\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"provider\",\"systemIds\",\"outputs\"]}},\"required\":[\"properties\"]}}}}},\"id3\":{\"type\":\"object\",\"properties\":{\"watermarking\":{\"type\":\"object\",\"properties\":{\"audio\":{\"type\":\"object\",\"properties\":{\"nielsen\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WatermarkingAudioNielsenId3Tag\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"watermarkId\":{\"description\":\"ID of the Nielsen Audio Watermarking decoding-configuration\",\"type\":\"string\"}},\"required\":[\"watermarkId\"]}},\"required\":[\"properties\"]}}}}}}}}}},\"required\":[\"properties\"]}}},\"chunkedText\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ChunkedTextMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the segments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy\",\"type\":\"string\"},\"segmentNamingTemplate\":{\"description\":\"Segment naming policy containing one or both of the following placeholders:\\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\\n Intended to avoid re-use of segment names after restarting a live encoding.\\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\\n\\nIf segmentNamingTemplate is set, segmentNaming must not be set.\\n\",\"type\":\"string\"},\"startOffset\":{\"description\":\"Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). For example, if set to 10 seconds, *X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000* will be added after each *WEBVTT* header. The default for ChunkedTextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for `startOffset` for [TsMuxings](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same `startOffset`.\",\"type\":\"integer\"}},\"required\":[\"segmentLength\",\"streams\"]}},\"required\":[\"properties\"]}}},\"cmaf\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CmafMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the fragments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy\",\"type\":\"string\"},\"segmentNamingTemplate\":{\"description\":\"Segment naming policy containing one or both of the following placeholders:\\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\\n Intended to avoid re-use of segment names after restarting a live encoding.\\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\\n\\nIf segmentNamingTemplate is set, segmentNaming must not be set.\\n\",\"type\":\"string\"},\"initSegmentName\":{\"description\":\"Init segment name\",\"type\":\"string\"},\"initSegmentNameTemplate\":{\"description\":\"Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.\",\"type\":\"string\"},\"framesPerCmafChunk\":{\"description\":\"Number of media frames per CMAF chunk. Defaults to: Length of a segment in frames. Minimum: 1. Maximum: Length of a segment in frames.\",\"type\":\"integer\"}},\"required\":[\"segmentLength\",\"streams\"]}},\"required\":[\"properties\"]}}},\"segmentedRaw\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SegmentedRawMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the fragments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy\",\"type\":\"string\"}},\"required\":[\"segmentLength\",\"segmentNaming\",\"streams\"]}},\"required\":[\"properties\"]}}},\"packedAudio\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PackedAudioMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Duration of a segment, given in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy. The required filename extension depends on the codec (e.g. '.aac' for AAC). Either this or *segmentNamingTemplate* must be set.\",\"type\":\"string\"},\"segmentNamingTemplate\":{\"description\":\"Segment naming policy containing one or both of the following placeholders:\\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\\n Intended to avoid re-use of segment names after restarting a live encoding.\\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\\n\\nIf segmentNamingTemplate is set, segmentNaming must not be set.\\nThe required filename extension depends on the codec (e.g. '.aac' for AAC).\\n\",\"type\":\"string\"},\"startOffset\":{\"description\":\"Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).\",\"type\":\"integer\"}},\"required\":[\"segmentLength\",\"streams\"]},\"drm\":{\"type\":\"object\",\"properties\":{\"aes\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AesEncryptionDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"keyFileUri\":{\"description\":\"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.\",\"type\":\"string\"},\"method\":{\"enum\":[\"SAMPLE_AES\",\"AES_128\"],\"type\":\"string\"}},\"required\":[\"key\",\"method\",\"outputs\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"text\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"TextMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"},\"startOffset\":{\"description\":\"Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). For example, if set to 10 seconds, *X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000* will be added after each *WEBVTT* header. The default for TextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for `startOffset` for [TsMuxings](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same `startOffset`.\",\"type\":\"integer\"}},\"required\":[\"filename\",\"streams\"]}},\"required\":[\"properties\"]}}},\"ts\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"TsMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the fragments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy\",\"type\":\"string\"},\"segmentNamingTemplate\":{\"description\":\"Segment naming policy containing one or both of the following placeholders:\\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\\n Intended to avoid re-use of segment names after restarting a live encoding.\\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\\n\\nIf segmentNamingTemplate is set, segmentNaming must not be set.\\n\",\"type\":\"string\"},\"startOffset\":{\"description\":\"Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).\",\"type\":\"integer\"},\"configuration\":{\"type\":\"object\",\"description\":\"Advanced Configuration of the MPEG Transport Stream Parameters\",\"properties\":{\"programNumber\":{\"description\":\"An integer value. Value for program_number field in the MPEG Transport Stream Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.\",\"minimum\":1,\"maximum\":65535,\"type\":\"integer\"},\"pmt\":{\"type\":\"object\",\"properties\":{\"pid\":{\"description\":\"An integer value. Packet Identifier (PID) for the MPEG Transport Stream PMT.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"}}},\"pcr\":{\"type\":\"object\",\"properties\":{\"pid\":{\"description\":\"An integer value. Packet Identifier (PID) for the MPEG Transport Stream PCR. This should generally point to the video stream PID. If it is not explicitly set it will point to the video stream PID if exists, otherwise to the audio stream PID.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"},\"interval\":{\"description\":\"An integer value. Nominal time between MPEG Transport Stream PCRs in milliseconds.\",\"minimum\":1,\"maximum\":65535,\"type\":\"integer\"}}},\"videoStreams\":{\"items\":{\"type\":\"object\",\"title\":\"TsVideoStreamConfiguration\",\"properties\":{\"streamId\":{\"description\":\"The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.\",\"type\":\"string\"},\"pid\":{\"description\":\"An integer value. MPEG Transport Stream Packet Identifier (PID) for this video stream.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"}},\"required\":[\"pid\",\"streamId\"]},\"type\":\"array\"},\"audioStreams\":{\"items\":{\"type\":\"object\",\"title\":\"TsAudioStreamConfiguration\",\"properties\":{\"streamId\":{\"description\":\"The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.\",\"type\":\"string\"},\"pid\":{\"description\":\"An integer value. MPEG Transport Stream Packet Identifier (PID) for this audio stream.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"}},\"required\":[\"pid\",\"streamId\"]},\"type\":\"array\"}}}},\"required\":[\"streams\"]},\"drm\":{\"type\":\"object\",\"properties\":{\"fairplay\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FairPlayDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"uri\":{\"description\":\"Url of the licensing server\",\"type\":\"string\"}},\"required\":[\"iv\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"aes\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AesEncryptionDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"keyFileUri\":{\"description\":\"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.\",\"type\":\"string\"},\"method\":{\"enum\":[\"SAMPLE_AES\",\"AES_128\"],\"type\":\"string\"}},\"required\":[\"key\",\"method\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"speke\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpekeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"contentId\":{\"description\":\"Unique Identifier of the content, will be generated if not set\",\"type\":\"string\"},\"kid\":{\"description\":\"Optional key identifier, will be generated if not set.\\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\\nwill provide the same keys.\\n\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector represented by a 32-character text string.\\nIt is mandatory if systemIds contains AES128 or FairPlay.\\n\",\"type\":\"string\"},\"provider\":{\"type\":\"object\",\"description\":\"Key provider configuration for SPEKE\",\"properties\":{\"url\":{\"description\":\"URL of the endpoint\",\"type\":\"string\"},\"username\":{\"description\":\"Your username for Basic Authentication\",\"type\":\"string\"},\"password\":{\"description\":\"Your password for Basic Authentication\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Your API key for authentication via X-API-Key HTTP Header\",\"type\":\"string\"},\"roleArn\":{\"description\":\"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\\n\\nDuring the key exchange the role will be assumed to be able to access the key provider.\\n\\nThis role is to be created in the customer's account and must be granted access to the\\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\\nhas to be added to the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\\nommitted.\\n\\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\\n```\\n{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": [\\n \\\"execute-api:Invoke\\\"\\n ],\\n \\\"Resource\\\": [\\n \\\"arn:aws:execute-api:{{region}}:*:*/*/POST/*\\\"\\n ]\\n }\\n ]\\n}\\n```\\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\\ngive the role access to all regions.\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume access to\\nthe SPEKE server on AWS.\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"gatewayRegion\":{\"description\":\"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\\nin the execute-api policy for the role as described in 'roleArn'.\\n\",\"type\":\"string\"}},\"required\":[\"url\"]},\"systemIds\":{\"description\":\"DRM system identifier of the content protection scheme. At minimum one is expected.\\nNot all systemIds are currently supported, support depends on the muxing type.\\n\\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\\n\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"provider\",\"systemIds\",\"outputs\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"webm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WebmMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the fragments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"segmentNaming\":{\"description\":\"Segment naming policy\",\"type\":\"string\"},\"segmentNamingTemplate\":{\"description\":\"Segment naming policy containing one or both of the following placeholders:\\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\\n Intended to avoid re-use of segment names after restarting a live encoding.\\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\\n\\nIf segmentNamingTemplate is set, segmentNaming must not be set.\\n\",\"type\":\"string\"},\"initSegmentName\":{\"description\":\"Init segment name\",\"type\":\"string\"},\"initSegmentNameTemplate\":{\"description\":\"Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.\",\"type\":\"string\"}},\"required\":[\"segmentLength\",\"streams\"]},\"drm\":{\"type\":\"object\",\"properties\":{\"cenc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CencDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte encryption key id. Required for any other DRM but FairPlay\",\"type\":\"string\"},\"encryptionMode\":{\"description\":\"The encryption method to use. Default is `CTR`\",\"enum\":[\"CTR\",\"CBC\"],\"type\":\"string\"},\"ivSize\":{\"description\":\"Size of the initialization vector\",\"enum\":[\"8_BYTES\",\"16_BYTES\"],\"type\":\"string\"},\"enablePiffCompatibility\":{\"type\":\"boolean\",\"description\":\"Enables compatibility with the Protected Interoperable File Format (PIFF) specification\"},\"widevine\":{\"type\":\"object\",\"description\":\"Configuration for Widevine DRM\",\"properties\":{\"pssh\":{\"description\":\"Base64 encoded pssh payload\",\"type\":\"string\"}},\"required\":[\"pssh\"]},\"playReady\":{\"type\":\"object\",\"description\":\"Configuration for PlayReady DRM\",\"properties\":{\"laUrl\":{\"description\":\"Url of the license server. Either the laUrl or the pssh needs to be provided.\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base64 encoded pssh payload.\",\"type\":\"string\"},\"additionalInformation\":{\"type\":\"object\",\"properties\":{\"wrmHeaderCustomAttributes\":{\"description\":\"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.\",\"type\":\"string\"}}}}},\"marlin\":{\"type\":\"object\",\"description\":\"Configuration for Marlin DRM\"},\"fairPlay\":{\"type\":\"object\",\"description\":\"Configuration for FairPlay DRM\",\"properties\":{\"iv\":{\"description\":\"Initialization vector as hexadecimal string\",\"type\":\"string\"},\"uri\":{\"description\":\"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.\",\"type\":\"string\"}}}},\"required\":[\"encryptionMode\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"speke\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpekeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"contentId\":{\"description\":\"Unique Identifier of the content, will be generated if not set\",\"type\":\"string\"},\"kid\":{\"description\":\"Optional key identifier, will be generated if not set.\\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\\nwill provide the same keys.\\n\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector represented by a 32-character text string.\\nIt is mandatory if systemIds contains AES128 or FairPlay.\\n\",\"type\":\"string\"},\"provider\":{\"type\":\"object\",\"description\":\"Key provider configuration for SPEKE\",\"properties\":{\"url\":{\"description\":\"URL of the endpoint\",\"type\":\"string\"},\"username\":{\"description\":\"Your username for Basic Authentication\",\"type\":\"string\"},\"password\":{\"description\":\"Your password for Basic Authentication\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Your API key for authentication via X-API-Key HTTP Header\",\"type\":\"string\"},\"roleArn\":{\"description\":\"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\\n\\nDuring the key exchange the role will be assumed to be able to access the key provider.\\n\\nThis role is to be created in the customer's account and must be granted access to the\\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\\nhas to be added to the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\\nommitted.\\n\\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\\n```\\n{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": [\\n \\\"execute-api:Invoke\\\"\\n ],\\n \\\"Resource\\\": [\\n \\\"arn:aws:execute-api:{{region}}:*:*/*/POST/*\\\"\\n ]\\n }\\n ]\\n}\\n```\\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\\ngive the role access to all regions.\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume access to\\nthe SPEKE server on AWS.\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"gatewayRegion\":{\"description\":\"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\\nin the execute-api policy for the role as described in 'roleArn'.\\n\",\"type\":\"string\"}},\"required\":[\"url\"]},\"systemIds\":{\"description\":\"DRM system identifier of the content protection scheme. At minimum one is expected.\\nNot all systemIds are currently supported, support depends on the muxing type.\\n\\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\\n\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"provider\",\"systemIds\",\"outputs\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"mp3\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Mp3Muxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"}},\"required\":[\"filename\",\"streams\"]}},\"required\":[\"properties\"]}}},\"mp4\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Mp4Muxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file (either `filename` or `name` is required, prefer `filename`)\",\"type\":\"string\"},\"fragmentDuration\":{\"description\":\" Duration of fragments in milliseconds. Required for Fragmented MP4 Muxing (for Smooth Streaming or DASH On-Demand). Not setting this will result in unfragmented mp4.\",\"type\":\"integer\"},\"fragmentedMP4MuxingManifestType\":{\"enum\":[\"SMOOTH\",\"DASH_ON_DEMAND\",\"HLS_BYTE_RANGES\",\"NONE\",\"HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST\"],\"type\":\"string\"},\"dolbyVisionConfiguration\":{\"type\":\"object\",\"description\":\"Dolby Vision specific configuration\",\"properties\":{\"trackSampleEntryName\":{\"title\":\"DolbyVisionTrackSampleEntryName\",\"description\":\"Dolby Vision track's sample entry name\",\"enum\":[\"DVHE\",\"DVH1\"],\"type\":\"string\"}}}},\"required\":[\"streams\"]},\"drm\":{\"type\":\"object\",\"properties\":{\"playready\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PlayReadyDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required\",\"type\":\"string\"},\"keySeed\":{\"description\":\"Key seed to generate key. Either key or keySeed is required\",\"type\":\"string\"},\"laUrl\":{\"description\":\"URL of the license server\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base64 encoded pssh payload\",\"type\":\"string\"},\"method\":{\"enum\":[\"MPEG_CENC\",\"PIFF_CTR\"],\"type\":\"string\"},\"kid\":{\"description\":\"Key identifier\",\"type\":\"string\"},\"additionalInformation\":{\"type\":\"object\",\"properties\":{\"wrmHeaderCustomAttributes\":{\"description\":\"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.\",\"type\":\"string\"}}}},\"required\":[\"outputs\"]}},\"required\":[\"properties\"]}}},\"clearkey\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ClearKeyDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte key id\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"widevine\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WidevineDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte Key id, 32 hexadecimal characters\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base 64 Encoded\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"pssh\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"marlin\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"MarlinDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte key in hex (32 characters)\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte key in hex (32 characters)\",\"type\":\"string\"}},\"required\":[\"key\",\"kid\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"cenc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CencDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte encryption key id. Required for any other DRM but FairPlay\",\"type\":\"string\"},\"encryptionMode\":{\"description\":\"The encryption method to use. Default is `CTR`\",\"enum\":[\"CTR\",\"CBC\"],\"type\":\"string\"},\"ivSize\":{\"description\":\"Size of the initialization vector\",\"enum\":[\"8_BYTES\",\"16_BYTES\"],\"type\":\"string\"},\"enablePiffCompatibility\":{\"type\":\"boolean\",\"description\":\"Enables compatibility with the Protected Interoperable File Format (PIFF) specification\"},\"widevine\":{\"type\":\"object\",\"description\":\"Configuration for Widevine DRM\",\"properties\":{\"pssh\":{\"description\":\"Base64 encoded pssh payload\",\"type\":\"string\"}},\"required\":[\"pssh\"]},\"playReady\":{\"type\":\"object\",\"description\":\"Configuration for PlayReady DRM\",\"properties\":{\"laUrl\":{\"description\":\"Url of the license server. Either the laUrl or the pssh needs to be provided.\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base64 encoded pssh payload.\",\"type\":\"string\"},\"additionalInformation\":{\"type\":\"object\",\"properties\":{\"wrmHeaderCustomAttributes\":{\"description\":\"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.\",\"type\":\"string\"}}}}},\"marlin\":{\"type\":\"object\",\"description\":\"Configuration for Marlin DRM\"},\"fairPlay\":{\"type\":\"object\",\"description\":\"Configuration for FairPlay DRM\",\"properties\":{\"iv\":{\"description\":\"Initialization vector as hexadecimal string\",\"type\":\"string\"},\"uri\":{\"description\":\"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.\",\"type\":\"string\"}}}},\"required\":[\"encryptionMode\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"speke\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpekeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"contentId\":{\"description\":\"Unique Identifier of the content, will be generated if not set\",\"type\":\"string\"},\"kid\":{\"description\":\"Optional key identifier, will be generated if not set.\\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\\nwill provide the same keys.\\n\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector represented by a 32-character text string.\\nIt is mandatory if systemIds contains AES128 or FairPlay.\\n\",\"type\":\"string\"},\"provider\":{\"type\":\"object\",\"description\":\"Key provider configuration for SPEKE\",\"properties\":{\"url\":{\"description\":\"URL of the endpoint\",\"type\":\"string\"},\"username\":{\"description\":\"Your username for Basic Authentication\",\"type\":\"string\"},\"password\":{\"description\":\"Your password for Basic Authentication\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Your API key for authentication via X-API-Key HTTP Header\",\"type\":\"string\"},\"roleArn\":{\"description\":\"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\\n\\nDuring the key exchange the role will be assumed to be able to access the key provider.\\n\\nThis role is to be created in the customer's account and must be granted access to the\\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\\nhas to be added to the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\\nommitted.\\n\\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\\n```\\n{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": [\\n \\\"execute-api:Invoke\\\"\\n ],\\n \\\"Resource\\\": [\\n \\\"arn:aws:execute-api:{{region}}:*:*/*/POST/*\\\"\\n ]\\n }\\n ]\\n}\\n```\\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\\ngive the role access to all regions.\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume access to\\nthe SPEKE server on AWS.\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"gatewayRegion\":{\"description\":\"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\\nin the execute-api policy for the role as described in 'roleArn'.\\n\",\"type\":\"string\"}},\"required\":[\"url\"]},\"systemIds\":{\"description\":\"DRM system identifier of the content protection scheme. At minimum one is expected.\\nNot all systemIds are currently supported, support depends on the muxing type.\\n\\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\\n\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"provider\",\"systemIds\",\"outputs\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"mxf\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"MxfMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"}},\"required\":[\"filename\",\"streams\"]}},\"required\":[\"properties\"]}}},\"progressiveTs\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ProgressiveTsMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the segments in seconds\",\"format\":\"double\",\"type\":\"number\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"},\"startOffset\":{\"description\":\"Offset of MPEG-TS timestamps in seconds. e.g. first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).\",\"type\":\"integer\"}},\"required\":[\"streams\"]},\"id3\":{\"type\":\"object\",\"properties\":{\"raw\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"RawId3Tag\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"positionMode\":{\"enum\":[\"TIME\",\"FRAME\"],\"type\":\"string\"},\"frame\":{\"description\":\"Frame number at which the Tag should be inserted\",\"type\":\"integer\"},\"time\":{\"description\":\"Time in seconds where the Tag should be inserted\",\"format\":\"double\",\"type\":\"number\"},\"bytes\":{\"description\":\"Base64 Encoded Data\",\"type\":\"string\"}},\"required\":[\"bytes\"]}},\"required\":[\"properties\"]}}},\"frameId\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FrameIdId3Tag\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"positionMode\":{\"enum\":[\"TIME\",\"FRAME\"],\"type\":\"string\"},\"frame\":{\"description\":\"Frame number at which the Tag should be inserted\",\"type\":\"integer\"},\"time\":{\"description\":\"Time in seconds where the Tag should be inserted\",\"format\":\"double\",\"type\":\"number\"},\"bytes\":{\"description\":\"Base64 Encoded Data\",\"type\":\"string\"},\"frameId\":{\"description\":\"4 character long Frame ID\",\"type\":\"string\"}},\"required\":[\"bytes\",\"frameId\"]}},\"required\":[\"properties\"]}}},\"plainText\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"PlaintextId3Tag\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"positionMode\":{\"enum\":[\"TIME\",\"FRAME\"],\"type\":\"string\"},\"frame\":{\"description\":\"Frame number at which the Tag should be inserted\",\"type\":\"integer\"},\"time\":{\"description\":\"Time in seconds where the Tag should be inserted\",\"format\":\"double\",\"type\":\"number\"},\"text\":{\"description\":\"Plain Text Data\",\"type\":\"string\"},\"frameId\":{\"description\":\"4 character long Frame ID\",\"type\":\"string\"}},\"required\":[\"frameId\",\"text\"]}},\"required\":[\"properties\"]}}}}},\"drm\":{\"type\":\"object\",\"properties\":{\"fairplay\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"FairPlayDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"uri\":{\"description\":\"Url of the licensing server\",\"type\":\"string\"}},\"required\":[\"iv\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"aes\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AesEncryptionDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte Encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector\",\"type\":\"string\"},\"keyFileUri\":{\"description\":\"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.\",\"type\":\"string\"},\"method\":{\"enum\":[\"SAMPLE_AES\",\"AES_128\"],\"type\":\"string\"}},\"required\":[\"key\",\"method\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"speke\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpekeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"contentId\":{\"description\":\"Unique Identifier of the content, will be generated if not set\",\"type\":\"string\"},\"kid\":{\"description\":\"Optional key identifier, will be generated if not set.\\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\\nwill provide the same keys.\\n\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector represented by a 32-character text string.\\nIt is mandatory if systemIds contains AES128 or FairPlay.\\n\",\"type\":\"string\"},\"provider\":{\"type\":\"object\",\"description\":\"Key provider configuration for SPEKE\",\"properties\":{\"url\":{\"description\":\"URL of the endpoint\",\"type\":\"string\"},\"username\":{\"description\":\"Your username for Basic Authentication\",\"type\":\"string\"},\"password\":{\"description\":\"Your password for Basic Authentication\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Your API key for authentication via X-API-Key HTTP Header\",\"type\":\"string\"},\"roleArn\":{\"description\":\"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\\n\\nDuring the key exchange the role will be assumed to be able to access the key provider.\\n\\nThis role is to be created in the customer's account and must be granted access to the\\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\\nhas to be added to the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\\nommitted.\\n\\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\\n```\\n{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": [\\n \\\"execute-api:Invoke\\\"\\n ],\\n \\\"Resource\\\": [\\n \\\"arn:aws:execute-api:{{region}}:*:*/*/POST/*\\\"\\n ]\\n }\\n ]\\n}\\n```\\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\\ngive the role access to all regions.\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume access to\\nthe SPEKE server on AWS.\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"gatewayRegion\":{\"description\":\"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\\nin the execute-api policy for the role as described in 'roleArn'.\\n\",\"type\":\"string\"}},\"required\":[\"url\"]},\"systemIds\":{\"description\":\"DRM system identifier of the content protection scheme. At minimum one is expected.\\nNot all systemIds are currently supported, support depends on the muxing type.\\n\\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\\n\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"provider\",\"systemIds\",\"outputs\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"broadcastTs\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"BroadcastTsMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Length of the segments in seconds.\",\"format\":\"double\",\"type\":\"number\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"},\"configuration\":{\"type\":\"object\",\"properties\":{\"transport\":{\"type\":\"object\",\"description\":\"Transport configuration details for the Broadcast TS muxing.\",\"properties\":{\"muxrate\":{\"description\":\"Output rate in bps. The value zero implies to use minimal rate. The minimal rate leaves approximately 15kbps of null packets in the stream.\",\"minimum\":0,\"maximum\":1000000000,\"format\":\"double\",\"type\":\"number\"},\"stopOnError\":{\"type\":\"boolean\",\"description\":\"Stop mux on errors. If true, implies halt multiplexing when any error is encountered. If false, errors are ignored and multiplexing continues. Note that the recovery from an error will usually result in an illegal transport stream and artifacts on a decoder.\"},\"preventEmptyAdaptionFieldsInVideo\":{\"type\":\"boolean\",\"description\":\"If true, prevents adaptation fields with length field equal to zero in video, i.e., zero-length AF. Please note that this condition can only occur when pesAlign for the input stream is set to true.\"},\"patRepetitionRatePerSec\":{\"description\":\"Program Association Table (PAT) repetition rate per second. Number of PATs per second.\",\"minimum\":0.001,\"maximum\":1000,\"format\":\"double\",\"type\":\"number\"},\"pmtRepetitionRatePerSec\":{\"description\":\"Program Map Table (PMT) repetition rate per second. Number of PMTs for each program per second.\",\"minimum\":0.001,\"maximum\":1000,\"format\":\"double\",\"type\":\"number\"},\"variableMuxRate\":{\"type\":\"boolean\",\"description\":\"When false, the output stream is created at a constant bit rate. When true, the output rate is allowed to vary from a maximum rate set by the muxrate parameter down to the minimum required to carry the stream.\"},\"initialPresentationTimeStamp\":{\"description\":\"Presentation time stamp value for the first video frame. The timestamp is specified in the timescale of 90000\",\"minimum\":0,\"maximum\":5400000,\"format\":\"double\",\"type\":\"number\"},\"initialProgramClockReference\":{\"description\":\"Program Clock Reference value at the beginning of the first packet for the transport stream. The PCR is specified in the timescale of 90000\",\"minimum\":0,\"maximum\":2576980377600,\"format\":\"double\",\"type\":\"number\"}}},\"program\":{\"type\":\"object\",\"description\":\"Program configuration details for the Broadcast TS muxing.\",\"properties\":{\"programNumber\":{\"description\":\"An integer value. Value for program_number field in Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.\",\"minimum\":1,\"maximum\":65535,\"type\":\"integer\"},\"pidForPMT\":{\"description\":\"An integer value. Packet identifier (PID) to use for Program Map Table (PMT). Recommended value is 2 x programNumber.\",\"minimum\":10,\"maximum\":8190,\"type\":\"integer\"},\"insertProgramClockRefOnPes\":{\"type\":\"boolean\",\"description\":\"Insert Program Clock References (PCRs) on all packetized elemementary stream packets. When false, indicates that PCRs should be inserted on every PES header. This parameter is effective only when the PCR packet identifier is the same as a video or audio elementary stream.\"},\"programClockRefInterval\":{\"description\":\"Interval between Program Clock References (PCRs) in milliseconds. Defines the period between PCR fields inserted in the stream. The default value is 90ms.\",\"minimum\":1,\"maximum\":100,\"type\":\"integer\"}}},\"videoStreams\":{\"items\":{\"type\":\"object\",\"title\":\"BroadcastTsVideoInputStreamConfiguration\",\"properties\":{\"streamId\":{\"description\":\"The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.\",\"type\":\"string\"},\"packetIdentifier\":{\"description\":\"An integer value. Packet Identifier (PID) for this stream.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"},\"startWithDiscontinuityIndicator\":{\"type\":\"boolean\",\"description\":\"Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.\"},\"alignPes\":{\"type\":\"boolean\",\"description\":\"Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.\"},\"setRaiOnAu\":{\"enum\":[\"NONE\",\"ALL_PES_PACKETS\",\"ACQUISITION_POINT_PACKETS\",\"ACCORDING_TO_INPUT\"],\"type\":\"string\"},\"insertAccessUnitDelimiterInAvc\":{\"type\":\"boolean\",\"description\":\"If true, add access unit delimiters (AUD) to AVC stream if AUD is missing from input elementary stream.\"},\"maxDecodeDelay\":{\"description\":\"Maximum Decoder Delay in 90 KHz cycles. When non-zero, the difference between the PCR and the DTS for each picture as it is inserted into the output transport stream is limited to this number of 90 KHz cycles. Values below 1000 are treated as 0 and ignored. Valid Range [0, 1000-900000]\",\"minimum\":1000,\"maximum\":900000,\"type\":\"integer\"}}},\"type\":\"array\"},\"audioStreams\":{\"items\":{\"type\":\"object\",\"title\":\"BroadcastTsAudioInputStreamConfiguration\",\"properties\":{\"streamId\":{\"description\":\"The UUID of the audio stream to which this configuration belongs to. This has to be an ID of an audio stream that has been added to the current muxing.\",\"type\":\"string\"},\"packetIdentifier\":{\"description\":\"An integer value. Packet Identifier (PID) for this stream.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"},\"startWithDiscontinuityIndicator\":{\"type\":\"boolean\",\"description\":\"Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID.\"},\"alignPes\":{\"type\":\"boolean\",\"description\":\"Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet.\"},\"setRaiOnAu\":{\"enum\":[\"NONE\",\"ALL_PES_PACKETS\",\"ACQUISITION_POINT_PACKETS\",\"ACCORDING_TO_INPUT\"],\"type\":\"string\"},\"useATSCBufferModel\":{\"type\":\"boolean\",\"description\":\"Use ATSC buffer model for AC-3. If true, use the ATSC version of the T-STD buffer model is used. This parameter applies to AC-3 streams only.\"},\"language\":{\"description\":\"Language of the audio stream. Specified according to the ISO 639-2 alpha code for the language descriptor.\",\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"subtitleStreams\":{\"items\":{\"type\":\"object\",\"title\":\"BroadcastTsSubtitleInputStreamConfiguration\",\"properties\":{\"streamId\":{\"description\":\"The UUID of the subtitle stream to which this configuration belongs to. This has to be an ID of an subtitle stream that has been added to the current muxing.\\n\",\"type\":\"string\"},\"packetIdentifier\":{\"description\":\"An integer value. Packet Identifier (PID) for this stream.\",\"minimum\":16,\"maximum\":8190,\"type\":\"integer\"},\"rate\":{\"description\":\"The rate parameter determines the maximum rate in bits per second that should be used for the subtitle stream. The valid range is `100` to `60 000 000` bps or `0`. If the value is set to 0, we will examine the first 100 packets of subtitle packet data and use the highest rate that was computed. If the value is set too low, not enough to accommodate the subtitle bit-rate, then some PES packets corresponding to DVB subtitle stream will be dropped. This parameter is optional and the default value is 0.\\n\",\"minimum\":0,\"maximum\":60000000,\"type\":\"integer\"}}},\"type\":\"array\"}}}},\"required\":[\"streams\"]}},\"required\":[\"properties\"]}}},\"progressiveWav\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ProgressiveWavMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"}},\"required\":[\"filename\",\"streams\"]}},\"required\":[\"properties\"]}}},\"progressiveWebm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ProgressiveWebmMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"},\"manifestType\":{\"enum\":[\"DASH_ON_DEMAND\",\"NONE\"],\"type\":\"string\"},\"segmentLength\":{\"description\":\"Determines the length of segments in seconds if manifestType is set to DASH_ON_DEMAND. Defaults to 4 seconds\",\"format\":\"double\",\"type\":\"number\"}},\"required\":[\"streams\"]},\"drm\":{\"type\":\"object\",\"properties\":{\"cenc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CencDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"key\":{\"description\":\"16 byte encryption key, 32 hexadecimal characters\",\"type\":\"string\"},\"kid\":{\"description\":\"16 byte encryption key id. Required for any other DRM but FairPlay\",\"type\":\"string\"},\"encryptionMode\":{\"description\":\"The encryption method to use. Default is `CTR`\",\"enum\":[\"CTR\",\"CBC\"],\"type\":\"string\"},\"ivSize\":{\"description\":\"Size of the initialization vector\",\"enum\":[\"8_BYTES\",\"16_BYTES\"],\"type\":\"string\"},\"enablePiffCompatibility\":{\"type\":\"boolean\",\"description\":\"Enables compatibility with the Protected Interoperable File Format (PIFF) specification\"},\"widevine\":{\"type\":\"object\",\"description\":\"Configuration for Widevine DRM\",\"properties\":{\"pssh\":{\"description\":\"Base64 encoded pssh payload\",\"type\":\"string\"}},\"required\":[\"pssh\"]},\"playReady\":{\"type\":\"object\",\"description\":\"Configuration for PlayReady DRM\",\"properties\":{\"laUrl\":{\"description\":\"Url of the license server. Either the laUrl or the pssh needs to be provided.\",\"type\":\"string\"},\"pssh\":{\"description\":\"Base64 encoded pssh payload.\",\"type\":\"string\"},\"additionalInformation\":{\"type\":\"object\",\"properties\":{\"wrmHeaderCustomAttributes\":{\"description\":\"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.\",\"type\":\"string\"}}}}},\"marlin\":{\"type\":\"object\",\"description\":\"Configuration for Marlin DRM\"},\"fairPlay\":{\"type\":\"object\",\"description\":\"Configuration for FairPlay DRM\",\"properties\":{\"iv\":{\"description\":\"Initialization vector as hexadecimal string\",\"type\":\"string\"},\"uri\":{\"description\":\"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.\",\"type\":\"string\"}}}},\"required\":[\"encryptionMode\",\"key\",\"outputs\"]}},\"required\":[\"properties\"]}}},\"speke\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpekeDrm\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"contentId\":{\"description\":\"Unique Identifier of the content, will be generated if not set\",\"type\":\"string\"},\"kid\":{\"description\":\"Optional key identifier, will be generated if not set.\\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\\nwill provide the same keys.\\n\",\"type\":\"string\"},\"iv\":{\"description\":\"16 byte initialization vector represented by a 32-character text string.\\nIt is mandatory if systemIds contains AES128 or FairPlay.\\n\",\"type\":\"string\"},\"provider\":{\"type\":\"object\",\"description\":\"Key provider configuration for SPEKE\",\"properties\":{\"url\":{\"description\":\"URL of the endpoint\",\"type\":\"string\"},\"username\":{\"description\":\"Your username for Basic Authentication\",\"type\":\"string\"},\"password\":{\"description\":\"Your password for Basic Authentication\",\"type\":\"string\"},\"apiKey\":{\"description\":\"Your API key for authentication via X-API-Key HTTP Header\",\"type\":\"string\"},\"roleArn\":{\"description\":\"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\\n\\nDuring the key exchange the role will be assumed to be able to access the key provider.\\n\\nThis role is to be created in the customer's account and must be granted access to the\\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\\nhas to be added to the trust policy of the role:\\n\\n```\\n{\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Principal\\\": {\\n \\\"AWS\\\": \\\"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\\\"\\n },\\n \\\"Action\\\": \\\"sts:AssumeRole\\\",\\n \\\"Condition\\\": {\\n \\\"StringEquals\\\": {\\n \\\"sts:ExternalId\\\": \\\"{{externalId}}\\\"\\n }\\n }\\n}\\n```\\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\\nommitted.\\n\\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\\n```\\n{\\n \\\"Version\\\": \\\"2012-10-17\\\",\\n \\\"Statement\\\": [\\n {\\n \\\"Effect\\\": \\\"Allow\\\",\\n \\\"Action\\\": [\\n \\\"execute-api:Invoke\\\"\\n ],\\n \\\"Resource\\\": [\\n \\\"arn:aws:execute-api:{{region}}:*:*/*/POST/*\\\"\\n ]\\n }\\n ]\\n}\\n```\\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\\ngive the role access to all regions.\\n\",\"type\":\"string\"},\"externalId\":{\"description\":\"External ID used together with the IAM role identified by `roleArn` to assume access to\\nthe SPEKE server on AWS.\\n\",\"type\":\"string\"},\"externalIdMode\":{\"enum\":[\"CUSTOM\",\"GLOBAL\",\"GENERATED\"],\"type\":\"string\"},\"gatewayRegion\":{\"description\":\"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\\nin the execute-api policy for the role as described in 'roleArn'.\\n\",\"type\":\"string\"}},\"required\":[\"url\"]},\"systemIds\":{\"description\":\"DRM system identifier of the content protection scheme. At minimum one is expected.\\nNot all systemIds are currently supported, support depends on the muxing type.\\n\\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\\n\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}},\"required\":[\"provider\",\"systemIds\",\"outputs\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"progressiveMov\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ProgressiveMovMuxing\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"streams\":{\"items\":{\"type\":\"object\",\"title\":\"MuxingStream\",\"properties\":{\"streamId\":{\"type\":\"string\"}},\"required\":[\"streamId\"]},\"type\":\"array\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"streamConditionsMode\":{\"description\":\"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.\",\"enum\":[\"DROP_MUXING\",\"DROP_STREAM\"],\"type\":\"string\"},\"filename\":{\"description\":\"Name of the output file\",\"type\":\"string\"}},\"required\":[\"streams\"]}},\"required\":[\"properties\"]}}}}},\"captions\":{\"type\":\"object\",\"properties\":{\"scc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ConvertSccCaption\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"input\":{\"type\":\"object\",\"description\":\"The input location to get the scc file from\",\"properties\":{\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to media file\",\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"fileName\":{\"description\":\"Name of the captions file\",\"type\":\"string\"},\"outputFormat\":{\"enum\":[\"WEBVTT\"],\"type\":\"string\"},\"webVttSettings\":{\"type\":\"object\",\"description\":\"Optional settings when converting SCC to WebVTT\",\"properties\":{\"positionMode\":{\"title\":\"ConvertSccPositionMode\",\"enum\":[\"FULL\",\"SIMPLE\",\"NONE\"],\"type\":\"string\"},\"removeFlash\":{\"type\":\"boolean\",\"description\":\"Remove flash (blinking) information when converting SCC to WebVTT\"},\"removeColor\":{\"type\":\"boolean\",\"description\":\"Remove color information when converting SCC to WebVTT\"}}}},\"required\":[\"fileName\",\"input\",\"outputFormat\",\"outputs\"]}},\"required\":[\"properties\"]}}}}},\"sidecars\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SidecarFile\",\"description\":\"A file that is added to an encoding. The size limit for a sidecar file is 10 MB\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to sidecar file\",\"type\":\"string\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"errorMode\":{\"description\":\"This defines how errors should be handled\",\"enum\":[\"FAIL_ON_ERROR\",\"CONTINUE_ON_ERROR\"],\"type\":\"string\"}},\"required\":[\"inputId\",\"inputPath\"]},\"webvtt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"WebVttSidecarFile\",\"description\":\"An external WebVTT file that is added to an encoding. The size limit for a sidecar file is 10 MB\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"inputId\":{\"description\":\"Id of input\",\"type\":\"string\"},\"inputPath\":{\"description\":\"Path to sidecar file\",\"type\":\"string\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"errorMode\":{\"description\":\"This defines how errors should be handled\",\"enum\":[\"FAIL_ON_ERROR\",\"CONTINUE_ON_ERROR\"],\"type\":\"string\"},\"segmentation\":{\"type\":\"object\",\"properties\":{\"segmentLength\":{\"description\":\"The length of the WebVTT fragments in seconds\",\"format\":\"double\",\"type\":\"number\"}},\"required\":[\"segmentLength\"]}},\"required\":[\"inputId\",\"inputPath\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"keyframes\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Keyframe\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"time\":{\"description\":\"Time in seconds where the keyframe should be inserted\",\"format\":\"double\",\"type\":\"number\"}},\"required\":[\"time\"]}},\"required\":[\"properties\"]}}},\"scte35Triggers\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Scte35Trigger\",\"properties\":{\"time\":{\"description\":\"Time in seconds where the SCTE 35 trigger should be inserted\",\"format\":\"double\",\"type\":\"number\"},\"base64EncodedMetadata\":{\"description\":\"The base 64 encoded data for the SCTE trigger\",\"type\":\"string\"}},\"required\":[\"base64EncodedMetadata\",\"time\"]}},\"required\":[\"properties\"]}}},\"start\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StartEncodingRequest\",\"properties\":{\"trimming\":{\"type\":\"object\",\"description\":\"Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.\",\"properties\":{\"offset\":{\"description\":\"Defines the offset in seconds from which the encoding should start, beginning at 0.\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"duration\":{\"description\":\"Defines how many seconds from the input will be encoded. If not set, the input will be encoded until its end.\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"ignoreDurationIfInputTooShort\":{\"type\":\"boolean\",\"description\":\"When true, \\\"duration\\\" will be interpreted as a maximum and not cause an error if the input is too short\"},\"startPicTiming\":{\"description\":\"Defines the H264 picture timing of the first frame from which the encoding should start. Any defined offset or duration in seconds will be ignored.\",\"type\":\"string\"},\"endPicTiming\":{\"description\":\"Defines the H264 picture timing of the last frame, that will be included in the encoding. Any defined offset or duration in seconds will be ignored.\",\"type\":\"string\"}}},\"scheduling\":{\"type\":\"object\",\"description\":\"Scheduling parameters of the encoding.\",\"properties\":{\"priority\":{\"description\":\"Specifies the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"},\"prewarmedEncoderPoolIds\":{\"description\":\"List of prewarmed encoder pools. If set, prewarmed encoders from pools with these IDs will be used for the encoding if available. The pool IDs will be tried in the order in which they are passed.\",\"items\":{\"type\":\"string\"},\"type\":\"array\"}}},\"tweaks\":{\"type\":\"object\",\"description\":\"Special tweaks for your encoding job.\",\"properties\":{\"audioVideoSyncMode\":{\"description\":\"Different modes for syncing the start and end of audio input streams with the video inputs.\\nThis feature does not work with Dolby Digital (Plus) or Dolby Atmos.\",\"enum\":[\"STANDARD\",\"RESYNC_AT_START\",\"RESYNC_AT_START_AND_END\"],\"type\":\"string\"}}},\"handleVariableInputFps\":{\"type\":\"boolean\",\"description\":\"Enable frame dropping/duplication to handle variable frames per seconds of video input streams\"},\"encodingMode\":{\"description\":\"The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.\",\"enum\":[\"STANDARD\",\"SINGLE_PASS\",\"TWO_PASS\",\"THREE_PASS\"],\"type\":\"string\"},\"previewDashManifests\":{\"description\":\"DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"ManifestResource\",\"properties\":{\"manifestId\":{\"description\":\"Id of the manifest resource\",\"type\":\"string\"}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"previewHlsManifests\":{\"description\":\"HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"ManifestResource\",\"properties\":{\"manifestId\":{\"description\":\"Id of the manifest resource\",\"type\":\"string\"}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"vodDashManifests\":{\"description\":\"DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"ManifestResource\",\"properties\":{\"manifestId\":{\"description\":\"Id of the manifest resource\",\"type\":\"string\"}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"vodHlsManifests\":{\"description\":\"HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"ManifestResource\",\"properties\":{\"manifestId\":{\"description\":\"Id of the manifest resource\",\"type\":\"string\"}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"vodSmoothManifests\":{\"description\":\"Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)\",\"items\":{\"type\":\"object\",\"title\":\"ManifestResource\",\"properties\":{\"manifestId\":{\"description\":\"Id of the manifest resource\",\"type\":\"string\"}},\"required\":[\"manifestId\"]},\"type\":\"array\"},\"manifestGenerator\":{\"description\":\"Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\\n\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"perTitle\":{\"type\":\"object\",\"description\":\"Per-Title settings\",\"properties\":{\"h264Configuration\":{\"type\":\"object\",\"description\":\"Per-Title configuration for H264\",\"properties\":{\"minBitrate\":{\"description\":\"The minimum bitrate that will be used by the Per-Title algorithm.\",\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.\",\"type\":\"integer\"},\"minBitrateStepSize\":{\"description\":\"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000\",\"format\":\"double\",\"type\":\"number\"},\"maxBitrateStepSize\":{\"description\":\"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000\",\"format\":\"double\",\"type\":\"number\"},\"autoRepresentations\":{\"type\":\"object\",\"properties\":{\"adoptConfigurationThreshold\":{\"description\":\"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.\",\"format\":\"double\",\"type\":\"number\"}}},\"complexityFactor\":{\"description\":\"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"fixedResolutionAndBitrateConfiguration\":{\"type\":\"object\",\"description\":\"Additional configuration for fixed resolution and bitrate templates\",\"properties\":{\"forcedRenditionAboveHighestFixedRepresentation\":{\"description\":\"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.\",\"minimum\":1,\"type\":\"integer\"},\"forcedRenditionAboveHighestFixedRepresentationFactor\":{\"description\":\"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.\",\"format\":\"double\",\"type\":\"number\"},\"forcedRenditionAboveHighestFixedRepresentationCalculationMode\":{\"description\":\"Mode to calculate the bitrate of the next representation\",\"enum\":[\"LAST_CALCULATED_BITRATE\",\"MINIMUM\",\"MAXIMUM\",\"AVERAGE\"],\"type\":\"string\"}}},\"resolutionScaleFactor\":{\"description\":\"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.\",\"format\":\"double\",\"type\":\"number\"},\"codecMinBitrateFactor\":{\"description\":\"This factor doesn't have any impact!\",\"format\":\"double\",\"type\":\"number\"},\"codecMaxBitrateFactor\":{\"description\":\"This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate\",\"format\":\"double\",\"type\":\"number\"},\"codecBufsizeFactor\":{\"description\":\"This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate\",\"format\":\"double\",\"type\":\"number\"},\"targetQualityCrf\":{\"description\":\"Desired target quality of the highest representation expressed as CRF value\",\"format\":\"double\",\"type\":\"number\"}}},\"h265Configuration\":{\"type\":\"object\",\"description\":\"Per-Title configuration for H265\",\"properties\":{\"minBitrate\":{\"description\":\"The minimum bitrate that will be used by the Per-Title algorithm.\",\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.\",\"type\":\"integer\"},\"minBitrateStepSize\":{\"description\":\"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000\",\"format\":\"double\",\"type\":\"number\"},\"maxBitrateStepSize\":{\"description\":\"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000\",\"format\":\"double\",\"type\":\"number\"},\"autoRepresentations\":{\"type\":\"object\",\"properties\":{\"adoptConfigurationThreshold\":{\"description\":\"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.\",\"format\":\"double\",\"type\":\"number\"}}},\"complexityFactor\":{\"description\":\"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"fixedResolutionAndBitrateConfiguration\":{\"type\":\"object\",\"description\":\"Additional configuration for fixed resolution and bitrate templates\",\"properties\":{\"forcedRenditionAboveHighestFixedRepresentation\":{\"description\":\"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.\",\"minimum\":1,\"type\":\"integer\"},\"forcedRenditionAboveHighestFixedRepresentationFactor\":{\"description\":\"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.\",\"format\":\"double\",\"type\":\"number\"},\"forcedRenditionAboveHighestFixedRepresentationCalculationMode\":{\"description\":\"Mode to calculate the bitrate of the next representation\",\"enum\":[\"LAST_CALCULATED_BITRATE\",\"MINIMUM\",\"MAXIMUM\",\"AVERAGE\"],\"type\":\"string\"}}},\"resolutionScaleFactor\":{\"description\":\"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.\",\"format\":\"double\",\"type\":\"number\"},\"codecMinBitrateFactor\":{\"description\":\"This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate\",\"format\":\"double\",\"type\":\"number\"},\"codecMaxBitrateFactor\":{\"description\":\"This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate\",\"format\":\"double\",\"type\":\"number\"},\"codecBufsizeFactor\":{\"description\":\"This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate\",\"format\":\"double\",\"type\":\"number\"},\"targetQualityCrf\":{\"description\":\"Desired target quality of the highest representation expressed as CRF value\",\"format\":\"double\",\"type\":\"number\"}}},\"vp9Configuration\":{\"type\":\"object\",\"description\":\"Per-Title configuration for VP9\",\"properties\":{\"minBitrate\":{\"description\":\"The minimum bitrate that will be used by the Per-Title algorithm.\",\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.\",\"type\":\"integer\"},\"minBitrateStepSize\":{\"description\":\"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000\",\"format\":\"double\",\"type\":\"number\"},\"maxBitrateStepSize\":{\"description\":\"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000\",\"format\":\"double\",\"type\":\"number\"},\"autoRepresentations\":{\"type\":\"object\",\"properties\":{\"adoptConfigurationThreshold\":{\"description\":\"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.\",\"format\":\"double\",\"type\":\"number\"}}},\"complexityFactor\":{\"description\":\"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"fixedResolutionAndBitrateConfiguration\":{\"type\":\"object\",\"description\":\"Additional configuration for fixed resolution and bitrate templates\",\"properties\":{\"forcedRenditionAboveHighestFixedRepresentation\":{\"description\":\"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.\",\"minimum\":1,\"type\":\"integer\"},\"forcedRenditionAboveHighestFixedRepresentationFactor\":{\"description\":\"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.\",\"format\":\"double\",\"type\":\"number\"},\"forcedRenditionAboveHighestFixedRepresentationCalculationMode\":{\"description\":\"Mode to calculate the bitrate of the next representation\",\"enum\":[\"LAST_CALCULATED_BITRATE\",\"MINIMUM\",\"MAXIMUM\",\"AVERAGE\"],\"type\":\"string\"}}},\"resolutionScaleFactor\":{\"description\":\"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.\",\"format\":\"double\",\"type\":\"number\"},\"targetQualityCrf\":{\"description\":\"Desired target quality of the highest representation expressed as CRF value\",\"format\":\"double\",\"type\":\"number\"}}},\"av1Configuration\":{\"type\":\"object\",\"description\":\"Per-Title configuration for AV1\",\"properties\":{\"minBitrate\":{\"description\":\"The minimum bitrate that will be used by the Per-Title algorithm.\",\"type\":\"integer\"},\"maxBitrate\":{\"description\":\"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.\",\"type\":\"integer\"},\"minBitrateStepSize\":{\"description\":\"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000\",\"format\":\"double\",\"type\":\"number\"},\"maxBitrateStepSize\":{\"description\":\"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000\",\"format\":\"double\",\"type\":\"number\"},\"autoRepresentations\":{\"type\":\"object\",\"properties\":{\"adoptConfigurationThreshold\":{\"description\":\"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.\",\"format\":\"double\",\"type\":\"number\"}}},\"complexityFactor\":{\"description\":\"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"},\"fixedResolutionAndBitrateConfiguration\":{\"type\":\"object\",\"description\":\"Additional configuration for fixed resolution and bitrate templates\",\"properties\":{\"forcedRenditionAboveHighestFixedRepresentation\":{\"description\":\"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.\",\"minimum\":1,\"type\":\"integer\"},\"forcedRenditionAboveHighestFixedRepresentationFactor\":{\"description\":\"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.\",\"format\":\"double\",\"type\":\"number\"},\"forcedRenditionAboveHighestFixedRepresentationCalculationMode\":{\"description\":\"Mode to calculate the bitrate of the next representation\",\"enum\":[\"LAST_CALCULATED_BITRATE\",\"MINIMUM\",\"MAXIMUM\",\"AVERAGE\"],\"type\":\"string\"}}},\"resolutionScaleFactor\":{\"description\":\"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.\",\"format\":\"double\",\"type\":\"number\"},\"targetQualityCrf\":{\"description\":\"Desired target quality of the highest representation expressed as CRF value\",\"format\":\"double\",\"type\":\"number\"}}}}},\"aiSceneAnalysis\":{\"type\":\"object\",\"description\":\"AI scene analysis settings\",\"properties\":{\"aiService\":{\"type\":\"object\",\"description\":\"AI service settings\",\"properties\":{\"provider\":{\"description\":\"AI service provider\",\"enum\":[\"GOOGLE\"],\"type\":\"string\"}}},\"features\":{\"type\":\"object\",\"description\":\"Features of the AI scene analysis\",\"properties\":{\"assetDescription\":{\"type\":\"object\",\"description\":\"AI scene analysis will create an asset description file.\\n\",\"properties\":{\"filename\":{\"description\":\"Name of the output json file\",\"type\":\"string\"},\"outputs\":{\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"}}},\"automaticAdPlacement\":{\"type\":\"object\",\"description\":\"Ad markers placed on detected scene changes and configured positions.\\n\",\"properties\":{\"schedule\":{\"description\":\"Ad placements schedule\\n\",\"items\":{\"type\":\"object\",\"title\":\"AutomaticAdPlacementPosition\",\"properties\":{\"position\":{\"description\":\"Position of the ad placement in seconds.\",\"format\":\"double\",\"type\":\"number\"},\"maxDeviation\":{\"description\":\"Maximum deviation in seconds to the ad placement position.\",\"format\":\"double\",\"type\":\"number\"},\"duration\":{\"description\":\"The desired duration in seconds of the ad to be inserted.\",\"minimum\":0,\"format\":\"double\",\"type\":\"number\"}}},\"type\":\"array\"}}}}}}}}}},\"required\":[\"properties\"]},\"reprioritize\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ReprioritizeEncodingRequest\",\"properties\":{\"priority\":{\"description\":\"Priority of the Encoding\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"}},\"required\":[\"priority\"]}},\"required\":[\"properties\"]}}},\"reschedule\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"RescheduleEncodingRequest\",\"properties\":{\"infrastructureId\":{\"description\":\"Id of a custom infrastructure, e.g., AWS Cloud Connect\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"],\"oneOf\":[{\"required\":[\"start\"]},{\"required\":[\"live\"]}]}}},\"live\":{\"type\":\"object\",\"properties\":{\"streamKeys\":{\"type\":\"object\",\"properties\":{\"actions\":{\"type\":\"object\",\"properties\":{\"unassign\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StreamKeysUnassignAction\",\"properties\":{\"encodingId\":{\"description\":\"Encoding ID for which stream keys should be unassigned\",\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}}}},\"patternProperties\":{\"^(?!.*\\\\b(?:actions)\\\\b)[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StreamKey\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"value\":{\"description\":\"Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings.\\nIf this value is not provided, a unique random stream key will be generated.\\n**Important:** This value has to be globally unique. If it is set manually, be sure to use a secure value.\\nIf the stream key value is guessed by others your live encoding can be compromised.\\n\",\"type\":\"string\"},\"status\":{\"description\":\"Status of the stream key\",\"enum\":[\"ASSIGNED\",\"UNASSIGNED\"],\"type\":\"string\"},\"type\":{\"description\":\"Type of the stream key\",\"enum\":[\"RESERVED\",\"TEMPORARY\"],\"type\":\"string\"}}}}}}},\"standbyPools\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"LiveStandbyPoolRequest\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"targetPoolSize\":{\"description\":\"Number of instances to keep ready for streaming while the pool is running\",\"minimum\":0,\"type\":\"integer\"},\"encodingTemplate\":{\"description\":\"Base64 encoded template used to start the encodings in the pool\",\"type\":\"string\"}},\"required\":[\"encodingTemplate\",\"targetPoolSize\"]}},\"required\":[\"properties\"]}}}}},\"manifests\":{\"type\":\"object\",\"properties\":{\"dash\":{\"type\":\"object\",\"properties\":{\"defaultapi\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashManifestDefault\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"enum\":[\"DASH\",\"HLS\",\"SMOOTH_STREAMING\"],\"type\":\"string\"},\"outputs\":{\"description\":\"The outputs to store the manifest\",\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Current status\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"generatorVersion\":{\"description\":\"The version of the generator used to create the manifest\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"profile\":{\"description\":\"Determines if segmented or progressive representations can appear in the manifest\",\"enum\":[\"LIVE\",\"ON_DEMAND\"],\"type\":\"string\"},\"manifestName\":{\"description\":\"The filename of your manifest\",\"type\":\"string\"},\"namespaces\":{\"description\":\"List of additional XML namespaces to add to the DASH Manifest\",\"items\":{\"type\":\"object\",\"title\":\"XmlNamespace\",\"properties\":{\"prefix\":{\"description\":\"Name of the XML Namespace reference\",\"type\":\"string\"},\"uri\":{\"description\":\"Source of the XML Namespace reference\",\"type\":\"string\"}},\"required\":[\"prefix\",\"uri\"]},\"type\":\"array\"},\"utcTimings\":{\"description\":\"List of UTC Timings to use for live streaming\",\"items\":{\"type\":\"object\",\"title\":\"UtcTiming\",\"properties\":{\"value\":{\"description\":\"The server to get the time from\",\"type\":\"string\"},\"schemeIdUri\":{\"description\":\"The scheme id to use. Please refer to the DASH standard.\",\"type\":\"string\"}},\"required\":[\"schemeIdUri\",\"value\"]},\"type\":\"array\"},\"dashEditionCompatibility\":{\"description\":\"The manifest compatibility with the standard DASH Edition.\",\"enum\":[\"V4\"],\"type\":\"string\"},\"iso8601TimestampFormat\":{\"description\":\"Determines how timestamps should appear in the manifest\",\"enum\":[\"LONG\",\"SHORT\"],\"type\":\"string\"},\"encodingId\":{\"description\":\"The id of the encoding to create a default manifest for. Either \\\"encodingId\\\" or \\\"periods\\\" is required.\",\"type\":\"string\"},\"version\":{\"description\":\"Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the \\\"manifestGenerator\\\" version of the \\\"Start\\\" request.\",\"enum\":[\"V1\",\"V2\"],\"type\":\"string\"},\"periods\":{\"description\":\"Adds a period for every item. Can only be used when setting \\\"version\\\" to \\\"V2\\\". Either \\\"periods\\\" or \\\"encodingId\\\" is required.\",\"items\":{\"type\":\"object\",\"title\":\"DefaultDashManifestPeriod\",\"properties\":{\"encodingIds\":{\"description\":\"List the encoding ids for which the conditions should apply\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"adaptationSets\":{\"description\":\"Adds an adaption set for every item to the period\",\"items\":{\"type\":\"object\",\"title\":\"DefaultManifestCondition\"},\"type\":\"array\"}}},\"type\":\"array\"}},\"required\":[\"outputs\"]}},\"required\":[\"properties\"]}}}},\"patternProperties\":{\"^(?!.*\\\\b(?:defaultapi)\\\\b)[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashManifest\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"enum\":[\"DASH\",\"HLS\",\"SMOOTH_STREAMING\"],\"type\":\"string\"},\"outputs\":{\"description\":\"The outputs to store the manifest\",\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Current status\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"generatorVersion\":{\"description\":\"The version of the generator used to create the manifest\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"profile\":{\"description\":\"Determines if segmented or progressive representations can appear in the manifest\",\"enum\":[\"LIVE\",\"ON_DEMAND\"],\"type\":\"string\"},\"manifestName\":{\"description\":\"The filename of your manifest\",\"type\":\"string\"},\"namespaces\":{\"description\":\"List of additional XML namespaces to add to the DASH Manifest\",\"items\":{\"type\":\"object\",\"title\":\"XmlNamespace\",\"properties\":{\"prefix\":{\"description\":\"Name of the XML Namespace reference\",\"type\":\"string\"},\"uri\":{\"description\":\"Source of the XML Namespace reference\",\"type\":\"string\"}},\"required\":[\"prefix\",\"uri\"]},\"type\":\"array\"},\"utcTimings\":{\"description\":\"List of UTC Timings to use for live streaming\",\"items\":{\"type\":\"object\",\"title\":\"UtcTiming\",\"properties\":{\"value\":{\"description\":\"The server to get the time from\",\"type\":\"string\"},\"schemeIdUri\":{\"description\":\"The scheme id to use. Please refer to the DASH standard.\",\"type\":\"string\"}},\"required\":[\"schemeIdUri\",\"value\"]},\"type\":\"array\"},\"dashEditionCompatibility\":{\"description\":\"The manifest compatibility with the standard DASH Edition.\",\"enum\":[\"V4\"],\"type\":\"string\"},\"iso8601TimestampFormat\":{\"description\":\"Determines how timestamps should appear in the manifest\",\"enum\":[\"LONG\",\"SHORT\"],\"type\":\"string\"}},\"required\":[\"outputs\"]},\"periods\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"Period\",\"properties\":{\"start\":{\"description\":\"Starting time in seconds\",\"format\":\"double\",\"type\":\"number\"},\"duration\":{\"description\":\"Duration in seconds.<br/>Please note that the duration of a Period is usually determined by the media contained therein.<br/>Setting the `duration` property to a specific value will override this default behaviour.<br/>Warning: Use at your own risk!\",\"format\":\"double\",\"type\":\"number\"}}},\"customXmlElements\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CustomXmlElement\",\"properties\":{\"data\":{\"description\":\"String representation of the XML element\",\"type\":\"string\"}},\"required\":[\"data\"]}},\"required\":[\"properties\"]}}},\"adaptationsets\":{\"type\":\"object\",\"properties\":{\"audio\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AudioAdaptationSet\",\"properties\":{\"customAttributes\":{\"description\":\"Custom adaptation set attributes\",\"items\":{\"type\":\"object\",\"title\":\"CustomAttribute\",\"properties\":{\"key\":{\"description\":\"unique string identifier for the custom attribute\",\"type\":\"string\"},\"value\":{\"description\":\"value of the custom attribute\",\"type\":\"string\"}},\"required\":[\"key\"]},\"type\":\"array\"},\"roles\":{\"description\":\"Roles of the adaptation set\",\"items\":{\"type\":\"string\",\"title\":\"AdaptationSetRole\"},\"type\":\"array\"},\"accessibilities\":{\"description\":\"Provide signaling of CEA 607 and CEA 708\",\"items\":{\"type\":\"object\",\"title\":\"Accessibility\",\"properties\":{\"value\":{\"description\":\"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)\",\"type\":\"string\"},\"schemeIdUri\":{\"description\":\"The scheme id to use. Please refer to the DASH standard.\",\"type\":\"string\"}},\"required\":[\"schemeIdUri\",\"value\"]},\"type\":\"array\"},\"labels\":{\"description\":\"List of labels\",\"items\":{\"type\":\"object\",\"title\":\"Label\",\"properties\":{\"id\":{\"description\":\"Identifier of the label.\",\"minimum\":0,\"type\":\"integer\"},\"lang\":{\"description\":\"Specifies the language of the label.\",\"type\":\"string\"},\"value\":{\"description\":\"Content of the label.\",\"type\":\"string\"}},\"required\":[\"value\"]},\"type\":\"array\"},\"lang\":{\"description\":\"ISO 639-1 (Alpha-2) code identifying the language of the audio adaptation set\",\"type\":\"string\"}},\"required\":[\"lang\"]}},\"required\":[\"properties\"]}}},\"video\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"VideoAdaptationSet\",\"properties\":{\"customAttributes\":{\"description\":\"Custom adaptation set attributes\",\"items\":{\"type\":\"object\",\"title\":\"CustomAttribute\",\"properties\":{\"key\":{\"description\":\"unique string identifier for the custom attribute\",\"type\":\"string\"},\"value\":{\"description\":\"value of the custom attribute\",\"type\":\"string\"}},\"required\":[\"key\"]},\"type\":\"array\"},\"roles\":{\"description\":\"Roles of the adaptation set\",\"items\":{\"type\":\"string\",\"title\":\"AdaptationSetRole\"},\"type\":\"array\"},\"accessibilities\":{\"description\":\"Provide signaling of CEA 607 and CEA 708\",\"items\":{\"type\":\"object\",\"title\":\"Accessibility\",\"properties\":{\"value\":{\"description\":\"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)\",\"type\":\"string\"},\"schemeIdUri\":{\"description\":\"The scheme id to use. Please refer to the DASH standard.\",\"type\":\"string\"}},\"required\":[\"schemeIdUri\",\"value\"]},\"type\":\"array\"},\"labels\":{\"description\":\"List of labels\",\"items\":{\"type\":\"object\",\"title\":\"Label\",\"properties\":{\"id\":{\"description\":\"Identifier of the label.\",\"minimum\":0,\"type\":\"integer\"},\"lang\":{\"description\":\"Specifies the language of the label.\",\"type\":\"string\"},\"value\":{\"description\":\"Content of the label.\",\"type\":\"string\"}},\"required\":[\"value\"]},\"type\":\"array\"}}}},\"required\":[\"properties\"]}}},\"subtitle\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SubtitleAdaptationSet\",\"properties\":{\"customAttributes\":{\"description\":\"Custom adaptation set attributes\",\"items\":{\"type\":\"object\",\"title\":\"CustomAttribute\",\"properties\":{\"key\":{\"description\":\"unique string identifier for the custom attribute\",\"type\":\"string\"},\"value\":{\"description\":\"value of the custom attribute\",\"type\":\"string\"}},\"required\":[\"key\"]},\"type\":\"array\"},\"roles\":{\"description\":\"Roles of the adaptation set\",\"items\":{\"type\":\"string\",\"title\":\"AdaptationSetRole\"},\"type\":\"array\"},\"accessibilities\":{\"description\":\"Provide signaling of CEA 607 and CEA 708\",\"items\":{\"type\":\"object\",\"title\":\"Accessibility\",\"properties\":{\"value\":{\"description\":\"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)\",\"type\":\"string\"},\"schemeIdUri\":{\"description\":\"The scheme id to use. Please refer to the DASH standard.\",\"type\":\"string\"}},\"required\":[\"schemeIdUri\",\"value\"]},\"type\":\"array\"},\"labels\":{\"description\":\"List of labels\",\"items\":{\"type\":\"object\",\"title\":\"Label\",\"properties\":{\"id\":{\"description\":\"Identifier of the label.\",\"minimum\":0,\"type\":\"integer\"},\"lang\":{\"description\":\"Specifies the language of the label.\",\"type\":\"string\"},\"value\":{\"description\":\"Content of the label.\",\"type\":\"string\"}},\"required\":[\"value\"]},\"type\":\"array\"},\"lang\":{\"description\":\"ISO 639-1 (Alpha-2) code identifying the language of the subtitle adaptation set\",\"type\":\"string\"}},\"required\":[\"lang\"]}},\"required\":[\"properties\"]}}},\"image\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ImageAdaptationSet\",\"properties\":{\"customAttributes\":{\"description\":\"Custom adaptation set attributes\",\"items\":{\"type\":\"object\",\"title\":\"CustomAttribute\",\"properties\":{\"key\":{\"description\":\"unique string identifier for the custom attribute\",\"type\":\"string\"},\"value\":{\"description\":\"value of the custom attribute\",\"type\":\"string\"}},\"required\":[\"key\"]},\"type\":\"array\"},\"roles\":{\"description\":\"Roles of the adaptation set\",\"items\":{\"type\":\"string\",\"title\":\"AdaptationSetRole\"},\"type\":\"array\"},\"accessibilities\":{\"description\":\"Provide signaling of CEA 607 and CEA 708\",\"items\":{\"type\":\"object\",\"title\":\"Accessibility\",\"properties\":{\"value\":{\"description\":\"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)\",\"type\":\"string\"},\"schemeIdUri\":{\"description\":\"The scheme id to use. Please refer to the DASH standard.\",\"type\":\"string\"}},\"required\":[\"schemeIdUri\",\"value\"]},\"type\":\"array\"},\"labels\":{\"description\":\"List of labels\",\"items\":{\"type\":\"object\",\"title\":\"Label\",\"properties\":{\"id\":{\"description\":\"Identifier of the label.\",\"minimum\":0,\"type\":\"integer\"},\"lang\":{\"description\":\"Specifies the language of the label.\",\"type\":\"string\"},\"value\":{\"description\":\"Content of the label.\",\"type\":\"string\"}},\"required\":[\"value\"]},\"type\":\"array\"}}}},\"required\":[\"properties\"]}}},\"representations\":{\"type\":\"object\",\"properties\":{\"vtt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashVttRepresentation\",\"properties\":{\"vttUrl\":{\"description\":\"URL of the referenced VTT file\",\"type\":\"string\"}},\"required\":[\"vttUrl\"]}},\"required\":[\"properties\"]}}},\"imsc\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashImscRepresentation\",\"properties\":{\"imscUrl\":{\"description\":\"URL of the referenced IMSC file\",\"type\":\"string\"}},\"required\":[\"imscUrl\"]}},\"required\":[\"properties\"]}}},\"sprite\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SpriteRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"streamId\":{\"description\":\"UUID of a stream\",\"type\":\"string\"},\"spriteId\":{\"description\":\"UUID of a Sprite\",\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to sprite segments. Will be used as the representation id in the manifest.\",\"type\":\"string\"}},\"required\":[\"encodingId\",\"segmentPath\",\"spriteId\",\"streamId\"]}},\"required\":[\"properties\"]}}},\"fmp4\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashFmp4Representation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"type\":{\"enum\":[\"TEMPLATE\",\"LIST\",\"TIMELINE\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"TEMPLATE_REPRESENTATION\",\"TEMPLATE_ADAPTATION_SET\"],\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded\",\"type\":\"integer\"},\"startKeyframeId\":{\"description\":\"Id of the keyframe to start with. It takes precedence over startSegmentNumber\",\"type\":\"string\"},\"endKeyframeId\":{\"description\":\"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.\",\"type\":\"string\"}},\"required\":[\"segmentPath\",\"type\",\"encodingId\",\"muxingId\"]},\"drm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashFmp4DrmRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"type\":{\"enum\":[\"TEMPLATE\",\"LIST\",\"TIMELINE\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"TEMPLATE_REPRESENTATION\",\"TEMPLATE_ADAPTATION_SET\"],\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded\",\"type\":\"integer\"},\"startKeyframeId\":{\"description\":\"Id of the keyframe to start with. It takes precedence over startSegmentNumber\",\"type\":\"string\"},\"endKeyframeId\":{\"description\":\"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.\",\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"segmentPath\",\"type\",\"encodingId\",\"muxingId\"]},\"contentprotection\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ContentProtection\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"contentprotection\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ContentProtection\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"chunkedText\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashChunkedTextRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"type\":{\"enum\":[\"TEMPLATE\",\"LIST\",\"TIMELINE\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"TEMPLATE_REPRESENTATION\",\"TEMPLATE_ADAPTATION_SET\"],\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded\",\"type\":\"integer\"},\"startKeyframeId\":{\"description\":\"Id of the keyframe to start with. It takes precedence over startSegmentNumber\",\"type\":\"string\"},\"endKeyframeId\":{\"description\":\"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.\",\"type\":\"string\"}},\"required\":[\"segmentPath\",\"type\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}},\"cmaf\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashCmafRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"type\":{\"enum\":[\"TEMPLATE\",\"LIST\",\"TIMELINE\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"TEMPLATE_REPRESENTATION\",\"TEMPLATE_ADAPTATION_SET\"],\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded\",\"type\":\"integer\"},\"startKeyframeId\":{\"description\":\"Id of the keyframe to start with. It takes precedence over startSegmentNumber\",\"type\":\"string\"},\"endKeyframeId\":{\"description\":\"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.\",\"type\":\"string\"}},\"required\":[\"segmentPath\",\"type\",\"encodingId\",\"muxingId\"]},\"contentprotection\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ContentProtection\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"mp4\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashMp4Representation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"filePath\":{\"description\":\"Path to the MP4 file\",\"type\":\"string\"},\"type\":{\"description\":\"The type of the dash representation\",\"enum\":[\"SEGMENT_BASE\",\"SEGMENT_LIST\"],\"type\":\"string\"}},\"required\":[\"filePath\",\"encodingId\",\"muxingId\"]},\"drm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashMp4DrmRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"filePath\":{\"description\":\"Path to the MP4 file\",\"type\":\"string\"},\"type\":{\"description\":\"The type of the dash representation\",\"enum\":[\"SEGMENT_BASE\",\"SEGMENT_LIST\"],\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"filePath\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"webm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashWebmRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"type\":{\"enum\":[\"TEMPLATE\",\"LIST\",\"TIMELINE\"],\"type\":\"string\"},\"mode\":{\"enum\":[\"TEMPLATE_REPRESENTATION\",\"TEMPLATE_ADAPTATION_SET\"],\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded\",\"type\":\"integer\"},\"startKeyframeId\":{\"description\":\"Id of the keyframe to start with. It takes precedence over startSegmentNumber\",\"type\":\"string\"},\"endKeyframeId\":{\"description\":\"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.\",\"type\":\"string\"}},\"required\":[\"segmentPath\",\"type\",\"encodingId\",\"muxingId\"]},\"contentprotection\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ContentProtection\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"progressiveWebm\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"DashProgressiveWebmRepresentation\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"filePath\":{\"description\":\"Path to the Progressive WebM file\",\"type\":\"string\"}},\"required\":[\"filePath\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}}},\"contentprotection\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ContentProtection\",\"properties\":{\"encodingId\":{\"description\":\"UUID of an encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"UUID of a muxing\",\"type\":\"string\"},\"dependencyId\":{\"description\":\"Used to signal a dependency with another representation. The representation may belong to a different adaptation set\",\"type\":\"string\"},\"drmId\":{\"description\":\"DRM Id\",\"type\":\"string\"}},\"required\":[\"drmId\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}}}}},\"required\":[\"properties\"]}}},\"start\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StartManifestRequest\",\"properties\":{\"manifestGenerator\":{\"description\":\"Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions:\\n2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\\n\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}}},\"hls\":{\"type\":\"object\",\"properties\":{\"defaultapi\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HlsManifestDefault\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"enum\":[\"DASH\",\"HLS\",\"SMOOTH_STREAMING\"],\"type\":\"string\"},\"outputs\":{\"description\":\"The outputs to store the manifest\",\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Current status\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"generatorVersion\":{\"description\":\"The version of the generator used to create the manifest\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"manifestName\":{\"description\":\"The filename of your manifest. If this is not set, the `name` is used as output file name. Either one of `name` or `manifestName` is required. Be aware that spaces will be replaced with underlines (`_`) on the output.\",\"type\":\"string\"},\"hlsMediaPlaylistVersion\":{\"description\":\"If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version\",\"enum\":[\"3\",\"4\",\"5\",\"6\",\"7\",\"8\"],\"type\":\"string\"},\"hlsMasterPlaylistVersion\":{\"description\":\"If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version\",\"enum\":[\"3\",\"4\",\"5\",\"6\",\"7\",\"8\"],\"type\":\"string\"},\"channelsAttributeForAudio\":{\"description\":\"Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag\",\"enum\":[\"ALWAYS\",\"STANDARD_CONFORM\",\"LEGACY\"],\"type\":\"string\"},\"targetDurationRoundingMode\":{\"description\":\"The rounding applied to target duration.\\nTwo possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer,\\nor UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.\\n\",\"enum\":[\"UPWARD_ROUNDING\",\"NORMAL_ROUNDING\"],\"type\":\"string\"},\"encodingId\":{\"description\":\"The id of the encoding to create a default manifest for\",\"type\":\"string\"},\"version\":{\"description\":\"Currently not in use\",\"enum\":[\"V1\"],\"type\":\"string\"}},\"required\":[\"encodingId\",\"outputs\"]}},\"required\":[\"properties\"]}}}},\"patternProperties\":{\"^(?!.*\\\\b(?:defaultapi)\\\\b)[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"HlsManifest\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"enum\":[\"DASH\",\"HLS\",\"SMOOTH_STREAMING\"],\"type\":\"string\"},\"outputs\":{\"description\":\"The outputs to store the manifest\",\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Current status\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"generatorVersion\":{\"description\":\"The version of the generator used to create the manifest\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"manifestName\":{\"description\":\"The filename of your manifest. If this is not set, the `name` is used as output file name. Either one of `name` or `manifestName` is required. Be aware that spaces will be replaced with underlines (`_`) on the output.\",\"type\":\"string\"},\"hlsMediaPlaylistVersion\":{\"description\":\"If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version\",\"enum\":[\"3\",\"4\",\"5\",\"6\",\"7\",\"8\"],\"type\":\"string\"},\"hlsMasterPlaylistVersion\":{\"description\":\"If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version\",\"enum\":[\"3\",\"4\",\"5\",\"6\",\"7\",\"8\"],\"type\":\"string\"},\"channelsAttributeForAudio\":{\"description\":\"Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag\",\"enum\":[\"ALWAYS\",\"STANDARD_CONFORM\",\"LEGACY\"],\"type\":\"string\"},\"targetDurationRoundingMode\":{\"description\":\"The rounding applied to target duration.\\nTwo possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer,\\nor UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.\\n\",\"enum\":[\"UPWARD_ROUNDING\",\"NORMAL_ROUNDING\"],\"type\":\"string\"}},\"required\":[\"outputs\"]},\"streams\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StreamInfo\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"audio\":{\"description\":\"It MUST match the value of the GROUP-ID attribute of an Audio EXT-X-MEDIA tag elsewhere in the Master Playlist. Either this or `audioGroups` must be set.\",\"type\":\"string\"},\"audioGroups\":{\"type\":\"object\",\"description\":\"HLS Audio Group Configuration. You will want to use this configuration property in case you specify conditions on audio streams. The first matching audio group will be used for the specific variant stream. Either this or `audio` must be set.\",\"properties\":{\"droppingMode\":{\"description\":\"Dropping mode\",\"enum\":[\"STREAM\",\"AUDIO\"],\"type\":\"string\"},\"groups\":{\"description\":\"Audio groups\",\"items\":{\"type\":\"object\",\"title\":\"AudioGroup\",\"properties\":{\"name\":{\"description\":\"Name of the audio group\",\"type\":\"string\"},\"priority\":{\"description\":\"Priority of the audio group\",\"minimum\":0,\"maximum\":100,\"type\":\"integer\"}},\"required\":[\"priority\"]},\"type\":\"array\"}},\"required\":[\"droppingMode\",\"groups\"]},\"video\":{\"description\":\"It MUST match the value of the GROUP-ID attribute of a Video EXT-X-MEDIA tag elsewhere in the Master Playlist\",\"type\":\"string\"},\"subtitles\":{\"description\":\"It MUST match the value of the GROUP-ID attribute of a Subtitles EXT-X-MEDIA tag elsewhere in the Master Playlist\",\"type\":\"string\"},\"closedCaptions\":{\"description\":\"If the value is not 'NONE', it MUST match the value of the GROUP-ID attribute of a Closed Captions EXT-X-MEDIA tag elsewhere in the Playlist\",\"type\":\"string\"},\"encodingId\":{\"description\":\"Id of the encoding.\",\"type\":\"string\"},\"streamId\":{\"description\":\"Id of the stream.\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"drmId\":{\"description\":\"Id of the DRM.\",\"type\":\"string\"},\"segmentPath\":{\"description\":\"Path to segments.\",\"type\":\"string\"},\"uri\":{\"description\":\"The URI of the playlist file.\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment. Default is 0.\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded.\",\"type\":\"integer\"},\"forceFrameRateAttribute\":{\"type\":\"boolean\",\"description\":\"Force the addition of the frame rate attribute to all stream infos.\"},\"forceVideoRangeAttribute\":{\"type\":\"boolean\",\"description\":\"Force the addition of the video-range attribute to all stream infos.\"}},\"required\":[\"encodingId\",\"muxingId\",\"segmentPath\",\"streamId\",\"uri\"]},\"customTags\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CustomTag\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"positionMode\":{\"description\":\"The positioning mode that should be used when inserting the placement opportunity\",\"enum\":[\"KEYFRAME\",\"TIME\",\"SEGMENT\"],\"type\":\"string\"},\"keyframeId\":{\"description\":\"Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.\",\"type\":\"string\"},\"time\":{\"description\":\"Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.\",\"format\":\"double\",\"type\":\"number\"},\"segment\":{\"description\":\"The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.\",\"type\":\"integer\"},\"data\":{\"description\":\"The data to be contained in the custom tag.\",\"type\":\"string\"}},\"required\":[\"data\",\"positionMode\"]}},\"required\":[\"properties\"]}}},\"iframe\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"IFramePlaylist\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"filename\":{\"description\":\"The filename of your I-frame playlist\",\"type\":\"string\"}},\"required\":[\"filename\"]}},\"required\":[\"properties\"]}}}},\"required\":[\"properties\"]}}},\"media\":{\"type\":\"object\",\"properties\":{\"customTags\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"CustomTag\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"positionMode\":{\"description\":\"The positioning mode that should be used when inserting the placement opportunity\",\"enum\":[\"KEYFRAME\",\"TIME\",\"SEGMENT\"],\"type\":\"string\"},\"keyframeId\":{\"description\":\"Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.\",\"type\":\"string\"},\"time\":{\"description\":\"Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.\",\"format\":\"double\",\"type\":\"number\"},\"segment\":{\"description\":\"The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.\",\"type\":\"integer\"},\"data\":{\"description\":\"The data to be contained in the custom tag.\",\"type\":\"string\"}},\"required\":[\"data\",\"positionMode\"]}},\"required\":[\"properties\"]}}},\"video\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"VideoMediaInfo\",\"properties\":{\"groupId\":{\"description\":\"The value is a quoted-string which specifies the group to which the Rendition belongs.\",\"type\":\"string\"},\"language\":{\"description\":\"Primary language in the rendition.\",\"type\":\"string\"},\"assocLanguage\":{\"description\":\"Identifies a language that is associated with the Rendition.\",\"type\":\"string\"},\"name\":{\"description\":\"Human readable description of the rendition.\",\"type\":\"string\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.\"},\"autoselect\":{\"type\":\"boolean\",\"description\":\"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.\"},\"characteristics\":{\"description\":\"Contains Uniform Type Identifiers\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"segmentPath\":{\"description\":\"Path to segments.\",\"type\":\"string\"},\"encodingId\":{\"description\":\"Id of the encoding.\",\"type\":\"string\"},\"streamId\":{\"description\":\"Id of the stream.\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"drmId\":{\"description\":\"Id of the DRM.\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment. Default is 0.\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded.\",\"type\":\"integer\"},\"uri\":{\"description\":\"The URI of the Rendition\",\"type\":\"string\"}},\"required\":[\"uri\",\"encodingId\",\"muxingId\",\"segmentPath\",\"streamId\",\"groupId\"]}},\"required\":[\"properties\"]}}},\"audio\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"AudioMediaInfo\",\"properties\":{\"groupId\":{\"description\":\"The value is a quoted-string which specifies the group to which the Rendition belongs.\",\"type\":\"string\"},\"language\":{\"description\":\"Primary language in the rendition.\",\"type\":\"string\"},\"assocLanguage\":{\"description\":\"Identifies a language that is associated with the Rendition.\",\"type\":\"string\"},\"name\":{\"description\":\"Human readable description of the rendition.\",\"type\":\"string\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.\"},\"autoselect\":{\"type\":\"boolean\",\"description\":\"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.\"},\"characteristics\":{\"description\":\"Contains Uniform Type Identifiers\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"segmentPath\":{\"description\":\"Path to segments.\",\"type\":\"string\"},\"encodingId\":{\"description\":\"Id of the encoding.\",\"type\":\"string\"},\"streamId\":{\"description\":\"Id of the stream.\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"drmId\":{\"description\":\"Id of the DRM.\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment. Default is 0.\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded.\",\"type\":\"integer\"},\"uri\":{\"description\":\"The URI of the Rendition\",\"type\":\"string\"},\"forced\":{\"type\":\"boolean\",\"description\":\"A value of true indicates that the Rendition contains content which is considered essential to play.\"}},\"required\":[\"uri\",\"encodingId\",\"muxingId\",\"segmentPath\",\"streamId\",\"groupId\"]}},\"required\":[\"properties\"]}}},\"subtitles\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SubtitlesMediaInfo\",\"properties\":{\"groupId\":{\"description\":\"The value is a quoted-string which specifies the group to which the Rendition belongs.\",\"type\":\"string\"},\"language\":{\"description\":\"Primary language in the rendition.\",\"type\":\"string\"},\"assocLanguage\":{\"description\":\"Identifies a language that is associated with the Rendition.\",\"type\":\"string\"},\"name\":{\"description\":\"Human readable description of the rendition.\",\"type\":\"string\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.\"},\"autoselect\":{\"type\":\"boolean\",\"description\":\"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.\"},\"characteristics\":{\"description\":\"Contains Uniform Type Identifiers\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"segmentPath\":{\"description\":\"Path to segments.\",\"type\":\"string\"},\"encodingId\":{\"description\":\"Id of the encoding.\",\"type\":\"string\"},\"streamId\":{\"description\":\"Id of the stream.\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"drmId\":{\"description\":\"Id of the DRM.\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment. Default is 0.\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded.\",\"type\":\"integer\"},\"uri\":{\"description\":\"The URI of the Rendition\",\"type\":\"string\"},\"forced\":{\"type\":\"boolean\",\"description\":\"A value of true indicates that the Rendition contains content which is considered essential to play.\"}},\"required\":[\"uri\",\"encodingId\",\"muxingId\",\"segmentPath\",\"streamId\",\"groupId\"]}},\"required\":[\"properties\"]}}},\"vtt\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"VttMediaInfo\",\"properties\":{\"groupId\":{\"description\":\"The value is a quoted-string which specifies the group to which the Rendition belongs.\",\"type\":\"string\"},\"language\":{\"description\":\"Primary language in the rendition.\",\"type\":\"string\"},\"assocLanguage\":{\"description\":\"Identifies a language that is associated with the Rendition.\",\"type\":\"string\"},\"name\":{\"description\":\"Human readable description of the rendition.\",\"type\":\"string\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.\"},\"autoselect\":{\"type\":\"boolean\",\"description\":\"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.\"},\"characteristics\":{\"description\":\"Contains Uniform Type Identifiers\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"vttUrl\":{\"description\":\"The URL of the referenced VTT file\",\"type\":\"string\"},\"uri\":{\"description\":\"The URI of the Rendition\",\"type\":\"string\"},\"forced\":{\"type\":\"boolean\",\"description\":\"A value of true indicates that the Rendition contains content which is considered essential to play.\"}},\"required\":[\"uri\",\"vttUrl\",\"groupId\"]}},\"required\":[\"properties\"]}}},\"closedCaptions\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"ClosedCaptionsMediaInfo\",\"properties\":{\"groupId\":{\"description\":\"The value is a quoted-string which specifies the group to which the Rendition belongs.\",\"type\":\"string\"},\"language\":{\"description\":\"Primary language in the rendition.\",\"type\":\"string\"},\"assocLanguage\":{\"description\":\"Identifies a language that is associated with the Rendition.\",\"type\":\"string\"},\"name\":{\"description\":\"Human readable description of the rendition.\",\"type\":\"string\"},\"isDefault\":{\"type\":\"boolean\",\"description\":\"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.\"},\"autoselect\":{\"type\":\"boolean\",\"description\":\"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.\"},\"characteristics\":{\"description\":\"Contains Uniform Type Identifiers\",\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"segmentPath\":{\"description\":\"Path to segments.\",\"type\":\"string\"},\"encodingId\":{\"description\":\"Id of the encoding.\",\"type\":\"string\"},\"streamId\":{\"description\":\"Id of the stream.\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"drmId\":{\"description\":\"Id of the DRM.\",\"type\":\"string\"},\"startSegmentNumber\":{\"description\":\"Number of the first segment. Default is 0.\",\"type\":\"integer\"},\"endSegmentNumber\":{\"description\":\"Number of the last segment. Default is the last one that was encoded.\",\"type\":\"integer\"},\"instreamId\":{\"description\":\"Specifies a Rendition within the segments in the Media Playlist. (See HLS spec 4.3.4.1. EXT-X-MEDIA INSTREAM-ID)\",\"type\":\"string\"},\"forced\":{\"type\":\"boolean\",\"description\":\"A value of true indicates that the Rendition contains content which is considered essential to play.\"}},\"required\":[\"instreamId\",\"encodingId\",\"muxingId\",\"segmentPath\",\"streamId\",\"groupId\"]}},\"required\":[\"properties\"]}}}}},\"start\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StartManifestRequest\",\"properties\":{\"manifestGenerator\":{\"description\":\"Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions:\\n2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\\n\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}}},\"smooth\":{\"type\":\"object\",\"properties\":{\"defaultapi\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SmoothManifestDefault\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"enum\":[\"DASH\",\"HLS\",\"SMOOTH_STREAMING\"],\"type\":\"string\"},\"outputs\":{\"description\":\"The outputs to store the manifest\",\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Current status\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"generatorVersion\":{\"description\":\"The version of the generator used to create the manifest\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"serverManifestName\":{\"description\":\"Filename of the server manifest\",\"type\":\"string\"},\"clientManifestName\":{\"description\":\"Filename of the client manifest\",\"type\":\"string\"},\"encodingId\":{\"description\":\"The id of the encoding to create a default manifest for\",\"type\":\"string\"},\"version\":{\"description\":\"Currently not in use\",\"enum\":[\"V1\"],\"type\":\"string\"}},\"required\":[\"encodingId\",\"outputs\"]}},\"required\":[\"properties\"]}}}},\"patternProperties\":{\"^(?!.*\\\\b(?:defaultapi)\\\\b)[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SmoothStreamingManifest\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"type\":{\"enum\":[\"DASH\",\"HLS\",\"SMOOTH_STREAMING\"],\"type\":\"string\"},\"outputs\":{\"description\":\"The outputs to store the manifest\",\"items\":{\"type\":\"object\",\"title\":\"EncodingOutput\",\"properties\":{\"outputId\":{\"description\":\"Id of the corresponding output\",\"type\":\"string\"},\"outputPath\":{\"description\":\"Subdirectory where to save the files to\",\"type\":\"string\"},\"acl\":{\"description\":\"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL\",\"items\":{\"type\":\"object\",\"title\":\"AclEntry\",\"properties\":{\"scope\":{\"description\":\"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all\",\"type\":\"string\"},\"permission\":{\"enum\":[\"PUBLIC_READ\",\"PRIVATE\"],\"type\":\"string\"}},\"required\":[\"permission\"]},\"type\":\"array\"}},\"required\":[\"outputId\",\"outputPath\"]},\"type\":\"array\"},\"status\":{\"description\":\"Current status\",\"enum\":[\"CREATED\",\"QUEUED\",\"RUNNING\",\"FINISHED\",\"ERROR\",\"CANCELED\",\"TRANSFER_ERROR\"],\"type\":\"string\"},\"generatorVersion\":{\"description\":\"The version of the generator used to create the manifest\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"},\"serverManifestName\":{\"description\":\"Filename of the server manifest\",\"type\":\"string\"},\"clientManifestName\":{\"description\":\"Filename of the client manifest\",\"type\":\"string\"}},\"required\":[\"outputs\"]},\"representations\":{\"type\":\"object\",\"properties\":{\"mp4\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SmoothStreamingRepresentation\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"encodingId\":{\"description\":\"Id of the encoding\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"mediaFile\":{\"description\":\"The Smooth Streaming ismv or isma file that will be referenced in the manifest.\",\"type\":\"string\"},\"language\":{\"description\":\"Language of the MP4 file\",\"type\":\"string\"},\"trackName\":{\"description\":\"Track where this MP4 shoudl be added\",\"type\":\"string\"},\"priority\":{\"description\":\"Specifies the priority of this representation. In the manifest, representations will appear ordered by descending priority values.\",\"type\":\"integer\"}},\"required\":[\"encodingId\",\"mediaFile\",\"muxingId\"]}},\"required\":[\"properties\"]}}}}},\"contentprotection\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"SmoothManifestContentProtection\",\"properties\":{\"name\":{\"description\":\"Name of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"description\":{\"description\":\"Description of the resource. Can be freely chosen by the user.\",\"type\":\"string\"},\"customData\":{\"type\":\"object\",\"description\":\"User-specific meta data. This can hold anything.\"},\"encodingId\":{\"description\":\"Id of the encoding.\",\"type\":\"string\"},\"muxingId\":{\"description\":\"Id of the muxing.\",\"type\":\"string\"},\"drmId\":{\"description\":\"Id of the drm.\",\"type\":\"string\"}},\"required\":[\"drmId\",\"encodingId\",\"muxingId\"]}},\"required\":[\"properties\"]}}},\"start\":{\"type\":\"object\",\"patternProperties\":{\"^[A-Za-z0-9_-]+$\":{\"type\":\"object\",\"properties\":{\"properties\":{\"type\":\"object\",\"title\":\"StartManifestRequest\",\"properties\":{\"manifestGenerator\":{\"description\":\"Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions:\\n2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\\n\",\"enum\":[\"LEGACY\",\"V2\"],\"type\":\"string\"}}}},\"required\":[\"properties\"]}}}}}}}}}},\"required\":[\"metadata\",\"encodings\"],\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Bitmovin Encoding Template JSON Schema\". Here are the required top‑level fields: metadata, encodings. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://raw.githubusercontent.com/bitmovin/bitmovin-api-sdk-examples/main/bitmovin-encoding-template.json","title":"Bitmovin Encoding Template JSON Schema","description":"An encoding workflow from a single configuration template","properties":{"metaData":{"type":"object","description":"Metadata for the encoding template","properties":{"name":{"description":"Metadata for the encoding template","type":"string"},"type":{"description":"The type of the encoding template","enum":["VOD","LIVE"],"type":"string"}},"required":["name","type"]},"inputs":{"type":"object","properties":{"redundantRtmp":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"RedundantRtmpInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"delayThreshold":{"description":"When there is no input signal present and this threshold in seconds is reached it will switch to another ingest point","type":"integer"},"ingestPoints":{"description":"Configuration for ingest points that use a dynamic IP based endpoint to stream to e.g.: rtmp://41.167.11.21/live\nEither ingestPoints **or** staticIngestPoints can be set\n","items":{"type":"object","title":"RtmpIngestPoint","properties":{"applicationName":{"description":"The name of the application where the ingest is streamed to. This has to be unique for each ingest point","type":"string"},"streamKey":{"description":"The stream key for the backup input","type":"string"}},"required":["applicationName","streamKey"]},"type":"array"},"staticIngestPoints":{"description":"Configuration for static ingest points. These ingest points use a consistent endpoint to stream to e.g.: rtmps://live-ingest.bitmovin.com/live\nEither ingestPoints **or** staticIngestPoints can be set\n","items":{"type":"object","title":"StaticRtmpIngestPoint","properties":{"id":{"description":"The ID of the created static rtmp ingest point\n","type":"string"},"name":{"description":"Name of the ingest point. This can be helpful for easier identifying your ingest points\n","type":"string"},"streamKeyConfiguration":{"type":"object","properties":{"type":{"title":"StreamKeyConfigurationType","enum":["GENERATE","ASSIGN"],"type":"string"},"streamKeyId":{"description":"Id of the previously generated stream key. \nOnly needed when the type is `ASSIGN`.\n","type":"string"}},"required":["type"]}}},"type":"array"}}}},"required":["properties"]}}},"s3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"S3Input","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"cloudRegion":{"description":"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.","enum":["US_EAST_1","US_EAST_2","US_WEST_1","US_WEST_2","EU_WEST_1","EU_CENTRAL_1","AP_SOUTHEAST_1","AP_SOUTHEAST_2","AP_NORTHEAST_1","AP_NORTHEAST_2","AP_SOUTH_1","SA_EAST_1","EU_WEST_2","EU_WEST_3","CA_CENTRAL_1","EU_NORTH_1"],"type":"string"},"bucketName":{"description":"Name of the bucket","type":"string"},"accessKey":{"description":"Amazon access key","type":"string"},"secretKey":{"description":"Amazon secret key","type":"string"}},"required":["accessKey","bucketName","secretKey"]}},"required":["properties"]}}},"s3RoleBased":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"S3RoleBasedInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bucketName":{"description":"Amazon S3 bucket name","type":"string"},"roleArn":{"description":"Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access.\n\nThis role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added\nto the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\n\nwhere \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" is the Bitmovin user used for the access.\nThe `Condition` is optional but we highly recommend it, see property `externalId` below for more information.\n\nThis setup allows Bitmovin assume the provided IAM role and to read data from your S3 bucket. Please note that the IAM role has to have read access on S3.\n\nFor more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume S3 access.\n\nThis ID is provided by the API if `externalIdMode` is set to `GLOBAL` or `GENERATED`. If present, it has to be added to the trust policy of the IAM role `roleArn` configured above, otherwise the API won't be able to read from the S3 bucket. An appropriate trust policy would look like this:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\n\nwhere \"{{externalId}}\" is the generated ID.\n\nThis property is optional but we recommend it as an additional security feature. We will use both the `roleArn` and the `externalId` to access your S3 data.\nIf the Amazon IAM role has an external ID configured but it is not provided in the input configuration Bitmovin won't be able to read from the S3 bucket. Also if the\nexternal ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket.\n\nIf you need to change the external ID that is used by your IAM role, you need to create a new input, and use the external ID provided by the API to update your IAM role.\n\nFor more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"cloudRegion":{"enum":["US_EAST_1","US_EAST_2","US_WEST_1","US_WEST_2","EU_WEST_1","EU_CENTRAL_1","AP_SOUTHEAST_1","AP_SOUTHEAST_2","AP_NORTHEAST_1","AP_NORTHEAST_2","AP_SOUTH_1","SA_EAST_1","EU_WEST_2","EU_WEST_3","CA_CENTRAL_1","EU_NORTH_1"],"type":"string"}},"required":["bucketName","roleArn"]}},"required":["properties"]}}},"genericS3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"GenericS3Input","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bucketName":{"description":"Your generic S3 bucket name","type":"string"},"host":{"description":"The generic S3 server hostname (or IP address)","type":"string"},"port":{"description":"The port on which the generic S3 server is running on (if not provided 8000 will be used)","type":"integer"},"ssl":{"type":"boolean","description":"Controls whether SSL is used or not"},"signingRegion":{"description":"The signing region to use","type":"string"},"signatureVersion":{"description":"Specifies the method used for authentication","enum":["S3_V2","S3_V4"],"type":"string"},"accessKey":{"description":"Your generic S3 access key","type":"string"},"secretKey":{"description":"Your generic S3 secret key","type":"string"},"accessStyle":{"description":"Specifies the URL access style to use","enum":["VIRTUAL_HOSTED","PATH"],"type":"string"}},"required":["accessKey","bucketName","host","secretKey"]}},"required":["properties"]}}},"local":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"LocalInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"path":{"description":"Path to your local storage","type":"string"}},"required":["path"]}},"required":["properties"]}}},"gcs":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"GcsInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bucketName":{"description":"Name of the bucket","type":"string"},"cloudRegion":{"description":"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.","enum":["US_CENTRAL_1","US_EAST_1","ASIA_EAST_1","EUROPE_WEST_1","US_WEST_1","ASIA_EAST_2","ASIA_NORTHEAST_1","ASIA_SOUTH_1","ASIA_SOUTHEAST_1","AUSTRALIA_SOUTHEAST_1","EUROPE_NORTH_1","EUROPE_WEST_2","EUROPE_WEST_3","EUROPE_WEST_4","NORTHAMERICA_NORTHEAST_1","SOUTHAMERICA_EAST_1","US_EAST_4","US_WEST_2","ME_CENTRAL_2"],"type":"string"},"accessKey":{"description":"GCS access key","type":"string"},"secretKey":{"description":"GCS secret key","type":"string"}},"required":["accessKey","bucketName","secretKey"]}},"required":["properties"]}}},"gcsServiceAccount":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"GcsServiceAccountInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"serviceAccountCredentials":{"description":"GCS projectId","type":"string"},"bucketName":{"description":"Name of the bucket","type":"string"},"cloudRegion":{"description":"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.","enum":["US_CENTRAL_1","US_EAST_1","ASIA_EAST_1","EUROPE_WEST_1","US_WEST_1","ASIA_EAST_2","ASIA_NORTHEAST_1","ASIA_SOUTH_1","ASIA_SOUTHEAST_1","AUSTRALIA_SOUTHEAST_1","EUROPE_NORTH_1","EUROPE_WEST_2","EUROPE_WEST_3","EUROPE_WEST_4","NORTHAMERICA_NORTHEAST_1","SOUTHAMERICA_EAST_1","US_EAST_4","US_WEST_2","ME_CENTRAL_2"],"type":"string"}},"required":["bucketName","serviceAccountCredentials"]}},"required":["properties"]}}},"azure":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AzureInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"accountName":{"description":"Azure Account Name","type":"string"},"accountKey":{"description":"Azure Account Key","type":"string"},"container":{"description":"Name of the bucket","type":"string"}},"required":["accountKey","accountName","container"]}},"required":["properties"]}}},"ftp":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FtpInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"host":{"description":"Host URL or IP of the FTP server","type":"string"},"port":{"description":"Port to use, standard for FTP: 21","type":"integer"},"passive":{"type":"boolean","description":"Use passive mode. Default is true."},"username":{"description":"Your FTP Username","type":"string"},"password":{"description":"Your FTP password","type":"string"},"remoteVerificationEnabled":{"type":"boolean","description":"Ensure that connections originate from the declared ftp host. Default is true."}},"required":["host"]}},"required":["properties"]}}},"hls":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HlsInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"url":{"description":"URL of HLS input","type":"string"}}}},"required":["properties"]}}},"sftp":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SftpInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"host":{"description":"Host Url or IP of the SFTP server","type":"string"},"port":{"description":"Port to use, standard for SFTP: 22","type":"integer"},"passive":{"type":"boolean","description":"Use passive mode. Default is true."},"username":{"description":"Your SFTP Username","type":"string"},"password":{"description":"Your SFTP password","type":"string"}},"required":["host"]}},"required":["properties"]}}},"http":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HttpInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"host":{"description":"Host Url or IP of the HTTP server","type":"string"},"username":{"description":"Basic Auth Username, if required","type":"string"},"password":{"description":"Basic Auth Password, if required","type":"string"},"port":{"description":"Custom Port","type":"integer"}},"required":["host"]}},"required":["properties"]}}},"https":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HttpsInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"host":{"description":"Host Url or IP of the HTTP server","type":"string"},"username":{"description":"Basic Auth Username, if required","type":"string"},"password":{"description":"Basic Auth Password, if required","type":"string"},"port":{"description":"Custom Port","type":"integer"}},"required":["host"]}},"required":["properties"]}}},"aspera":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AsperaInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"minBandwidth":{"description":"Minimal download bandwidth. Examples: 100k, 100m, 100g","type":"string"},"maxBandwidth":{"description":"Maximal download bandwidth. Examples: 100k, 100m, 100g","type":"string"},"host":{"description":"Host to use for Aspera transfers","type":"string"},"username":{"description":"Username to log into Aspera host (either password and user must be set or token)","type":"string"},"password":{"description":"corresponding password (either password and user must be set or token)","type":"string"},"token":{"description":"Token used for authentication (either password and user must be set or token)","type":"string"},"sshPort":{"description":"Set the TCP port to be used for fasp session initiation","type":"integer"},"faspPort":{"description":"Set the UDP port to be used by fasp for data transfer","type":"integer"}},"required":["host"]}},"required":["properties"]}}},"akamaiNetstorage":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AkamaiNetStorageInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"host":{"description":"Host to use for Akamai NetStorage transfers","type":"string"},"username":{"description":"Your Akamai NetStorage Username","type":"string"},"password":{"description":"Your Akamai NetStorage password","type":"string"}},"required":["host","password","username"]}},"required":["properties"]}}},"srt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SrtInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"backupSrtInputs":{"items":{"type":"object","title":"SrtInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"mode":{"description":"The SRT mode to use","enum":["LISTENER","CALLER"],"type":"string"},"host":{"description":"The name or IP of the host providing the SRT stream (only used in CALLER mode)","type":"string"},"port":{"description":"The port to connect to or listen on. Has to be one of [2088, 2089, 2090, 2091] when using LISTENER mode.","type":"integer"},"path":{"description":"The path parameter of the SRT stream","type":"string"},"latency":{"description":"The maximum accepted transmission latency in milliseconds (when both parties set different values, the maximum of the two is used for both)","type":"integer"},"passphrase":{"description":"The passphrase used to secure the SRT stream. For AES-128 encryption, you must enter a 16-character passphrase; for AES-256, you must enter a 32-character passphrase","type":"string"},"keyLength":{"description":"The type of AES encryption determines the length of the key (passphrase). AES-128 uses a 16-character (128-bit) passphrase, and AES-256 uses a 32-character (256-bit) passphrase.","type":"integer"}},"required":["mode","port"]},"type":"array"}}}},"required":["properties"]}}},"zixi":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ZixiInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"host":{"type":"string"},"port":{"type":"integer"},"stream":{"type":"string"},"password":{"type":"string"},"latency":{"type":"integer"},"minBitrate":{"type":"integer"},"decryptionType":{"type":"string"},"decryptionKey":{"type":"string"}}}},"required":["properties"]}}},"directFileUpload":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DirectFileUploadInput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."}}}},"required":["properties"]}}}}},"outputs":{"type":"object","properties":{"checkPermissions":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CheckOutputPermissionsRequest","properties":{"path":{"description":"The path on the storage for which permissions should be checked. In AWS S3 terminology, this corresponds to a \"prefix\". To perform the check, an empty test file (WritePermissionTestFile.txt) will be created in this location. Defaults to an empty string, which corresponds to the root directory.","type":"string"}}}},"required":["properties"]}}},"s3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"S3Output","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"bucketName":{"description":"Amazon S3 bucket name","type":"string"},"accessKey":{"description":"Amazon S3 access key","type":"string"},"secretKey":{"description":"Amazon S3 secret key","type":"string"},"md5MetaTag":{"description":"If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.","type":"string"},"cloudRegion":{"description":"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.","enum":["US_EAST_1","US_EAST_2","US_WEST_1","US_WEST_2","EU_WEST_1","EU_CENTRAL_1","AP_SOUTHEAST_1","AP_SOUTHEAST_2","AP_NORTHEAST_1","AP_NORTHEAST_2","AP_SOUTH_1","SA_EAST_1","EU_WEST_2","EU_WEST_3","CA_CENTRAL_1","EU_NORTH_1"],"type":"string"},"signatureVersion":{"description":"Specifies the method used for authentication. Must be set to S3_V2 if the region supports both V2 and V4, but the bucket allows V2 only (see https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)","enum":["S3_V2","S3_V4"],"type":"string"}},"required":["accessKey","bucketName","secretKey"]}},"required":["properties"]}}},"s3RoleBased":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"S3RoleBasedOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"bucketName":{"description":"Amazon S3 bucket name","type":"string"},"roleArn":{"description":"Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access.\n\nThis role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added\nto the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\n\nwhere \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" is the Bitmovin user used for the access.\nThe `Condition` is optional but we highly recommend it, see property `externalId` below for more information.\n\nThis setup allows Bitmovin assume the provided IAM role and to write data to your S3 bucket. Please note that the IAM role has to have write access to S3.\n\nFor more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume S3 access.\n\nThis ID is provided by the API if `externalIdMode` is set to `GLOBAL` or `GENERATED`. If present, it has to be added to the trust policy of the IAM role `roleArn` configured above, otherwise the API won't be able to write to the S3 bucket. An appropriate trust policy would look like this:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\n\nwhere \"{{externalId}}\" is the generated ID.\n\nThis property is optional but we recommend it as an additional security feature. We will use both the `roleArn` and the `externalId` to access your S3 data.\nIf the Amazon IAM role has an external ID configured but it is not provided in the output configuration Bitmovin won't be able to write to the S3 bucket. Also if the\nexternal ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket.\n\nIf you need to change the external ID that is used by your IAM role, you need to create a new output, and use the external ID provided by the API to update your IAM role.\n\nFor more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"md5MetaTag":{"description":"If set a user defined tag (x-amz-meta-) with that key will be used to store the MD5 hash of the file.","type":"string"},"cloudRegion":{"enum":["US_EAST_1","US_EAST_2","US_WEST_1","US_WEST_2","EU_WEST_1","EU_CENTRAL_1","AP_SOUTHEAST_1","AP_SOUTHEAST_2","AP_NORTHEAST_1","AP_NORTHEAST_2","AP_SOUTH_1","SA_EAST_1","EU_WEST_2","EU_WEST_3","CA_CENTRAL_1","EU_NORTH_1"],"type":"string"},"signatureVersion":{"description":"Specifies the method used for authentication","enum":["S3_V2","S3_V4"],"type":"string"}},"required":["bucketName","roleArn"]}},"required":["properties"]}}},"genericS3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"GenericS3Output","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"accessKey":{"description":"Your generic S3 access key","type":"string"},"secretKey":{"description":"Your generic S3 secret key","type":"string"},"bucketName":{"description":"Name of the bucket","type":"string"},"host":{"description":"The Generic S3 server hostname (or IP address)","type":"string"},"port":{"description":"The port on which the Generic S3 server is running on (if not provided 8000 will be used)","type":"integer"},"ssl":{"type":"boolean","description":"Controls whether SSL is used or not"},"signingRegion":{"description":"The signing region to use","type":"string"},"signatureVersion":{"description":"Specifies the method used for authentication","enum":["S3_V2","S3_V4"],"type":"string"},"accessStyle":{"description":"Specifies the URL access style to use","enum":["VIRTUAL_HOSTED","PATH"],"type":"string"}},"required":["accessKey","bucketName","host","secretKey"]}},"required":["properties"]}}},"local":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"LocalOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"path":{"description":"Path to your local storage","type":"string"}},"required":["path"]}},"required":["properties"]}}},"gcs":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"GcsOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"accessKey":{"description":"GCS access key","type":"string"},"secretKey":{"description":"GCS secret key","type":"string"},"bucketName":{"description":"Name of the bucket","type":"string"},"cloudRegion":{"description":"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.","enum":["US_CENTRAL_1","US_EAST_1","ASIA_EAST_1","EUROPE_WEST_1","US_WEST_1","ASIA_EAST_2","ASIA_NORTHEAST_1","ASIA_SOUTH_1","ASIA_SOUTHEAST_1","AUSTRALIA_SOUTHEAST_1","EUROPE_NORTH_1","EUROPE_WEST_2","EUROPE_WEST_3","EUROPE_WEST_4","NORTHAMERICA_NORTHEAST_1","SOUTHAMERICA_EAST_1","US_EAST_4","US_WEST_2","ME_CENTRAL_2"],"type":"string"}},"required":["accessKey","bucketName","secretKey"]}},"required":["properties"]}}},"gcsServiceAccount":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"GcsServiceAccountOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"serviceAccountCredentials":{"description":"GCS projectId","type":"string"},"bucketName":{"description":"Name of the bucket","type":"string"},"cloudRegion":{"description":"The cloud region in which the bucket is located. Is used to determine the ideal location for your encodings automatically.","enum":["US_CENTRAL_1","US_EAST_1","ASIA_EAST_1","EUROPE_WEST_1","US_WEST_1","ASIA_EAST_2","ASIA_NORTHEAST_1","ASIA_SOUTH_1","ASIA_SOUTHEAST_1","AUSTRALIA_SOUTHEAST_1","EUROPE_NORTH_1","EUROPE_WEST_2","EUROPE_WEST_3","EUROPE_WEST_4","NORTHAMERICA_NORTHEAST_1","SOUTHAMERICA_EAST_1","US_EAST_4","US_WEST_2","ME_CENTRAL_2"],"type":"string"}},"required":["bucketName","serviceAccountCredentials"]}},"required":["properties"]}}},"azure":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AzureOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"accountName":{"description":"Azure Account Name","type":"string"},"accountKey":{"description":"Azure Account Key","type":"string"},"container":{"description":"Name of the bucket","type":"string"}},"required":["accountKey","accountName","container"]}},"required":["properties"]}}},"ftp":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FtpOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"host":{"description":"Host URL or IP of the FTP server","type":"string"},"port":{"description":"Port to use, standard for FTP: 21","type":"integer"},"passive":{"type":"boolean","description":"Use passive mode. Default is true."},"username":{"description":"Your FTP Username","type":"string"},"password":{"description":"Your FTP password","type":"string"},"transferVersion":{"description":"Controls which transfer version should be used","enum":["DEFAULT","POOL"],"type":"string"},"maxConcurrentConnections":{"description":"Restrict maximum concurrent connections. Requires at least version 1.1.0.","type":"integer"}},"required":["host"]}},"required":["properties"]}}},"sftp":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SftpOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"host":{"description":"Host Url or IP of the SFTP server","type":"string"},"port":{"description":"Port to use, standard for SFTP: 22","type":"integer"},"passive":{"type":"boolean","description":"Use passive mode. Default is true."},"username":{"description":"Your SFTP Username","type":"string"},"password":{"description":"Your SFTP password","type":"string"},"transferVersion":{"description":"Controls which transfer version should be used","enum":["DEFAULT","POOL"],"type":"string"},"maxConcurrentConnections":{"description":"Restrict maximum concurrent connections. Requires at least version 1.1.0.","type":"integer"}},"required":["host"]}},"required":["properties"]}}},"akamaiMsl":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AkamaiMslOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"streamId":{"description":"The Akamai stream ID","type":"integer"},"eventName":{"description":"The Akamai event name","type":"string"},"streamFormat":{"description":"- DASH: configure the Encoding with fMP4 or CMAF muxings and a DASH manifest.\n- HLS: configure the Encoding with TS muxings and an HLS manifest.\n- CMAF: configure the Encoding with fMP4 or CMAF muxings with both DASH and HLS manifests.\n","enum":["DASH","HLS","CMAF"],"type":"string"},"mslVersion":{"description":"The Akamai MSL Version. Only MSL4 is supported at the moment.","enum":["MSL4"],"type":"string"}},"required":["eventName","mslVersion","streamFormat","streamId"]}},"required":["properties"]}}},"akamaiNetstorage":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AkamaiNetStorageOutput","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"host":{"description":"Host to use for Akamai NetStorage transfers","type":"string"},"username":{"description":"Your Akamai NetStorage Username","type":"string"},"password":{"description":"Your Akamai NetStorage password","type":"string"}},"required":["host","password","username"]}},"required":["properties"]}}},"liveMediaIngest":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"LiveMediaIngestOutput","description":"Live Media and Metadata Ingest Protocol. See https://tools.ietf.org/html/draft-mekuria-mmediaingest-01.","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"acl":{"description":"Deprecation notice: This property does not have any effect and will not be returned by GET endpoints","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"},"publishingPoint":{"description":"URL specifying the publishing point for the output. Can use either http or https.","type":"string"}},"required":["publishingPoint"]}},"required":["properties"]}}}}},"configurations":{"type":"object","properties":{"video":{"type":"object","properties":{"h262":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"H262VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"presetConfiguration":{"description":"Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.","enum":["XDCAM_HD_422"],"type":"string"},"profile":{"description":"When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen.","enum":["MPEG2_422"],"type":"string"},"bframes":{"description":"Amount of b frames.","minimum":0,"maximum":16,"type":"integer"},"maxBitrate":{"description":"Maximum Bitrate","type":"integer"},"minBitrate":{"description":"Minimum Bitrate","type":"integer"},"bufsize":{"description":"Playback device buffer size","type":"integer"},"gopSize":{"description":"Minimum GOP length, the minimum distance between I-frames","type":"integer"},"level":{"description":"Specified set of constraints that indicate a degree of required decoder performance for a profile","enum":["MAIN","HIGH"],"type":"string"},"interlaceMode":{"description":"Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video","enum":["NONE","TOP_FIELD_FIRST","BOTTOM_FIELD_FIRST"],"type":"string"}}}},"required":["properties"]}}},"h264":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"H264VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"presetConfiguration":{"description":"Choose from a set of preset configurations tailored for common use cases. Check out [H264 Presets](https://bitmovin.com/docs/encoding/tutorials/h264-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.","enum":["LIVE_ULTRAHIGH_QUALITY","LIVE_VERYHIGH_QUALITY","LIVE_HIGH_QUALITY","LIVE_STANDARD","LIVE_LOW_LATENCY","LIVE_LOWER_LATENCY","LIVE_VERYLOW_LATENCY","VOD_HIGH_QUALITY","VOD_QUALITY","VOD_STANDARD","VOD_SPEED","VOD_HIGH_SPEED","VOD_VERYHIGH_SPEED","VOD_EXTRAHIGH_SPEED","VOD_SUPERHIGH_SPEED","VOD_ULTRAHIGH_SPEED","VOD_HARDWARE_SHORTFORM"],"type":"string"},"dynamicRangeFormat":{"description":"Automatically configures the H264 Video Codec to be compatible with the given SDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.","enum":["SDR"],"type":"string"},"crf":{"description":"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.","minimum":0,"maximum":51,"format":"double","type":"number"},"profile":{"description":"When setting a profile, all other settings must not exceed the limits which are defined in the profile. Otherwise, a higher profile may be automatically chosen.","enum":["BASELINE","MAIN","HIGH","HIGH422"],"type":"string"},"bframes":{"description":"Amount of b frames","minimum":0,"maximum":16,"type":"integer"},"refFrames":{"description":"Amount of reference frames.","minimum":1,"maximum":16,"type":"integer"},"qpMin":{"description":"Minimum quantization factor","minimum":0,"maximum":69,"type":"integer"},"qpMax":{"description":"Maximum quantization factor","minimum":0,"maximum":69,"type":"integer"},"mvPredictionMode":{"enum":["NONE","SPATIAL","TEMPORAL","AUTO"],"type":"string"},"mvSearchRangeMax":{"description":"Maximum motion vector search range","minimum":16,"maximum":24,"type":"integer"},"cabac":{"type":"boolean","description":"Enable or disable CABAC"},"maxBitrate":{"description":"Maximum Bitrate (bps)","type":"integer"},"minBitrate":{"description":"Minimum Bitrate (bps)","type":"integer"},"bufsize":{"description":"Playback device buffer size (bits)","type":"integer"},"minGop":{"description":"Minimum GOP length, the minimum distance between I-frames","type":"integer"},"maxGop":{"description":"Maximum GOP length, the maximum distance between I-frames","type":"integer"},"openGop":{"type":"boolean","description":"Enable open-gop, allows referencing frames from a previous gop"},"minKeyframeInterval":{"description":"Minimum interval in seconds between key frames","format":"double","type":"number"},"maxKeyframeInterval":{"description":"Maximum interval in seconds between key frames","format":"double","type":"number"},"level":{"description":"If three-pass encoding is used and a level is set for the encoder, the bitrate for some segments may exceed the bitrate limit which is defined by the level.","enum":["1","1b","1.1","1.2","1.3","2","2.1","2.2","3","3.1","3.2","4","4.1","4.2","5","5.1","5.2"],"type":"string"},"bAdaptiveStrategy":{"enum":["NONE","FAST","FULL"],"type":"string"},"motionEstimationMethod":{"enum":["DIA","HEX","UMH"],"type":"string"},"rcLookahead":{"description":"Number of frames for frame-type decision lookahead","minimum":0,"maximum":250,"type":"integer"},"subMe":{"description":"Subpixel motion estimation and mode decision","enum":["FULLPEL","SAD","SATD","QPEL3","QPEL4","QPEL5","RD_IP","RD_ALL","RD_REF_IP","RD_REF_ALL"],"type":"string"},"trellis":{"description":"Enables or disables Trellis quantization. NOTE: This requires cabac","enum":["DISABLED","ENABLED_FINAL_MB","ENABLED_ALL"],"type":"string"},"partitions":{"description":"Partitions to consider. Analyzing more partition options improves quality at the cost of speed.","items":{"type":"string","title":"H264Partition"},"type":"array"},"slices":{"description":"Number of slices per frame.","minimum":1,"maximum":45,"type":"integer"},"interlaceMode":{"description":"Using TOP_FIELD_FIRST or BOTTOM_FIELD_FIRST will output interlaced video","enum":["NONE","TOP_FIELD_FIRST","BOTTOM_FIELD_FIRST"],"type":"string"},"sceneCutThreshold":{"description":"Scene change sensitivity. The higher the value, the more likely an I-frame will be inserted. Set to 0 to disable it which is advised for scenarios where fixed GOP is required, e.g., adaptive streaming outputs like DASH, HLS and Smooth. Having this setting enabled can improve quality for progressive output with an increased internal chunk length (see `internalChunkLength` of muxings).","minimum":0,"maximum":100,"type":"integer"},"nalHrd":{"description":"Signal hypothetical reference decoder (HRD) information (requires bufsize to be set)","enum":["NONE","VBR","CBR"],"type":"string"},"bPyramid":{"description":"Keep some B-frames as references","enum":["NONE","STRICT","NORMAL"],"type":"string"},"cea608708SubtitleConfig":{"type":"object","description":"Defines whether CEA 608/708 subtitles are copied from the input video stream","properties":{"passthroughActivated":{"type":"boolean","description":"If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)"},"passthroughMode":{"enum":["VIDEO_STREAM","CAPTION_STREAM","VIDEO_CAPTION_STREAM"],"type":"string"}}},"deblockAlpha":{"description":"Strength of the in-loop deblocking filter. Higher values deblock more effectively but also soften the image","type":"integer"},"deblockBeta":{"description":"Threshold of the in-loop deblocking filter. Higher values apply deblocking stronger on non flat blocks, lower values on flat blocks","type":"integer"},"adaptiveQuantizationMode":{"description":"Controls the adaptive quantization algorithm","enum":["DISABLED","VARIANCE","AUTO_VARIANCE","AUTO_VARIANCE_DARK_SCENES"],"type":"string"},"adaptiveQuantizationStrength":{"description":"Values greater than 1 reduce blocking and blurring in flat and textured areas. Values less than 1 reduces ringing artifacts at the cost of more banding artifacts. Negative values are not allowed","format":"double","type":"number"},"mixedReferences":{"type":"boolean","description":"Allow references on a per partition basis, rather than per-macroblock basis"},"adaptiveSpatialTransform":{"type":"boolean","description":"Enables adaptive spatial transform (high profile 8x8 transform)"},"fastSkipDetectionPFrames":{"type":"boolean","description":"Enables fast skip detection on P-frames. Disabling this very slightly increases quality but at a large speed loss"},"weightedPredictionBFrames":{"type":"boolean","description":"Enable open-gop, allows referencing frames from a previous gop"},"weightedPredictionPFrames":{"description":"Defines the mode for weighted prediction for P-frames","enum":["DISABLED","SIMPLE","SMART"],"type":"string"},"macroblockTreeRatecontrol":{"type":"boolean","description":"Enable macroblock tree ratecontrol. Macroblock tree rate control tracks how often blocks of the frame are used for prediciting future frames"},"quantizerCurveCompression":{"description":"Ratio between constant bitrate (0.0) and constant quantizer (1.0). Valid range 0.0 - 1.0","format":"double","type":"number"},"psyRateDistortionOptimization":{"description":"Psychovisual Rate Distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP or RD_REF_ALL","format":"double","type":"number"},"psyTrellis":{"description":"Higher values will improve sharpness and detail retention but might come at costs of artifacts. Needs to have trellis enabled","format":"double","type":"number"},"autoLevelSetup":{"description":"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.","enum":["ENABLED","DISABLED"],"type":"string"},"hardwareEncodingMode":{"description":"Hardware encoding mode. Not set means no hardware encoding.","type":"string"}}}},"required":["properties"]}}},"h265":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"H265VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"presetConfiguration":{"description":"Choose from a set of preset configurations tailored for common use cases. Check out [H265 Presets](https://bitmovin.com/docs/encoding/tutorials/h265-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.","enum":["LIVE_ULTRAHIGH_QUALITY","LIVE_VERYHIGH_QUALITY","LIVE_HIGH_QUALITY","LIVE_STANDARD","LIVE_LOW_LATENCY","LIVE_LOWER_LATENCY","LIVE_VERYLOW_LATENCY","VOD_HIGH_QUALITY","VOD_QUALITY","VOD_STANDARD","VOD_SPEED","VOD_HIGH_SPEED","VOD_VERYHIGH_SPEED","VOD_EXTRAHIGH_SPEED","VOD_SUPERHIGH_SPEED","VOD_ULTRAHIGH_SPEED","VOD_HARDWARE_SHORTFORM"],"type":"string"},"dynamicRangeFormat":{"description":"Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.","enum":["DOLBY_VISION","DOLBY_VISION_PROFILE_5","DOLBY_VISION_PROFILE_8_1","HDR10","HLG","SDR"],"type":"string"},"crf":{"description":"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.","minimum":0,"maximum":51,"format":"double","type":"number"},"profile":{"enum":["main","main10"],"type":"string"},"bframes":{"description":"Amount of b frames","minimum":0,"maximum":16,"type":"integer"},"refFrames":{"description":"Amount of reference frames","minimum":0,"maximum":16,"type":"integer"},"qp":{"description":"Quantization factor","minimum":0,"maximum":51,"type":"integer"},"maxBitrate":{"description":"Maximum Bitrate (bps)","type":"integer"},"minBitrate":{"description":"Minimum Bitrate (bps)","type":"integer"},"bufsize":{"description":"Size of the VBV buffer (bits)","type":"integer"},"minGop":{"description":"Minimum GOP length, the minimum distance between I-frames","type":"integer"},"maxGop":{"description":"Maximum GOP length, the maximum distance between I-frames","type":"integer"},"openGop":{"type":"boolean","description":"Enable open-gop, allows referencing frames from a previous gop"},"minKeyframeInterval":{"description":"Minimum interval in seconds between key frames","format":"double","type":"number"},"maxKeyframeInterval":{"description":"Maximum interval in seconds between key frames","format":"double","type":"number"},"level":{"enum":["1","2","2.1","3","3.1","4","4.1","5","5.1","5.2","6","6.1","6.2"],"type":"string"},"rcLookahead":{"description":"Number of frames for slice-type decision lookahead","minimum":1,"maximum":250,"type":"integer"},"bAdapt":{"description":"Set the level of effort in determining B frame placement","enum":["NONE","FAST","FULL"],"type":"string"},"maxCTUSize":{"enum":["16","32","64"],"type":"string"},"tuIntraDepth":{"enum":["1","2","3","4"],"type":"string"},"tuInterDepth":{"enum":["1","2","3","4"],"type":"string"},"motionSearch":{"enum":["DIA","HEX","UMH","STAR","FULL"],"type":"string"},"subMe":{"description":"Set the amount of subpel refinement to perform.","minimum":0,"maximum":7,"type":"integer"},"motionSearchRange":{"description":"Set the Motion search range.","minimum":0,"maximum":32768,"type":"integer"},"weightPredictionOnPSlice":{"type":"boolean","description":"Enable weighted prediction in P slices"},"weightPredictionOnBSlice":{"type":"boolean","description":"Enable weighted prediction in B slices"},"sao":{"type":"boolean","description":"Toggle sample adaptive offset loop filter"},"masterDisplay":{"description":"Set the mastering display color volume SEI info (SMPTE ST 2086). For example `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)` describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)`.","type":"string"},"maxContentLightLevel":{"description":"Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.","type":"integer"},"maxPictureAverageLightLevel":{"description":"Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.","type":"integer"},"hdr":{"type":"boolean","description":"Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel."},"sceneCutThreshold":{"description":"Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.","minimum":0,"type":"integer"},"adaptiveQuantizationMode":{"description":"Controls the adaptive quantization algorithm","enum":["DISABLED","VARIANCE","AUTO_VARIANCE","AUTO_VARIANCE_DARK_SCENES"],"type":"string"},"enableHlgSignaling":{"type":"boolean","description":"Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message."},"videoFormat":{"description":"Specifies the source format of the original analog video prior to digitizing and encoding","enum":["UNDEFINED","COMPONENT","PAL","NTSC","SECAM","MAC"],"type":"string"},"psyRateDistortionOptimization":{"description":"Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD","minimum":0,"maximum":5,"format":"double","type":"number"},"psyRateDistortionOptimizedQuantization":{"description":"Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical","minimum":0,"maximum":50,"format":"double","type":"number"},"enableHrdSignaling":{"type":"boolean","description":"Signal hypothetical reference decoder (HRD) information"},"cutree":{"type":"boolean","description":"Enables the use of lookahead\u2019s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors."},"minCodingUnitSize":{"description":"Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.","enum":["MCU_8x8","MCU_16x16","MCU_32x32"],"type":"string"},"lookaheadSlices":{"description":"Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16","type":"integer"},"limitReferences":{"description":"If enabled, limit references per depth, CU or both.","enum":["DISABLED","DEPTH","CU","DEPTH_AND_CU"],"type":"string"},"rectangularMotionPartitionsAnalysis":{"type":"boolean","description":"Enable analysis of rectangular motion partitions Nx2N and 2NxN."},"asymetricMotionPartitionsAnalysis":{"type":"boolean","description":"Enable analysis of asymmetric motion partitions."},"limitModes":{"type":"boolean","description":"When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when `rectangularMotionPartitionsAnalysis` and/or `asymetricMotionPartitionsAnalysis` are enabled at minimal compression efficiency loss."},"maxMerge":{"description":"Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5","type":"integer"},"earlySkip":{"type":"boolean","description":"Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed."},"recursionSkip":{"type":"boolean","description":"If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion."},"fastSearchForAngularIntraPredictions":{"type":"boolean","description":"Enable faster search method for angular intra predictions."},"evaluationOfIntraModesInBSlices":{"type":"boolean","description":"Enables the evaluation of intra modes in B slices."},"signHide":{"type":"boolean","description":"Hide sign bit of one coefficient per coding tree unit."},"rateDistortionLevelForModeDecision":{"description":"Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4","type":"integer"},"rateDistortionLevelForQuantization":{"description":"Specifies the amount of rate-distortion analysis to use within quantization.","enum":["DISABLED","LEVELS","LEVELS_AND_CODING_GROUPS"],"type":"string"},"qpMin":{"description":"Minimum quantization factor. Valid value range: 0 - 69","minimum":0,"maximum":69,"type":"integer"},"qpMax":{"description":"Maximum quantization factor. Valid value range: 0 - 69","minimum":0,"maximum":69,"type":"integer"},"wavefrontParallelProcessing":{"type":"boolean","description":"The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled."},"slices":{"description":"Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.","type":"integer"},"copyPicture":{"type":"boolean","description":"Copy buffers of input picture in frame. Default is enabled."},"levelHighTier":{"type":"boolean","description":"If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled."},"skipSplitRateDistortionAnalysis":{"type":"boolean","description":"Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled."},"codingUnitLossless":{"type":"boolean","description":"If enabled, consider lossless mode in CU RDO decisions. Default is disabled."},"transformSkip":{"description":"Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.","enum":["NONE","NORMAL","FAST"],"type":"string"},"refineRateDistortionCost":{"type":"boolean","description":"Enable QP based rate distortion refinement. Default is disabled."},"limitTransformUnitDepthRecursion":{"description":"Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.","enum":["DISABLED","LEVEL_1","LEVEL_2","LEVEL_3","LEVEL_4"],"type":"string"},"noiseReductionIntra":{"description":"An integer value, which denotes strength of noise reduction in intra CUs. Default 0.","minimum":0,"maximum":2000,"type":"integer"},"noiseReductionInter":{"description":"An integer value, which denotes strength of noise reduction in inter CUs. Default 0.","minimum":0,"maximum":2000,"type":"integer"},"rateDistortionPenalty":{"description":"Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.","enum":["DISABLED","NORMAL","MAXIMUM"],"type":"string"},"maximumTransformUnitSize":{"description":"Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.","enum":["MTU_4x4","MTU_8x8","MTU_16x16","MTU_32x32"],"type":"string"},"dynamicRateDistortionStrength":{"description":"Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.","minimum":0,"maximum":4,"type":"integer"},"ssimRateDistortionOptimization":{"type":"boolean","description":"It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false."},"temporalMotionVectorPredictors":{"type":"boolean","description":"Enable temporal motion vector predictors in P and B slices. Default true."},"analyzeSourceFramePixels":{"type":"boolean","description":"Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false."},"strongIntraSmoothing":{"type":"boolean","description":"Enable strong intra smoothing for 32x32 intra blocks. Default true."},"constrainedIntraPrediction":{"type":"boolean","description":"When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false."},"scenecutBias":{"description":"This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.","minimum":0,"maximum":100,"format":"double","type":"number"},"allowedRADLBeforeIDR":{"description":"Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - `bframes`. Default 0.","type":"integer"},"gopLookahead":{"description":"Number of frames for GOP boundary decision lookahead. Valid values 0 - `rcLookahead`. Default 0","type":"integer"},"bframeBias":{"description":"Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0","minimum":-90,"maximum":100,"type":"integer"},"forceFlush":{"description":"Force the encoder to flush frames. Default is DISABLED.","enum":["DISABLED","ALL_FRAMES","SLICE_TYPE"],"type":"string"},"adaptiveQuantizationStrength":{"description":"Adjust the strength of the adaptive quantization offsets. Default 1.0.","minimum":0,"maximum":3,"format":"double","type":"number"},"adaptiveQuantizationMotion":{"type":"boolean","description":"Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false."},"quantizationGroupSize":{"description":"Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as `maxCTUSize`.","enum":["QGS_8x8","QGS_16x16","QGS_32x32","QGS_64x64"],"type":"string"},"strictCbr":{"type":"boolean","description":"Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false."},"qpOffsetChromaCb":{"description":"Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0","minimum":-12,"maximum":12,"type":"integer"},"qpOffsetChromaCr":{"description":"Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0","minimum":-12,"maximum":12,"type":"integer"},"ipRatio":{"description":"QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4","format":"double","type":"number"},"pbRatio":{"description":"QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3","format":"double","type":"number"},"quantizerCurveCompressionFactor":{"description":"Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6","minimum":0.5,"maximum":1,"format":"double","type":"number"},"qpStep":{"description":"The maximum single adjustment in QP allowed to rate control. Default 4","type":"integer"},"grainOptimizedRateControl":{"type":"boolean","description":"Enables a specialised ratecontrol algorithm for film grain content. Default false."},"blurQuants":{"description":"Temporally blur quants. Default 0.5","format":"double","type":"number"},"blurComplexity":{"description":"Temporally blur complexity. Default 20.0","format":"double","type":"number"},"saoNonDeblock":{"type":"boolean","description":"Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false."},"limitSao":{"type":"boolean","description":"Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false."},"lowpassDct":{"type":"boolean","description":"Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false."},"cea608708SubtitleConfig":{"type":"object","description":"Defines whether CEA 608/708 subtitles are extracted from the input video stream","properties":{"passthroughActivated":{"type":"boolean","description":"If enabled, CEA 608 an CEA 708 subtitles will be copied from the input video stream to the output video stream. Note: This does not work, if the output framerate is different than the input framerate (except doubling the framerate with deinterlacing per field)"},"passthroughMode":{"enum":["VIDEO_STREAM","CAPTION_STREAM","VIDEO_CAPTION_STREAM"],"type":"string"}}},"autoLevelSetup":{"description":"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.","enum":["ENABLED","DISABLED"],"type":"string"},"hardwareEncodingMode":{"description":"Hardware encoding mode. Not set means no hardware encoding.","type":"string"}}}},"required":["properties"]}}},"h266":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"H266VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"presetConfiguration":{"enum":["LIVE_ULTRAHIGH_QUALITY","LIVE_VERYHIGH_QUALITY","LIVE_HIGH_QUALITY","LIVE_STANDARD","LIVE_LOW_LATENCY","LIVE_LOWER_LATENCY","LIVE_VERYLOW_LATENCY","VOD_HIGH_QUALITY","VOD_QUALITY","VOD_STANDARD","VOD_SPEED","VOD_HIGH_SPEED","VOD_VERYHIGH_SPEED","VOD_EXTRAHIGH_SPEED","VOD_SUPERHIGH_SPEED","VOD_ULTRAHIGH_SPEED","VOD_HARDWARE_SHORTFORM"],"type":"string"},"crf":{"description":"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.","minimum":0,"maximum":51,"format":"double","type":"number"},"maxBitrate":{"description":"Maximum Bitrate","type":"integer"},"minBitrate":{"description":"Minimum Bitrate","type":"integer"}}}},"required":["properties"]}}},"vp8":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Vp8VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"crf":{"description":"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.","minimum":0,"maximum":63,"type":"integer"},"lagInFrames":{"description":"Number of frames to look ahead for alternate reference frame selection.","minimum":0,"maximum":25,"type":"integer"},"maxIntraRate":{"description":"Maximum I-frame bitrate (percentage) 0=unlimited","type":"integer"},"qpMin":{"description":"Minimum quantization factor.","minimum":0,"maximum":63,"type":"integer"},"qpMax":{"description":"Maximum quantization factor.","minimum":0,"maximum":63,"type":"integer"},"rateUndershootPct":{"description":"Datarate undershoot (min) target (percentage).","minimum":0,"maximum":100,"type":"integer"},"rateOvershootPct":{"description":"Datarate overshoot (max) target (percentage).","minimum":0,"maximum":100,"type":"integer"},"noiseSensitivity":{"enum":["OFF","ON_Y_ONLY","ON_YUV","ON_YUV_AGGRESSIVE","ADAPTIVE"],"type":"string"},"sharpness":{"description":"Loop filter sharpness.","minimum":0,"maximum":7,"type":"integer"},"minGop":{"description":"Minimum GOP length, the minimum distance between I-frames.","type":"integer"},"maxGop":{"description":"Maximum GOP length, the maximum distance between I-frames","type":"integer"},"minKeyframeInterval":{"description":"Minimum interval in seconds between key frames","format":"double","type":"number"},"maxKeyframeInterval":{"description":"Maximum interval in seconds between key frames","format":"double","type":"number"},"quality":{"enum":["REALTIME","GOOD","BEST"],"type":"string"},"staticThresh":{"description":"A change threshold on blocks below which they will be skipped by the encoder.","minimum":0,"type":"integer"},"arnrMaxFrames":{"description":"altref noise reduction max frame count.","minimum":0,"maximum":15,"type":"integer"},"arnrStrength":{"description":"altref noise reduction filter strength.","minimum":0,"maximum":6,"type":"integer"},"arnrType":{"enum":["BACKWARD","FORWARD","CENTERED"],"type":"string"}}}},"required":["properties"]}}},"vp9":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Vp9VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"presetConfiguration":{"description":"Choose from a set of preset configurations tailored for common use cases. Check out [VP9 Presets](https://bitmovin.com/docs/encoding/tutorials/vp9-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.","enum":["LIVE_ULTRAHIGH_QUALITY","LIVE_VERYHIGH_QUALITY","LIVE_HIGH_QUALITY","LIVE_STANDARD","LIVE_LOW_LATENCY","LIVE_LOWER_LATENCY","LIVE_VERYLOW_LATENCY","VOD_HIGH_QUALITY","VOD_QUALITY","VOD_STANDARD","VOD_SPEED","VOD_HIGH_SPEED","VOD_VERYHIGH_SPEED","VOD_EXTRAHIGH_SPEED","VOD_SUPERHIGH_SPEED","VOD_ULTRAHIGH_SPEED","VOD_HARDWARE_SHORTFORM"],"type":"string"},"dynamicRangeFormat":{"description":"Automatically configures the VP9 Video Codec to be compatible with the given SDR/HLG format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results.\nExplicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.","enum":["HLG","SDR"],"type":"string"},"crf":{"description":"Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.","minimum":0,"maximum":63,"type":"integer"},"lagInFrames":{"description":"Number of frames to look ahead for alternate reference frame selection.","minimum":0,"maximum":25,"type":"integer"},"errorResiliencyEnabled":{"type":"boolean","description":"Enables error resiliency feature"},"tileColumns":{"description":"Number of tile columns to use, log2. Depending on the encoding width there are limitations on this value. The minimum values are 2 for width >= 1920 and 1 for width >= 1280. The minimum width of each tile is 256 pixels so the maximum values are 0 for width < 256, 1 for width < 512, 2 for width < 1024, 3 for width < 2048, 4 for width < 4096, 5 for width < 8192. If the value is too high or too low it will be overridden.","minimum":0,"maximum":6,"type":"integer"},"tileRows":{"description":"Number of tile rows to use, log2.","minimum":0,"maximum":2,"type":"integer"},"frameParallel":{"type":"boolean","description":"Enable frame parallel decodability features"},"maxIntraRate":{"description":"Maximum I-frame bitrate (percentage) 0=unlimited","type":"integer"},"qpMin":{"description":"Minimum quantization factor.","minimum":0,"maximum":63,"type":"integer"},"qpMax":{"description":"Maximum quantization factor.","minimum":0,"maximum":63,"type":"integer"},"rateUndershootPct":{"description":"Datarate undershoot (min) target (percentage).","minimum":0,"maximum":100,"type":"integer"},"rateOvershootPct":{"description":"Datarate overshoot (max) target (percentage).","minimum":0,"maximum":100,"type":"integer"},"clientBufferSize":{"description":"Client buffer size (ms)","minimum":0,"type":"integer"},"clientInitialBufferSize":{"description":"Client initial buffer size (ms)","minimum":0,"type":"integer"},"biasPct":{"description":"CBR/VBR bias (0=CBR, 100=VBR)","minimum":0,"maximum":100,"type":"integer"},"noiseSensitivity":{"type":"boolean","description":"Enable noise sensitivity on Y channel"},"cpuUsed":{"description":"Controls the tradeoff between compression efficiency and encoding speed. Higher values indicate a faster encoding. The minimum value for width * height >= 1280 * 720 is 2. If the value is too low it will be overridden.","minimum":1,"maximum":8,"type":"integer"},"automaticAltRefFramesEnabled":{"type":"boolean","description":"Enable automatic alternate reference frames (2pass only)"},"targetLevel":{"description":"Target level (255: off, 0: only keep level stats; 10: level 1.0; 11: level 1.1; ... 62: level 6.2)","minimum":0,"maximum":255,"type":"integer"},"rowMultiThreadingEnabled":{"type":"boolean","description":"Enable row based non-deterministic multi-threading"},"sharpness":{"description":"Loop filter sharpness.","minimum":0,"maximum":7,"type":"integer"},"minGop":{"description":"Minimum GOP length, the minimum distance between I-frames.","type":"integer"},"maxGop":{"description":"Maximum GOP length, the maximum distance between I-frames","type":"integer"},"minKeyframeInterval":{"description":"Minimum interval in seconds between key frames","format":"double","type":"number"},"maxKeyframeInterval":{"description":"Maximum interval in seconds between key frames","format":"double","type":"number"},"quality":{"enum":["REALTIME","GOOD","BEST"],"type":"string"},"lossless":{"type":"boolean","description":"Lossless mode"},"staticThresh":{"description":"A change threshold on blocks below which they will be skipped by the encoder.","minimum":0,"type":"integer"},"aqMode":{"enum":["NONE","VARIANCE","COMPLEXITY","CYCLIC"],"type":"string"},"arnrMaxFrames":{"description":"altref noise reduction max frame count.","minimum":0,"maximum":15,"type":"integer"},"arnrStrength":{"description":"altref noise reduction filter strength.","minimum":0,"maximum":6,"type":"integer"},"arnrType":{"enum":["BACKWARD","FORWARD","CENTERED"],"type":"string"},"autoLevelSetup":{"description":"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting rateOvershootPct, or clientBufferSize properties will disable the automatic calculation.","enum":["ENABLED","DISABLED"],"type":"string"}}}},"required":["properties"]}}},"av1":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Av1VideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video in pixels","type":"integer"},"height":{"description":"Height of the encoded video in pixels","type":"integer"},"bitrate":{"description":"Target bitrate for the encoded video in bps. Either bitrate or crf is required.","type":"integer"},"rate":{"description":"Target frame rate of the encoded video. Must be set for live encodings","format":"double","type":"number"},"pixelFormat":{"description":"Describes the color encoding, bit depth, and chroma subsampling of each pixel in the output image.","enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"},"colorConfig":{"type":"object","properties":{"copyChromaLocationFlag":{"type":"boolean","description":"Copy the chroma location setting from the input source"},"copyColorSpaceFlag":{"type":"boolean","description":"Copy the color space setting from the input source"},"copyColorPrimariesFlag":{"type":"boolean","description":"Copy the color primaries setting from the input source"},"copyColorRangeFlag":{"type":"boolean","description":"Copy the color range setting from the input source"},"copyColorTransferFlag":{"type":"boolean","description":"Copy the color transfer setting from the input source"},"chromaLocation":{"description":"The chroma location to be applied","enum":["UNSPECIFIED","LEFT","CENTER","TOPLEFT","TOP","BOTTOMLEFT","BOTTOM"],"type":"string"},"colorSpace":{"description":"The color space to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"colorPrimaries":{"description":"The color primaries to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"colorRange":{"description":"The color range to be applied. If used on a Dolby Vision stream, this value must be set to JPEG.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"colorTransfer":{"description":"The color transfer to be applied. If used on a Dolby Vision stream, this value must be set to UNSPECIFIED.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"},"inputColorSpace":{"description":"Override the color space detected in the input file. If not set the input color space will be automatically detected if possible.","enum":["UNSPECIFIED","RGB","BT709","FCC","BT470BG","SMPTE170M","SMPTE240M","YCGCO","YCOCG","BT2020_NCL","BT2020_CL","SMPTE2085"],"type":"string"},"inputColorRange":{"description":"Override the color range detected in the input file. If not set the input color range will be automatically detected if possible.","enum":["UNSPECIFIED","MPEG","JPEG"],"type":"string"},"inputColorPrimaries":{"description":"Override the color primaries detected in the input file. If not set the input color primaries will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","BT470M","BT470BG","SMPTE170M","SMPTE240M","FILM","BT2020","SMPTE428","SMPTEST428_1","SMPTE431","SMPTE432","JEDEC_P22"],"type":"string"},"inputColorTransfer":{"description":"Override the color transfer detected in the input file. If not set the input color transfer will be automatically detected if possible.","enum":["UNSPECIFIED","BT709","GAMMA22","GAMMA28","SMPTE170M","SMPTE240M","LINEAR","LOG","LOG_SQRT","IEC61966_2_4","BT1361_ECG","IEC61966_2_1","BT2020_10","BT2020_12","SMPTE2084","SMPTE428","ARIB_STD_B67"],"type":"string"}}},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set. If set then displayAspectRatio is not allowed.","type":"integer"},"displayAspectRatio":{"type":"object","description":"Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.","properties":{"numerator":{"description":"The numerator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 16 must be used.","minimum":1,"type":"integer"},"denominator":{"description":"The denominator of the display aspect ratio (DAR). For example for a DAR of 16:9, the value 9 must be used.","minimum":1,"type":"integer"}},"required":["denominator","numerator"]},"encodingMode":{"description":"The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"presetConfiguration":{"description":"Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.","enum":["VOD_QUALITY","VOD_STANDARD","VOD_SPEED"],"type":"string"},"autoLevelSetup":{"description":"Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.","enum":["ENABLED","DISABLED"],"type":"string"},"keyPlacementMode":{"enum":["AUTO","FIXED","DISABLED"],"type":"string"},"adaptiveQuantMode":{"enum":["OFF","VARIANCE","COMPLEXITY","CYCLIC_REFRESH","DELTA_QUANT"],"type":"string"},"lagInFrames":{"description":"Number of frames to look ahead for alternate reference frame selection","minimum":0,"maximum":25,"type":"integer"},"minQ":{"description":"Minimum (best quality) quantizer","type":"integer"},"maxQ":{"description":"Maximum (worst quality) quantizer","type":"integer"},"undershootPct":{"description":"Rate control adaptation undershoot control","minimum":0,"maximum":1000,"type":"integer"},"overshootPct":{"description":"Rate control adaptation overshoot control","minimum":0,"maximum":1000,"type":"integer"},"clientBufferSize":{"description":"Decoder buffer size in milliseconds","type":"integer"},"clientInitialBufferSize":{"description":"Decoder buffer initial size in milliseconds","type":"integer"},"clientOptimalBufferSize":{"description":"Decoder buffer optimal size in milliseconds","type":"integer"},"tileColumns":{"description":"Number of tile columns to use, log2","minimum":0,"maximum":6,"type":"integer"},"tileRows":{"description":"Number of tile rows to use, log2","minimum":0,"maximum":2,"type":"integer"},"isAutomaticAltRefFramesEnabled":{"type":"boolean","description":"Enable automatic set and use alf frames"},"arnrMaxFrames":{"description":"The max number of frames to create arf","type":"integer"},"arnrStrength":{"description":"The filter strength for the arf","type":"integer"},"maxIntraRate":{"description":"Maximum data rate for intra frames, expressed as a percentage of the average per-frame bitrate. Default value 0 meaning unlimited","type":"integer"},"isLossless":{"type":"boolean","description":"Lossless encoding mode"},"isFrameParallel":{"type":"boolean","description":"Enable frame parallel decoding feature"},"sharpness":{"description":"Sharpness","type":"integer"},"isFrameBoostEnabled":{"type":"boolean","description":"Enable quality boost by lowering frame level Q periodically"},"noiseSensitivity":{"type":"boolean","description":"Enable noise sensitivity on Y channel"},"minGfInterval":{"description":"Minimum interval between GF/ARF frames","type":"integer"},"maxGfInterval":{"description":"Maximum interval between GF/ARF frames","type":"integer"},"numTileGroups":{"description":"Maximum number of tile groups","type":"integer"},"mtuSize":{"description":"Maximum number of bytes in a tile group","type":"integer"}}}},"required":["properties"]}}},"mjpeg":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"MjpegVideoConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"Width of the encoded video","type":"integer"},"height":{"description":"Height of the encoded video","type":"integer"},"rate":{"description":"Target frame rate of the encoded video!","format":"double","type":"number"},"qScale":{"description":"The quality scale parameter","type":"integer"},"pixelFormat":{"enum":["YUV410P","YUV411P","YUV420P","YUV422P","YUV440P","YUV444P","YUVJ411P","YUVJ420P","YUVJ422P","YUVJ440P","YUVJ444P","YUV420P10LE","YUV422P10LE","YUV440P10LE","YUV444P10LE","YUV420P12LE","YUV422P12LE","YUV440P12LE","YUV444P12LE","YUV420P10BE","YUV422P10BE","YUV440P10BE","YUV444P10BE","YUV420P12BE","YUV422P12BE","YUV440P12BE","YUV444P12BE"],"type":"string"}},"required":["qScale","rate"]}},"required":["properties"]}}}}},"audio":{"type":"object","properties":{"aac":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AacAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","4.0","5.0_BACK","5.1_BACK","7.1","7.1_WIDE_BACK"],"type":"string"},"cutoffFrequency":{"description":"The highest frequency that will pass the audio encoder. This value is optional.","type":"integer"}},"required":["bitrate"]}},"required":["properties"]}}},"dtsPassthrough":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DtsPassthroughAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."}}}},"required":["properties"]}}},"dts":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DtsAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps. Allowed values are: 255000, 384000, for DTS Express Audio. For DTS Digital Surround only 768000 is allowed.","type":"integer"},"rate":{"description":"Audio sampling rate in Hz. Only 48000 is allowed.","format":"double","type":"number"},"mode":{"description":"There are two DTS modes available: DTS Express Audio (EXPRESS_AUDIO) and DTS Digital Surround (DIGITAL_SURROUND)","enum":["EXPRESS_AUDIO","DIGITAL_SURROUND"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"dtsx":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DtsXAudioConfiguration","description":"The configuration for the DTS:X","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"enum":["160000","192000","224000","256000","288000","320000","384000","448000"],"type":"string"},"rate":{"description":"Audio sampling rate in Hz. Must be 48000","format":"double","type":"number"},"channelLayout":{"enum":["5.1","5.1.4"],"type":"string"},"lkfsValue":{"description":"Loudness relative to full scale (K-weighted).","minimum":-40,"maximum":0,"format":"double","type":"number"},"ottLoudnessMode":{"enum":["DTSX_OTT_LOUDNESS_DETECT","DTSX_OTT_LOUDNESS_INPUT","DTSX_OTT_LOUDNESS_TARGET"],"type":"string"},"syncInterval":{"description":"Specifies the sync interval which ranges from 1 to 10","minimum":1,"maximum":10,"type":"integer"}},"required":["channelLayout","ottLoudnessMode","bitrate"]}},"required":["properties"]}}},"dolbyAtmos":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyAtmosAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps. Allowed values are: 384000, 448000, 576000, 640000, 768000, 1024000","type":"integer"},"rate":{"description":"Audio sampling rate in Hz. Only 48000 is allowed.","format":"double","type":"number"},"loudnessControl":{"type":"object","description":"Settings for loudness control","properties":{"meteringMode":{"description":"Algorithm to be used for measuring loudness. Recommended value is \"ITU_R_BS_1770_4\"","enum":["ITU-R BS.1770-1","ITU-R BS.1770-2","ITU-R BS.1770-3","ITU-R BS.1770-4","Leq (A)"],"type":"string"},"dialogueIntelligence":{"description":"Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating. Must not be \"DISABLED\" for meteringMode \"ITU-R BS.1770-1\" or \"Leq (A)\", otherwise recommended value is \"ENABLED\"","enum":["ENABLED","DISABLED"],"type":"string"},"speechThreshold":{"description":"Specifies the percentage of speech that must be detected in the metered content before using the measured speech loudness as the overall program loudness. Given as an integer percentage between 0 and 100 (0% to 100%). Recommended value is 15","minimum":0,"maximum":100,"type":"integer"}},"required":["dialogueIntelligence","meteringMode","speechThreshold"]}},"required":["loudnessControl","bitrate"]}},"required":["properties"]}}},"heAacV1":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HeAacV1AudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","4.0","5.0_BACK","5.1_BACK","7.1","7.1_WIDE_BACK"],"type":"string"},"signaling":{"description":"Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.","enum":["IMPLICIT","EXPLICIT_SBR","EXPLICIT_HIERARCHICAL"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"heAacV2":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HeAacV2AudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","4.0","5.0_BACK","5.1_BACK","7.1","7.1_WIDE_BACK"],"type":"string"},"signaling":{"description":"Spectral Band Replication (SBR) and Parameteric Stereo (PS) signaling style.","enum":["IMPLICIT","EXPLICIT_SBR","EXPLICIT_PS","EXPLICIT_HIERARCHICAL"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"passthrough":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PassthroughAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."}}}},"required":["properties"]}}},"vorbis":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"VorbisAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","QUAD","2.1","2.2","3.1","4.0","5.1","5.1_BACK"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"opus":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"OpusAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","QUAD","4.1","5.0_BACK","5.1_BACK","6.1","7.1"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"pcm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PcmAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"presetConfiguration":{"description":"Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.","enum":["XDCAM"],"type":"string"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["MONO","STEREO"],"type":"string"},"sampleFormat":{"description":"Sampling format of the audio codec configuration","enum":["S16LE","S24LE","S32LE"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"ac3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Ac3AudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","QUAD","2.1","2.2","3.1","4.0","4.1","5.0","5.0_BACK","5.1","5.1_BACK"],"type":"string"},"cutoffFrequency":{"description":"The highest frequency that will pass the audio encoder. This value is optional.","type":"integer"}},"required":["bitrate"]}},"required":["properties"]}}},"dolbyDigital":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyDigitalAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"bitstreamInfo":{"type":"object","description":"BitstreamInfo defines metadata parameters contained in the Dolby Digital audio bitstream","properties":{"surroundMode":{"description":"This parameter indicates to a decoder whether the two\u2010channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding.\n\nWhen downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: `ENABLED`, Lo/Ro: `DISABLED`).\nWhen transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream.\nWhen transcoding a third-party stereo input to stereo Dolby Digital set the value to `NOT_INDICATED`.\n","enum":["ENABLED","DISABLED","NOT_INDICATED"],"type":"string"},"surroundExMode":{"description":"This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX.\nThis parameter is used only if the encoded audio has two surround channels.\n\nAn amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically.\nThe behavior is similar to that of the `surroundMode` parameter.\n","enum":["ENABLED","DISABLED","NOT_INDICATED"],"type":"string"}}},"channelLayout":{"description":"Channel layout of the audio codec configuration.","enum":["NONE","MONO","STEREO","SURROUND","3.1","BACK_SURROUND","BACK_SURROUND_LFE","QUAD","QUAD_LFE","4.0","4.1","5.0","5.1"],"type":"string"},"downmixing":{"type":"object","properties":{"loRoCenterMixLevel":{"description":"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.","enum":["PLUS_3_DB","PLUS_1_5_DB","ZERO_DB","MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"ltRtCenterMixLevel":{"description":"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.","enum":["PLUS_3_DB","PLUS_1_5_DB","ZERO_DB","MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"loRoSurroundMixLevel":{"description":"The level shift applied to the surround channels when downmixing to one Lo/Ro output.","enum":["MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"ltRtSurroundMixLevel":{"description":"The level shift applied to the surround channels when downmixing to one Lt/Rt output.","enum":["MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"preferredMode":{"enum":["LO_RO","LT_RT","PRO_LOGIC_II"],"type":"string"}}},"evolutionFrameworkControl":{"description":"It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.\n","enum":["ENABLED","DISABLED"],"type":"string"},"loudnessControl":{"type":"object","description":"Settings for loudness control","properties":{"dialnorm":{"description":"Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations dialnorm must not be set.","minimum":-31,"maximum":-1,"type":"integer"},"dialogueIntelligence":{"description":"This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations dialogueIntelligence must not be set.","enum":["ENABLED","DISABLED"],"type":"string"},"mode":{"enum":["PASSTHROUGH","CORRECTION"],"type":"string"},"peakLimit":{"description":"The peak value in dB to use for loudness correction. This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations peakLimit must not be set.","minimum":-8,"maximum":-0.1,"format":"double","type":"number"},"regulationType":{"description":"This is only allowed if the mode is CORRECTION. <table> <tr><th colspan=4 align=\"left\"> Predefined values for each regulation type: </th></tr> <tr><td> Regulation Type </td><td> EBU R128 </td><td> ATSC A/85 Fixed </td><td> ATSC A/85 Agile</td></tr> <tr><td> Limit Mode </td><td> `True Peak` </td><td> `True Peak` </td><td> `True Peak` </td></tr> <tr><td> Correction Mode </td><td> `PCM Normalization` </td><td> `PCM Normalization` </td><td> `Metadata Update` </td></tr> <tr><td> Peak Limit </td><td> `\u20133 dBTP` </td><td> `\u20132 dBTP` </td><td> `N/A` </td></tr> <tr><td> Dialogue Intelligence </td><td> `Off` </td><td> `On` </td><td> `On` </td></tr> <tr><td> Meter Mode </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td></tr> <tr><td> Speech Threshold </td><td> `20` </td><td> `20` </td><td> `20` </td></tr> <tr><td> Dialogue Normalization </td><td> `-23 dB` </td><td> `-24 dB` </td><td> `Set to measured loudness` </td></tr> </table>\n","enum":["EBU_R128","ATSC_A85_FIXED","ATSC_A85_AGILE","MANUAL"],"type":"string"}}},"preprocessing":{"type":"object","properties":{"dynamicRangeCompression":{"type":"object","description":"It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression.\n\nThe values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.\n","properties":{"lineMode":{"description":"Line mode is intended for use in products providing line\u2010level or speaker\u2010level outputs, and is applicable to the widest range of products.\nProducts such as set\u2010top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.","enum":["NONE","FILM_STANDARD","FILM_LIGHT","MUSIC_STANDARD","MUSIC_LIGHT","SPEECH"],"type":"string"},"rfMode":{"description":"RF mode is intended for products such as a low\u2010cost television receivers.","enum":["NONE","FILM_STANDARD","FILM_LIGHT","MUSIC_STANDARD","MUSIC_LIGHT","SPEECH"],"type":"string"}}},"lfeLowPassFilter":{"description":"It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel.\n\nThis is only allowed if the `channelLayout` contains a LFE channel.\n","enum":["ENABLED","DISABLED"],"type":"string"},"ninetyDegreePhaseShift":{"enum":["ENABLED","DISABLED"],"type":"string"},"threeDbAttenuation":{"enum":["ENABLED","DISABLED"],"type":"string"}}}},"required":["loudnessControl","bitrate"]}},"required":["properties"]}}},"dolbyDigitalPlus":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyDigitalPlusAudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"bitstreamInfo":{"type":"object","description":"BitstreamInfo defines metadata parameters contained in the Dolby Digital Plus audio bitstream","properties":{"surroundMode":{"description":"This parameter indicates to a decoder whether the two\u2010channel encoded bitstream contains a Dolby Surround (Lt/Rt) program that requires Dolby Pro Logic decoding.\n\nWhen downmixing to stereo from a multichannel input, set this value according to the type of downmix performed (Lt/Rt: `ENABLED`, Lo/Ro: `DISABLED`).\nWhen transcoding a stereo Dolby Digital, Dolby Digital Plus, or Dolby E input, the value must be passed through from the input bitstream to the output bitstream.\nWhen transcoding a third-party stereo input to stereo Dolby Digital set the value to `NOT_INDICATED`.\n","enum":["ENABLED","DISABLED","NOT_INDICATED"],"type":"string"},"surroundExMode":{"description":"This is used to identify the encoded audio as material encoded in Dolby Digital Surround EX.\nThis parameter is used only if the encoded audio has two surround channels.\n\nAn amplifier or receiver with Dolby Digital Surround EX decoding can use this parameter as a flag to switch the decoding on or off automatically.\nThe behavior is similar to that of the `surroundMode` parameter.\n","enum":["ENABLED","DISABLED","NOT_INDICATED"],"type":"string"}}},"channelLayout":{"description":"Channel layout of the audio codec configuration.","enum":["NONE","MONO","STEREO","SURROUND","3.1","BACK_SURROUND","BACK_SURROUND_LFE","QUAD","QUAD_LFE","4.0","4.1","5.0","5.1"],"type":"string"},"downmixing":{"type":"object","properties":{"loRoCenterMixLevel":{"description":"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lo/Ro output.","enum":["PLUS_3_DB","PLUS_1_5_DB","ZERO_DB","MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"ltRtCenterMixLevel":{"description":"The level shift applied to the C channel when adding to the L and R outputs as a result of downmixing to one Lt/Rt output.","enum":["PLUS_3_DB","PLUS_1_5_DB","ZERO_DB","MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"loRoSurroundMixLevel":{"description":"The level shift applied to the surround channels when downmixing to one Lo/Ro output.","enum":["MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"ltRtSurroundMixLevel":{"description":"The level shift applied to the surround channels when downmixing to one Lt/Rt output.","enum":["MINUS_1_5_DB","MINUS_3_DB","MINUS_4_5_DB","MINUS_6_DB","MINUS_INFINITY_DB"],"type":"string"},"preferredMode":{"enum":["LO_RO","LT_RT","PRO_LOGIC_II"],"type":"string"}}},"evolutionFrameworkControl":{"description":"It provides a framework for signaling new evolution framework applications, such as Intelligent Loudness, in each Dolby codec.\n","enum":["ENABLED","DISABLED"],"type":"string"},"loudnessControl":{"type":"object","description":"Settings for loudness control","properties":{"dialnorm":{"description":"Dialogue Normalization value to be set on the bitstream metadata. Required if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other combinations dialnorm must not be set.","minimum":-31,"maximum":-1,"type":"integer"},"dialogueIntelligence":{"description":"This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other regulationType values dialogueIntelligence must not be set.","enum":["ENABLED","DISABLED"],"type":"string"},"mode":{"enum":["PASSTHROUGH","CORRECTION"],"type":"string"},"peakLimit":{"description":"The peak value in dB to use for loudness correction. This may only be set if the mode is `PASSTHROUGH`, or if the mode is `CORRECTION` and regulationType is `MANUAL`. For all other regulationType values peakLimit must not be set.","minimum":-8,"maximum":-0.1,"format":"double","type":"number"},"regulationType":{"description":"This is only allowed if the mode is CORRECTION. <table> <tr><th colspan=4 align=\"left\"> Predefined values for each regulation type: </th></tr> <tr><td> Regulation Type </td><td> EBU R128 </td><td> ATSC A/85 Fixed </td><td> ATSC A/85 Agile</td></tr> <tr><td> Limit Mode </td><td> `True Peak` </td><td> `True Peak` </td><td> `True Peak` </td></tr> <tr><td> Correction Mode </td><td> `PCM Normalization` </td><td> `PCM Normalization` </td><td> `Metadata Update` </td></tr> <tr><td> Peak Limit </td><td> `\u20133 dBTP` </td><td> `\u20132 dBTP` </td><td> `N/A` </td></tr> <tr><td> Dialogue Intelligence </td><td> `Off` </td><td> `On` </td><td> `On` </td></tr> <tr><td> Meter Mode </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td><td> `ITU-R BS.1770-3` </td></tr> <tr><td> Speech Threshold </td><td> `20` </td><td> `20` </td><td> `20` </td></tr> <tr><td> Dialogue Normalization </td><td> `-23 dB` </td><td> `-24 dB` </td><td> `Set to measured loudness` </td></tr> </table>\n","enum":["EBU_R128","ATSC_A85_FIXED","ATSC_A85_AGILE","MANUAL"],"type":"string"}}},"preprocessing":{"type":"object","properties":{"dynamicRangeCompression":{"type":"object","description":"It indicates a gain change to be applied in the Dolby Digital decoder in order to implement dynamic range compression.\n\nThe values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.\n","properties":{"lineMode":{"description":"Line mode is intended for use in products providing line\u2010level or speaker\u2010level outputs, and is applicable to the widest range of products.\n\nProducts such as set\u2010top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Digital decoders typically use this mode.\n","enum":["NONE","FILM_STANDARD","FILM_LIGHT","MUSIC_STANDARD","MUSIC_LIGHT","SPEECH"],"type":"string"},"rfMode":{"description":"RF mode is intended for products such as a low\u2010cost television receiver.","enum":["NONE","FILM_STANDARD","FILM_LIGHT","MUSIC_STANDARD","MUSIC_LIGHT","SPEECH"],"type":"string"}}},"lfeLowPassFilter":{"description":"It applies a 120 Hz low-pass filter to the low-frequency effects (LFE) channel.\n\nThis is only allowed if the `channelLayout` contains a LFE channel.\n","enum":["ENABLED","DISABLED"],"type":"string"},"ninetyDegreePhaseShift":{"enum":["ENABLED","DISABLED"],"type":"string"},"threeDbAttenuation":{"enum":["ENABLED","DISABLED"],"type":"string"}}}},"required":["loudnessControl","bitrate"]}},"required":["properties"]}}},"eac3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Eac3AudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","QUAD","2.1","2.2","3.1","4.0","4.1","5.0","5.0_BACK","5.1","5.1_BACK"],"type":"string"},"cutoffFrequency":{"description":"The highest frequency that will pass the audio encoder. This value is optional.","type":"integer"}},"required":["bitrate"]}},"required":["properties"]}}},"mp2":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Mp2AudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}},"mp3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Mp3AudioConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"bitrate":{"description":"Target bitrate for the encoded audio in bps","type":"integer"},"rate":{"description":"Audio sampling rate in Hz","format":"double","type":"number"},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO"],"type":"string"}},"required":["bitrate"]}},"required":["properties"]}}}}},"subtitles":{"type":"object","properties":{"dvbSubtitle":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DvbSubtitleConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."}}}},"required":["properties"]}}},"webvtt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WebVttConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"appendOptionalZeroHour":{"type":"boolean","description":"If set to true, the hours section on webvtt timestamp values will explicitely have zeroes instead of being omitted for values where hours = 0."},"ignoreRegion":{"type":"boolean","description":"If set to true, the region information of the resulting webvtt file will be omitted. Defaults to false."},"cueIdentifierPolicy":{"enum":["INCLUDE_IDENTIFIERS","OMIT_IDENTIFIERS"],"type":"string"},"styling":{"type":"object","properties":{"mode":{"enum":["PASSTHROUGH","DROP_STYLING"],"type":"string"}}}}}},"required":["properties"]}}},"imsc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ImscConfiguration","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"styling":{"type":"object","properties":{"mode":{"enum":["PASSTHROUGH","DROP_STYLING"],"type":"string"}}}}}},"required":["properties"]}}}}}}},"filters":{"type":"object","properties":{"conform":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ConformFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"targetFps":{"description":"The FPS the input should be changed to.","format":"double","type":"number"}}}},"required":["properties"]}}},"watermark":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WatermarkFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"image":{"description":"URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF","type":"string"},"left":{"description":"Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.","type":"integer"},"right":{"description":"Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.","type":"integer"},"top":{"description":"Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.","type":"integer"},"bottom":{"description":"Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.","type":"integer"},"unit":{"description":"Specifies if the values of 'left', 'right', 'top' and 'bottom' are interpreted as pixels or as a percentage of the input video's dimensions.","enum":["PIXELS","PERCENTS"],"type":"string"}},"required":["image"]}},"required":["properties"]}}},"audioVolume":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AudioVolumeFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"volume":{"description":"Audio volume value","format":"double","type":"number"},"unit":{"enum":["PERCENT","DB"],"type":"string"},"format":{"enum":["U8","S16","S32","U8P","S16P","S32P","S64","S64P","FLT","FLTP","NONE","DBL","DBLP"],"type":"string"}},"required":["unit","volume"]}},"required":["properties"]}}},"azureSpeechToCaptions":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AzureSpeechToCaptionsFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"azureSpeechToCaptionsSettings":{"type":"object","properties":{"azureSpeechServicesCredentials":{"type":"object","description":"Credential settings to access Azure Speech Services\n","properties":{"subscriptionKey":{"description":"Azure Speech Services resource key\n","type":"string"}},"required":["subscriptionKey"]},"region":{"description":"Azure Speech Services Region Identifier. The list of speech service supported regions can be\nfound at Azure's official documentation.\n","type":"string"},"apiEndpoint":{"description":"Azure Speech Services API endpoint. This information can be found in Azure's Speech resource data.\n","type":"string"},"language":{"description":"Azure Speech to captions supported language (IETF BCP 47 language tag).\nThe list of supported languages can be found at Azure's official documentation.\n","type":"string"},"captionDelay":{"description":"How many MILLISECONDS to delay the display of each caption, to mimic a real-time experience.\nThe minimum value is 0.\n","type":"integer"},"captionRemainTime":{"description":"How many MILLISECONDS a caption should remain on screen if it is not replaced by another.\nThe minimum value is 0.\n","type":"integer"},"captionMaxLineLength":{"description":"The maximum number of characters per line for a caption. \nThe minimum value is 20.\n","type":"integer"},"captionLines":{"description":"The number of lines for a caption.\nThe minimum value is 1.\n","type":"integer"},"profanityOption":{"description":"The profanity filter options are:\n\n- Masked: Replaces letters in profane words with asterisk (*) characters.\n- Raw: Include the profane words verbatim.\n- Removed: Removes profane words.\n","enum":["MASKED","REMOVED","RAW"],"type":"string"}}}},"required":["azureSpeechToCaptionsSettings"]}},"required":["properties"]}}},"enhancedWatermark":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"EnhancedWatermarkFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"image":{"description":"URL of the file to be used as watermark image. Supported image formats: PNG, JPEG, BMP, GIF","type":"string"},"left":{"description":"Distance from the left edge of the input video to the left edge of the watermark image. May not be set if 'right' is set.","format":"double","type":"number"},"right":{"description":"Distance from the right edge of the input video to the right edge of the watermark image . May not be set if 'left' is set.","format":"double","type":"number"},"top":{"description":"Distance from the top edge of the input video to the top edge of the watermark image. May not be set if 'bottom' is set.","format":"double","type":"number"},"bottom":{"description":"Distance from the bottom edge of the input video to the bottom edge of the watermark image. May not be set if 'top' is set.","format":"double","type":"number"},"unit":{"enum":["PIXELS","PERCENTS"],"type":"string"},"opacity":{"description":"Opacity to apply on the watermark image. Valid values are from 0.0 (completely transparent) to 1.0 (not transparent at all)","format":"double","type":"number"},"width":{"description":"Desired width of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it","format":"double","type":"number"},"height":{"description":"Desired height of the watermark image, the unit of the parameter is specified separately by the parameter 'unit'. If both width and height are set the watermark size is fixed. If only one is set the aspect ratio of the image will be used to rescale it","format":"double","type":"number"}},"required":["image"]}},"required":["properties"]}}},"crop":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CropFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"left":{"description":"Amount of pixels that will be cropped of the input video from the left side. Must be zero or a positive value.","type":"integer"},"right":{"description":"Amount of pixels that will be cropped of the input video from the right side. Must be zero or a positive value.","type":"integer"},"top":{"description":"Amount of pixels that will be cropped of the input video from the top. Must be zero or a positive value.","type":"integer"},"bottom":{"description":"Amount of pixels that will be cropped of the input video from the bottom. Must be zero or a positive value.","type":"integer"},"unit":{"enum":["PIXELS","PERCENTS"],"type":"string"}}}},"required":["properties"]}}},"rotate":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"RotateFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"rotation":{"description":"Rotation of the video in degrees. A positive value will rotate the video clockwise and a negative one counter clockwise.","type":"integer"}},"required":["rotation"]}},"required":["properties"]}}},"deinterlace":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DeinterlaceFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"parity":{"enum":["AUTO","TOP_FIELD_FIRST","BOTTOM_FIELD_FIRST"],"type":"string"},"mode":{"enum":["FRAME","FIELD","FRAME_NOSPATIAL","FIELD_NOSPATIAL"],"type":"string"},"frameSelectionMode":{"enum":["ALL","INTERLACED"],"type":"string"},"autoEnable":{"enum":["ALWAYS_ON","META_DATA_BASED","META_DATA_AND_CONTENT_BASED"],"type":"string"}}}},"required":["properties"]}}},"enhancedDeinterlace":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"EnhancedDeinterlaceFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"parity":{"enum":["AUTO","TOP_FIELD_FIRST","BOTTOM_FIELD_FIRST"],"type":"string"},"mode":{"enum":["FRAME","FIELD"],"type":"string"},"autoEnable":{"enum":["ALWAYS_ON","META_DATA_BASED"],"type":"string"}}}},"required":["properties"]}}},"audioMix":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AudioMixFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"channelLayout":{"description":"Channel layout of the audio codec configuration","enum":["NONE","MONO","STEREO","SURROUND","QUAD","OCTAGONAL","HEXAGONAL","STEREO_DOWNMIX","2.1","2.2","3.1","4.0","4.1","5.0","5.1","5.0_BACK","5.1_BACK","6.0","6.0_FRONT","6.1","6.1_BACK","6.1_FRONT","7.0","7.0_FRONT","7.1","7.1_WIDE","7.1_WIDE_BACK"],"type":"string"},"audioMixChannels":{"description":"List of mixed channels that matches the channel layout","items":{"type":"object","title":"AudioMixChannel","properties":{"channelNumber":{"description":"Channel number of this mix (starting with 0)","type":"integer"},"sourceChannels":{"description":"List of source channels to be mixed","items":{"type":"object","title":"SourceChannel","properties":{"gain":{"description":"Gain for this source channel. Default is 1.0.","format":"double","type":"number"},"type":{"enum":["CHANNEL_NUMBER","FRONT_LEFT","FRONT_RIGHT","CENTER","LOW_FREQUENCY","BACK_LEFT","BACK_RIGHT","SURROUND_LEFT","SURROUND_RIGHT"],"type":"string"},"channelNumber":{"description":"Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.","type":"integer"}},"required":["type"]},"type":"array"}},"required":["channelNumber","sourceChannels"]},"type":"array"}},"required":["audioMixChannels","channelLayout"]}},"required":["properties"]}}},"denoiseHqdn3d":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DenoiseHqdn3dFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"lumaSpatial":{"description":"A non-negative floating point number which specifies spatial luma strength. It defaults to 4.0.","format":"double","type":"number"},"chromaSpatial":{"description":"A non-negative floating point number which specifies spatial chroma strength. It defaults to 3.0*luma_spatial/4.0.","format":"double","type":"number"},"lumaTmp":{"description":"A floating point number which specifies luma temporal strength. It defaults to 6.0*luma_spatial/4.0.","format":"double","type":"number"},"chromaTmp":{"description":"A floating point number which specifies chroma temporal strength. It defaults to luma_tmp*chroma_spatial/luma_spatial.","format":"double","type":"number"}}}},"required":["properties"]}}},"ebuR128SinglePass":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"EbuR128SinglePassFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"integratedLoudness":{"description":"Set the targeted integrated loudness value. Range is from '-70.0' to '-5.0'. Default value is '-24.0'. Value is measured in LUFS (Loudness Units, referenced to Full Scale)","format":"double","type":"number"},"loudnessRange":{"description":"Set the targeted loudness range target. Range is from '1.0' to '20.0'. Default value is '7.0'. Loudness range measures the variation of loudness on a macroscopic time-scale in units of LU (Loudness Units). For programmes shorter than 1 minute, the use of the measure Loudness Range is not recommended due to too few data points (Loudness Range is based on the Short-term-Loudness values (3-seconds-window)).","format":"double","type":"number"},"maximumTruePeakLevel":{"description":"Set maximum true peak. Range is from '-9.0' to '0.0'. Default value is '-2.0'. Values are measured in dBTP (db True Peak)","format":"double","type":"number"}}}},"required":["properties"]}}},"text":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"TextFilter","description":"Only one of those properties may be set: fontSize, fontSizeExpression.","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"font":{"enum":["DEJAVUSANS","DEJAVUSERIF","DEJAVUSANSMONO","ROBOTOMONO","ROBOTOBLACK","ROBOTO","ROBOTOCONDENSED"],"type":"string"},"box":{"type":"boolean","description":"If set to true a box is drawn around the text using the background color."},"boxBorderWidth":{"description":"The width of the box drawn around the text.","type":"integer"},"boxColor":{"description":"The background color to be used for drawing the box.","type":"string"},"lineSpacing":{"description":"Line spacing of the border around the box in pixels","type":"integer"},"borderWidth":{"description":"Width of the border around the text","type":"integer"},"fixBounds":{"type":"boolean","description":"If set to true, it will fix text coordinates to avoid clipping if necessary"},"fontColor":{"description":"The color to be used to draw the text","type":"string"},"fontSize":{"description":"Font size to be used to draw the text","type":"integer"},"fontSizeExpression":{"description":"An expression for the Font size. Either fontSize or fontSizeExpression can be set at the same time. The following variables are valid: main_h, h, H for input height and main_w, w, W for the input_width","type":"string"},"alpha":{"description":"If set, alpha blending for the text is applied. Values are valid between 0.0 and 1.0.","format":"double","type":"number"},"shadowColor":{"description":"Color of the shadow","type":"string"},"shadowX":{"description":"X offset of the shadow","type":"integer"},"shadowY":{"description":"Y offset of the shadow","type":"integer"},"timecode":{"description":"If set, the timecode representation in \"hh:mm:ss[:;.]ff\" format will be applied. Drop-frame timecodes (containing \";\" or \".\") must only be used with video frame rates of 29.97, 30, 59.94 or 60 FPS, according to the SMPTE standard","type":"string"},"text":{"description":"String to be drawn","type":"string"},"x":{"description":"X position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width","type":"string"},"y":{"description":"Y position of the text. Also an expression can be used. The following variables are valid: line_h - height of each text line; main_h - input height; main_w - input width; n - number of input frame; text_h - Text height; text_w - Text width","type":"string"},"rate":{"description":"Video frame rate","type":"string"}},"required":["x","y"]}},"required":["properties"]}}},"interlace":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"InterlaceFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"mode":{"enum":["TOP","BOTTOM","DROP_EVEN","DROP_ODD","PAD","INTERLACE_X2","MERGE","MERGE_X2"],"type":"string"},"verticalLowPassFilteringMode":{"enum":["DISABLED","LOW_PASS","COMPLEX"],"type":"string"}}}},"required":["properties"]}}},"unsharp":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"UnsharpFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"lumaMatrixHorizontalSize":{"description":"Must be an odd integer between 3 and 23","type":"integer"},"lumaMatrixVerticalSize":{"description":"Must be an odd integer between 3 and 23","type":"integer"},"lumaEffectStrength":{"description":"Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5","format":"double","type":"number"},"chromaMatrixHorizontalSize":{"description":"Must be an odd integer between 3 and 23","type":"integer"},"chromaMatrixVerticalSize":{"description":"Must be an odd integer between 3 and 23","type":"integer"},"chromaEffectStrength":{"description":"Negative value: blur, positive value: sharpen, floating point number, valid value range: -1.5 - 1.5","format":"double","type":"number"}}}},"required":["properties"]}}},"scale":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ScaleFilter","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"width":{"description":"The width of the output frame in pixels. If not set it will be based on the configured height by maintaining the original aspect ratio. If height is also not set, the original source dimensions will be applied.","type":"integer"},"height":{"description":"The height of the output frame in pixels. If not set it will be based on the configured width by maintaining the original aspect ratio. If width is also not set, the original source dimensions will be applied.","type":"integer"},"scalingAlgorithm":{"enum":["FAST_BILINEAR","BILINEAR","BICUBIC","EXPERIMENTAL","NEAREST_NEIGHBOR","AVERAGING_AREA","BICUBIC_LUMA_BILINEAR_CHROMA","GAUSS","SINC","LANCZOS","SPLINE"],"type":"string"},"sampleAspectRatioNumerator":{"description":"The numerator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioDenominator is set.","type":"integer"},"sampleAspectRatioDenominator":{"description":"The denominator of the sample aspect ratio (also known as pixel aspect ratio). Must be set if sampleAspectRatioNumerator is set.","type":"integer"}}}},"required":["properties"]}}}}},"encodings":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Encoding","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"description":"Type of the encoding","enum":["LIVE","VOD","NONE"],"type":"string"},"cloudRegion":{"enum":["AWS_US_EAST_1","AWS_US_EAST_2","AWS_US_WEST_1","AWS_US_WEST_2","AWS_EU_WEST_1","AWS_EU_CENTRAL_1","AWS_AP_SOUTHEAST_1","AWS_AP_SOUTHEAST_2","AWS_AP_NORTHEAST_1","AWS_AP_NORTHEAST_2","AWS_AP_SOUTH_1","AWS_SA_EAST_1","AWS_EU_WEST_2","AWS_EU_WEST_3","AWS_CA_CENTRAL_1","AWS_EU_NORTH_1","GOOGLE_US_CENTRAL_1","GOOGLE_US_EAST_1","GOOGLE_ASIA_EAST_1","GOOGLE_EUROPE_WEST_1","GOOGLE_US_WEST_1","GOOGLE_ASIA_EAST_2","GOOGLE_ASIA_NORTHEAST_1","GOOGLE_ASIA_SOUTH_1","GOOGLE_ASIA_SOUTHEAST_1","GOOGLE_AUSTRALIA_SOUTHEAST_1","GOOGLE_EUROPE_NORTH_1","GOOGLE_EUROPE_WEST_2","GOOGLE_EUROPE_WEST_3","GOOGLE_EUROPE_WEST_4","GOOGLE_NORTHAMERICA_NORTHEAST_1","GOOGLE_SOUTHAMERICA_EAST_1","GOOGLE_US_EAST_4","GOOGLE_US_WEST_2","GOOGLE_ME_CENTRAL_2","AZURE_ASIA_EAST","AZURE_ASIA_SOUTHEAST","AZURE_AUSTRALIA_EAST","AZURE_AUSTRALIA_SOUTHEAST","AZURE_BRAZIL_SOUTH","AZURE_CANADA_CENTRAL","AZURE_EUROPE_NORTH","AZURE_EUROPE_WEST","AZURE_FRANCE_CENTRAL","AZURE_GERMANY_WESTCENTRAL","AZURE_INDIA_CENTRAL","AZURE_INDIA_SOUTH","AZURE_JAPAN_EAST","AZURE_JAPAN_WEST","AZURE_KOREA_CENTRAL","AZURE_UAE_NORTH","AZURE_US_CENTRAL","AZURE_US_EAST","AZURE_US_EAST2","AZURE_US_WEST","AZURE_US_WEST2","AZURE_US_SOUTH_CENTRAL","AZURE_US_NORTH_CENTRAL","AZURE_UK_SOUTH","AKAMAI_BR_GRU","AKAMAI_ES_MAD","AKAMAI_FR_PAR","AKAMAI_ID_CGK","AKAMAI_IN_MAA","AKAMAI_IT_MIL","AKAMAI_JP_OSA","AKAMAI_NL_AMS","AKAMAI_SE_STO","AKAMAI_US_LAX","AKAMAI_US_MIA","AKAMAI_US_ORD","AKAMAI_US_SEA","OCI_EU_FRANKFURT_1","OCI_US_ASHBURN_1","NORTH_AMERICA","SOUTH_AMERICA","EUROPE","AFRICA","ASIA","AUSTRALIA","AWS","GOOGLE","KUBERNETES","EXTERNAL","AUTO"],"type":"string"},"fallbackCloudRegions":{"description":"Specify a list of regions which are used in case the preferred region is down. Currently there are several restrictions.\n- The region has to be specific or AUTO\n- The region has to be for the same cloud provider as the default one\n- You can only configure at most 3 fallback regions\n","items":{"type":"string","title":"CloudRegion"},"type":"array"},"encoderVersion":{"description":"Version of the encoder","type":"string"},"infrastructureId":{"description":"Define an external infrastructure to run the encoding on. Note If you set this value, the `cloudRegion` must be 'EXTERNAL'.","type":"string"},"infrastructure":{"type":"object","properties":{"infrastructureId":{"description":"Id of a custom infrastructure, e.g., AWS Cloud Connect","type":"string"},"cloudRegion":{"enum":["AWS_US_EAST_1","AWS_US_EAST_2","AWS_US_WEST_1","AWS_US_WEST_2","AWS_EU_WEST_1","AWS_EU_CENTRAL_1","AWS_AP_SOUTHEAST_1","AWS_AP_SOUTHEAST_2","AWS_AP_NORTHEAST_1","AWS_AP_NORTHEAST_2","AWS_AP_SOUTH_1","AWS_SA_EAST_1","AWS_EU_WEST_2","AWS_EU_WEST_3","AWS_CA_CENTRAL_1","AWS_EU_NORTH_1","GOOGLE_US_CENTRAL_1","GOOGLE_US_EAST_1","GOOGLE_ASIA_EAST_1","GOOGLE_EUROPE_WEST_1","GOOGLE_US_WEST_1","GOOGLE_ASIA_EAST_2","GOOGLE_ASIA_NORTHEAST_1","GOOGLE_ASIA_SOUTH_1","GOOGLE_ASIA_SOUTHEAST_1","GOOGLE_AUSTRALIA_SOUTHEAST_1","GOOGLE_EUROPE_NORTH_1","GOOGLE_EUROPE_WEST_2","GOOGLE_EUROPE_WEST_3","GOOGLE_EUROPE_WEST_4","GOOGLE_NORTHAMERICA_NORTHEAST_1","GOOGLE_SOUTHAMERICA_EAST_1","GOOGLE_US_EAST_4","GOOGLE_US_WEST_2","GOOGLE_ME_CENTRAL_2","AZURE_ASIA_EAST","AZURE_ASIA_SOUTHEAST","AZURE_AUSTRALIA_EAST","AZURE_AUSTRALIA_SOUTHEAST","AZURE_BRAZIL_SOUTH","AZURE_CANADA_CENTRAL","AZURE_EUROPE_NORTH","AZURE_EUROPE_WEST","AZURE_FRANCE_CENTRAL","AZURE_GERMANY_WESTCENTRAL","AZURE_INDIA_CENTRAL","AZURE_INDIA_SOUTH","AZURE_JAPAN_EAST","AZURE_JAPAN_WEST","AZURE_KOREA_CENTRAL","AZURE_UAE_NORTH","AZURE_US_CENTRAL","AZURE_US_EAST","AZURE_US_EAST2","AZURE_US_WEST","AZURE_US_WEST2","AZURE_US_SOUTH_CENTRAL","AZURE_US_NORTH_CENTRAL","AZURE_UK_SOUTH","AKAMAI_BR_GRU","AKAMAI_ES_MAD","AKAMAI_FR_PAR","AKAMAI_ID_CGK","AKAMAI_IN_MAA","AKAMAI_IT_MIL","AKAMAI_JP_OSA","AKAMAI_NL_AMS","AKAMAI_SE_STO","AKAMAI_US_LAX","AKAMAI_US_MIA","AKAMAI_US_ORD","AKAMAI_US_SEA","OCI_EU_FRANKFURT_1","OCI_US_ASHBURN_1","NORTH_AMERICA","SOUTH_AMERICA","EUROPE","AFRICA","ASIA","AUSTRALIA","AWS","GOOGLE","KUBERNETES","EXTERNAL","AUTO"],"type":"string"}}},"staticIpId":{"description":"Specify an ID of a Static IP infrastructure resource this encoding should use. A Static IP cannot be used by multiple encodings at once. The encoding will go to an error state if the Static IP is already in use. This is currently only supported for live encodings.","type":"string"},"selectedEncodingMode":{"description":"After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when `encodingMode` was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"selectedCloudRegion":{"description":"After the encoding has been started, this will contain the cloud region that was actually used. This will differ from cloudRegion if cloudRegion was set to an unspecific region (e.g. 'AUTO')","enum":["AWS_US_EAST_1","AWS_US_EAST_2","AWS_US_WEST_1","AWS_US_WEST_2","AWS_EU_WEST_1","AWS_EU_CENTRAL_1","AWS_AP_SOUTHEAST_1","AWS_AP_SOUTHEAST_2","AWS_AP_NORTHEAST_1","AWS_AP_NORTHEAST_2","AWS_AP_SOUTH_1","AWS_SA_EAST_1","AWS_EU_WEST_2","AWS_EU_WEST_3","AWS_CA_CENTRAL_1","AWS_EU_NORTH_1","GOOGLE_US_CENTRAL_1","GOOGLE_US_EAST_1","GOOGLE_ASIA_EAST_1","GOOGLE_EUROPE_WEST_1","GOOGLE_US_WEST_1","GOOGLE_ASIA_EAST_2","GOOGLE_ASIA_NORTHEAST_1","GOOGLE_ASIA_SOUTH_1","GOOGLE_ASIA_SOUTHEAST_1","GOOGLE_AUSTRALIA_SOUTHEAST_1","GOOGLE_EUROPE_NORTH_1","GOOGLE_EUROPE_WEST_2","GOOGLE_EUROPE_WEST_3","GOOGLE_EUROPE_WEST_4","GOOGLE_NORTHAMERICA_NORTHEAST_1","GOOGLE_SOUTHAMERICA_EAST_1","GOOGLE_US_EAST_4","GOOGLE_US_WEST_2","GOOGLE_ME_CENTRAL_2","AZURE_ASIA_EAST","AZURE_ASIA_SOUTHEAST","AZURE_AUSTRALIA_EAST","AZURE_AUSTRALIA_SOUTHEAST","AZURE_BRAZIL_SOUTH","AZURE_CANADA_CENTRAL","AZURE_EUROPE_NORTH","AZURE_EUROPE_WEST","AZURE_FRANCE_CENTRAL","AZURE_GERMANY_WESTCENTRAL","AZURE_INDIA_CENTRAL","AZURE_INDIA_SOUTH","AZURE_JAPAN_EAST","AZURE_JAPAN_WEST","AZURE_KOREA_CENTRAL","AZURE_UAE_NORTH","AZURE_US_CENTRAL","AZURE_US_EAST","AZURE_US_EAST2","AZURE_US_WEST","AZURE_US_WEST2","AZURE_US_SOUTH_CENTRAL","AZURE_US_NORTH_CENTRAL","AZURE_UK_SOUTH","AKAMAI_BR_GRU","AKAMAI_ES_MAD","AKAMAI_FR_PAR","AKAMAI_ID_CGK","AKAMAI_IN_MAA","AKAMAI_IT_MIL","AKAMAI_JP_OSA","AKAMAI_NL_AMS","AKAMAI_SE_STO","AKAMAI_US_LAX","AKAMAI_US_MIA","AKAMAI_US_ORD","AKAMAI_US_SEA","OCI_EU_FRANKFURT_1","OCI_US_ASHBURN_1","NORTH_AMERICA","SOUTH_AMERICA","EUROPE","AFRICA","ASIA","AUSTRALIA","AWS","GOOGLE","KUBERNETES","EXTERNAL","AUTO"],"type":"string"},"status":{"description":"The current status of the encoding.","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"labels":{"description":"You may pass a list of groups associated with this encoding. This will enable you to group results in the statistics resource","items":{"type":"string"},"type":"array"},"liveOptionsType":{"description":"The chosen live option type of the live encoding","enum":["HD"],"type":"string"}}},"streams":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Stream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputStreams":{"description":"Determines the input source(s) for the stream. All video streams of an encoding need to have identical input configurations","items":{"type":"object","title":"StreamInput","properties":{"inputId":{"description":"ID of an Input resource defining the input storage. Required if 'inputStreamId' is not set.","type":"string"},"inputPath":{"description":"Path to an input media file. Required if 'inputStreamId' is not set.","type":"string"},"selectionMode":{"description":"Specifies the strategy for selecting a stream from the input file. Must not be set when 'inputStreamId' is set.","enum":["AUTO","POSITION_ABSOLUTE","VIDEO_RELATIVE","AUDIO_RELATIVE","SUBTITLE_RELATIVE"],"type":"string"},"position":{"description":"Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.","minimum":0,"type":"integer"},"inputStreamId":{"description":"Set this property instead of all others to reference an InputStream resource (e.g. an Ingest-, Trimming- or ConcatenationInputStream)","type":"string"},"analysisDetails":{"type":"object","description":"Input analysis details\n\nThis property is populated after the encoding has finished\n","properties":{"tags":{"type":"object","description":"Additional metadata saved in the input file"}}}}},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"createQualityMetaData":{"type":"boolean","description":"Set true to create quality metadata for this stream"},"codecConfigId":{"description":"Id of the codec configuration","type":"string"},"conditions":{"type":"object","description":"Defines a condition that is evaluated against the input of the Stream. If the condition is not fulfilled, the Stream will be ignored during the encoding process. The 'streamConditionMode' of a Muxing allows to control how ignored Streams affect the Muxing. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored. See [Stream Conditions](https://bitmovin.com/docs/encoding/articles/stream-conditions) for more information"},"mode":{"description":"Mode of the stream","enum":["STANDARD","PER_TITLE_TEMPLATE","PER_TITLE_TEMPLATE_FIXED_RESOLUTION","PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE","PER_TITLE_RESULT"],"type":"string"},"selectedEncodingMode":{"description":"The encoding mode that was used for this stream. This is derived from `encodingMode`, which can be specified in the codec configuration or in the encoding start request. Note that all streams of an encoding need to use the same encoding mode. This will therefore always match `selectedEncodingMode` of the related Encoding resource. Especially useful when `encodingMode` was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"perTitleSettings":{"type":"object","description":"Settings to configure Per-Title on stream level","properties":{"fixedResolutionAndBitrateSettings":{"type":"object","description":"Settings for PER_TITLE_TEMPLATE_FIXED_RESOLUTION_AND_BITRATE mode","properties":{"minBitrate":{"description":"The minimum bitrate that will be used for that template.","type":"integer"},"maxBitrate":{"description":"The maximum bitrate that will be used for that template.","type":"integer"},"bitrateSelectionMode":{"description":"Bitrate selection mode","enum":["OPTIMIZED","COMPLEXITY_RANGE"],"type":"string"},"lowComplexityBoundaryForMaxBitrate":{"description":"Low complexity boundary for max bitrate","type":"integer"},"highComplexityBoundaryForMaxBitrate":{"description":"High complexity boundary for max bitrate","type":"integer"}}},"codecMaxBitrateFactor":{"description":"This factor is used to calculate the maxBitrate of the codec configuration for the generated representation as a multiple of the targetBitrate(generated by Per-Title algorithm). This value will take precedence over the 'codecMaxBitrateFactor' from the pertitleStartConfiguration. This value will only have an impact on streams with h264 or h265 video configurations.","format":"double","type":"number"},"codecBufsizeFactor":{"description":"This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate(generated by Per-Title algorithm). This value will take precedence over the 'codecBufsizeFactor' from the pertitleStartConfiguration.. This value will only have an impact on streams with h264 or h265 video configurations.","format":"double","type":"number"}}},"metadata":{"type":"object","properties":{"language":{"description":"Language of the media contained in the stream. If the value is not set, then no metadata tag is set for the media stream.","type":"string"}}},"decodingErrorMode":{"description":"Determines how to react to errors during decoding","enum":["FAIL_ON_ERROR","DUPLICATE_FRAMES"],"type":"string"},"appliedSettings":{"type":"object","description":"Contains stream properties which may not have been defined in the configuration","properties":{"width":{"description":"The applied width. Useful if the width in the configuration was undefined","type":"integer"},"height":{"description":"The applied height. Useful if the height in the configuration was undefined","type":"integer"}}}},"required":["codecConfigId","inputStreams"]},"filters":{"type":"object","properties":{"properties":{"items":{"type":"object","title":"StreamFilter","properties":{"id":{"description":"The id of the filter that should be used in the stream","type":"string"},"position":{"description":"Defines the order in which filters are applied. Filters are applied in ascending order.","type":"integer"}},"required":["id","position"]},"type":"array"}},"required":["properties"]},"burnInSubtitles":{"type":"object","properties":{"dvbsub":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"BurnInSubtitleDvbSub","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputStreamId":{"description":"Id of an IngestInputStream which specifies the stream of the DVB-SUB subtitles","type":"string"}},"required":["inputStreamId"]}},"required":["properties"]}}},"srt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"BurnInSubtitleSrt","properties":{"id":{"type":"object","description":"Id of the burn-in SRT subtitle"},"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"characterEncoding":{"description":"Character encoding of the SRT file","enum":["ANSI_X3.4-1968","ANSI_X3.4-1986","ARABIC","ARMSCII-8","ASCII","ASMO-708","BIG-5","BIG-FIVE","BIG5","BIG5-HKSCS","BIG5-HKSCS:1999","BIG5-HKSCS:2001","BIG5-HKSCS:2004","BIG5-HKSCS:2008","BIG5HKSCS","BIGFIVE","C99","CHAR","CHINESE","CN","CN-BIG5","CN-GB","CN-GB-ISOIR165","CP1131","CP1133","CP1250","CP1251","CP1252","CP1253","CP1254","CP1255","CP1256","CP1257","CP1258","CP1361","CP154","CP367","CP819","CP850","CP862","CP866","CP874","CP932","CP936","CP949","CP950","CSASCII","CSBIG5","CSEUCKR","CSEUCPKDFMTJAPANESE","CSEUCTW","CSGB2312","CSHALFWIDTHKATAKANA","CSHPROMAN8","CSIBM866","CSISO14JISC6220RO","CSISO159JISX02121990","CSISO2022CN","CSISO2022JP","CSISO2022JP2","CSISO2022KR","CSISO57GB1988","CSISO58GB231280","CSISO87JISX0208","CSISOLATIN1","CSISOLATIN2","CSISOLATIN3","CSISOLATIN4","CSISOLATIN5","CSISOLATIN6","CSISOLATINARABIC","CSISOLATINCYRILLIC","CSISOLATINGREEK","CSISOLATINHEBREW","CSKOI8R","CSKSC56011987","CSKZ1048","CSMACINTOSH","CSPC850MULTILINGUAL","CSPC862LATINHEBREW","CSPTCP154","CSSHIFTJIS","CSUCS4","CSUNICODE","CSUNICODE11","CSUNICODE11UTF7","CSVISCII","CYRILLIC","CYRILLIC-ASIAN","ECMA-114","ECMA-118","ELOT_928","EUC-CN","EUC-JP","EUC-KR","EUC-TW","EUCCN","EUCJP","EUCKR","EUCTW","EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE","GB_1988-80","GB_2312-80","GB18030","GB2312","GBK","GEORGIAN-ACADEMY","GEORGIAN-PS","GREEK","GREEK8","HEBREW","HP-ROMAN8","HZ","HZ-GB-2312","IBM-CP1133","IBM367","IBM819","IBM850","IBM862","IBM866","ISO-10646-UCS-2","ISO-10646-UCS-4","ISO-2022-CN","ISO-2022-CN-EXT","ISO-2022-JP","ISO-2022-JP-1","ISO-2022-JP-2","ISO-2022-KR","ISO-8859-1","ISO-8859-10","ISO-8859-11","ISO-8859-13","ISO-8859-14","ISO-8859-15","ISO-8859-16","ISO-8859-2","ISO-8859-3","ISO-8859-4","ISO-8859-5","ISO-8859-6","ISO-8859-7","ISO-8859-8","ISO-8859-9","ISO-CELTIC","ISO-IR-100","ISO-IR-101","ISO-IR-109","ISO-IR-110","ISO-IR-126","ISO-IR-127","ISO-IR-138","ISO-IR-14","ISO-IR-144","ISO-IR-148","ISO-IR-149","ISO-IR-157","ISO-IR-159","ISO-IR-165","ISO-IR-166","ISO-IR-179","ISO-IR-199","ISO-IR-203","ISO-IR-226","ISO-IR-57","ISO-IR-58","ISO-IR-6","ISO-IR-87","ISO_646.IRV:1991","ISO_8859-1:1987","ISO_8859-10:1992","ISO_8859-14:1998","ISO_8859-15:1998","ISO_8859-16:2001","ISO_8859-2:1987","ISO_8859-3:1988","ISO_8859-4:1988","ISO_8859-5:1988","ISO_8859-6:1987","ISO_8859-7:1987","ISO_8859-7:2003","ISO_8859-8:1988","ISO_8859-9:1989","ISO646-CN","ISO646-JP","ISO646-US","ISO8859-1","ISO8859-10","ISO8859-11","ISO8859-13","ISO8859-14","ISO8859-15","ISO8859-16","ISO8859-2","ISO8859-3","ISO8859-4","ISO8859-5","ISO8859-6","ISO8859-7","ISO8859-8","ISO8859-9","JAVA","JIS_C6220-1969-RO","JIS_C6226-1983","JIS_X0201","JIS_X0208","JIS_X0208-1983","JIS_X0208-1990","JIS_X0212","JIS_X0212-1990","JIS_X0212.1990-0","JIS0208","JISX0201-1976","JOHAB","JP","KOI8-R","KOI8-RU","KOI8-T","KOI8-U","KOREAN","KS_C_5601-1987","KS_C_5601-1989","KSC_5601","KZ-1048","L1","L10","L2","L3","L4","L5","L6","L7","L8","LATIN-9","LATIN1","LATIN10","LATIN2","LATIN3","LATIN4","LATIN5","LATIN6","LATIN7","LATIN8","MAC","MACARABIC","MACCENTRALEUROPE","MACCROATIAN","MACCYRILLIC","MACGREEK","MACHEBREW","MACICELAND","MACINTOSH","MACROMAN","MACROMANIA","MACTHAI","MACTURKISH","MACUKRAINE","MS-ANSI","MS-ARAB","MS-CYRL","MS-EE","MS-GREEK","MS-HEBR","MS-TURK","MS_KANJI","MS936","MULELAO-1","NEXTSTEP","PT154","PTCP154","R8","RK1048","ROMAN8","SHIFT-JIS","SJIS","STRK1048-2002","TCVN","TCVN-5712","TCVN5712-1","TCVN5712-1:1993","TIS-620","TIS620","TIS620-0","TIS620.2529-1","TIS620.2533-0","TIS620.2533-1","UCS-2","UCS-2-INTERNAL","UCS-2-SWAPPED","UCS-2BE","UCS-2LE","UCS-4","UCS-4-INTERNAL","UCS-4-SWAPPED","UCS-4BE","UCS-4LE","UHC","UNICODE-1-1","UNICODE-1-1-UTF-7","UNICODEBIG","UNICODELITTLE","US","US-ASCII","UTF-16","UTF-16BE","UTF-16LE","UTF-32","UTF-32BE","UTF-32LE","UTF-7","UTF-8","VISCII","VISCII1.1-1","WCHAR_T","WINBALTRIM","WINDOWS-1250","WINDOWS-1251","WINDOWS-1252","WINDOWS-1253","WINDOWS-1254","WINDOWS-1255","WINDOWS-1256","WINDOWS-1257","WINDOWS-1258","WINDOWS-874","WINDOWS-936","X0201","X0208","X0212"],"type":"string"},"input":{"type":"object","description":"The input location to get the SRT file from","properties":{"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"}},"required":["inputId","inputPath"]}},"required":["characterEncoding","id","input"]}},"required":["properties"]}}},"assa":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"BurnInSubtitleAssa","properties":{"id":{"type":"object","description":"Id of the burn-in ASSA subtitle"},"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"characterEncoding":{"description":"Character encoding of the ASSA file","enum":["ANSI_X3.4-1968","ANSI_X3.4-1986","ARABIC","ARMSCII-8","ASCII","ASMO-708","BIG-5","BIG-FIVE","BIG5","BIG5-HKSCS","BIG5-HKSCS:1999","BIG5-HKSCS:2001","BIG5-HKSCS:2004","BIG5-HKSCS:2008","BIG5HKSCS","BIGFIVE","C99","CHAR","CHINESE","CN","CN-BIG5","CN-GB","CN-GB-ISOIR165","CP1131","CP1133","CP1250","CP1251","CP1252","CP1253","CP1254","CP1255","CP1256","CP1257","CP1258","CP1361","CP154","CP367","CP819","CP850","CP862","CP866","CP874","CP932","CP936","CP949","CP950","CSASCII","CSBIG5","CSEUCKR","CSEUCPKDFMTJAPANESE","CSEUCTW","CSGB2312","CSHALFWIDTHKATAKANA","CSHPROMAN8","CSIBM866","CSISO14JISC6220RO","CSISO159JISX02121990","CSISO2022CN","CSISO2022JP","CSISO2022JP2","CSISO2022KR","CSISO57GB1988","CSISO58GB231280","CSISO87JISX0208","CSISOLATIN1","CSISOLATIN2","CSISOLATIN3","CSISOLATIN4","CSISOLATIN5","CSISOLATIN6","CSISOLATINARABIC","CSISOLATINCYRILLIC","CSISOLATINGREEK","CSISOLATINHEBREW","CSKOI8R","CSKSC56011987","CSKZ1048","CSMACINTOSH","CSPC850MULTILINGUAL","CSPC862LATINHEBREW","CSPTCP154","CSSHIFTJIS","CSUCS4","CSUNICODE","CSUNICODE11","CSUNICODE11UTF7","CSVISCII","CYRILLIC","CYRILLIC-ASIAN","ECMA-114","ECMA-118","ELOT_928","EUC-CN","EUC-JP","EUC-KR","EUC-TW","EUCCN","EUCJP","EUCKR","EUCTW","EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE","GB_1988-80","GB_2312-80","GB18030","GB2312","GBK","GEORGIAN-ACADEMY","GEORGIAN-PS","GREEK","GREEK8","HEBREW","HP-ROMAN8","HZ","HZ-GB-2312","IBM-CP1133","IBM367","IBM819","IBM850","IBM862","IBM866","ISO-10646-UCS-2","ISO-10646-UCS-4","ISO-2022-CN","ISO-2022-CN-EXT","ISO-2022-JP","ISO-2022-JP-1","ISO-2022-JP-2","ISO-2022-KR","ISO-8859-1","ISO-8859-10","ISO-8859-11","ISO-8859-13","ISO-8859-14","ISO-8859-15","ISO-8859-16","ISO-8859-2","ISO-8859-3","ISO-8859-4","ISO-8859-5","ISO-8859-6","ISO-8859-7","ISO-8859-8","ISO-8859-9","ISO-CELTIC","ISO-IR-100","ISO-IR-101","ISO-IR-109","ISO-IR-110","ISO-IR-126","ISO-IR-127","ISO-IR-138","ISO-IR-14","ISO-IR-144","ISO-IR-148","ISO-IR-149","ISO-IR-157","ISO-IR-159","ISO-IR-165","ISO-IR-166","ISO-IR-179","ISO-IR-199","ISO-IR-203","ISO-IR-226","ISO-IR-57","ISO-IR-58","ISO-IR-6","ISO-IR-87","ISO_646.IRV:1991","ISO_8859-1:1987","ISO_8859-10:1992","ISO_8859-14:1998","ISO_8859-15:1998","ISO_8859-16:2001","ISO_8859-2:1987","ISO_8859-3:1988","ISO_8859-4:1988","ISO_8859-5:1988","ISO_8859-6:1987","ISO_8859-7:1987","ISO_8859-7:2003","ISO_8859-8:1988","ISO_8859-9:1989","ISO646-CN","ISO646-JP","ISO646-US","ISO8859-1","ISO8859-10","ISO8859-11","ISO8859-13","ISO8859-14","ISO8859-15","ISO8859-16","ISO8859-2","ISO8859-3","ISO8859-4","ISO8859-5","ISO8859-6","ISO8859-7","ISO8859-8","ISO8859-9","JAVA","JIS_C6220-1969-RO","JIS_C6226-1983","JIS_X0201","JIS_X0208","JIS_X0208-1983","JIS_X0208-1990","JIS_X0212","JIS_X0212-1990","JIS_X0212.1990-0","JIS0208","JISX0201-1976","JOHAB","JP","KOI8-R","KOI8-RU","KOI8-T","KOI8-U","KOREAN","KS_C_5601-1987","KS_C_5601-1989","KSC_5601","KZ-1048","L1","L10","L2","L3","L4","L5","L6","L7","L8","LATIN-9","LATIN1","LATIN10","LATIN2","LATIN3","LATIN4","LATIN5","LATIN6","LATIN7","LATIN8","MAC","MACARABIC","MACCENTRALEUROPE","MACCROATIAN","MACCYRILLIC","MACGREEK","MACHEBREW","MACICELAND","MACINTOSH","MACROMAN","MACROMANIA","MACTHAI","MACTURKISH","MACUKRAINE","MS-ANSI","MS-ARAB","MS-CYRL","MS-EE","MS-GREEK","MS-HEBR","MS-TURK","MS_KANJI","MS936","MULELAO-1","NEXTSTEP","PT154","PTCP154","R8","RK1048","ROMAN8","SHIFT-JIS","SJIS","STRK1048-2002","TCVN","TCVN-5712","TCVN5712-1","TCVN5712-1:1993","TIS-620","TIS620","TIS620-0","TIS620.2529-1","TIS620.2533-0","TIS620.2533-1","UCS-2","UCS-2-INTERNAL","UCS-2-SWAPPED","UCS-2BE","UCS-2LE","UCS-4","UCS-4-INTERNAL","UCS-4-SWAPPED","UCS-4BE","UCS-4LE","UHC","UNICODE-1-1","UNICODE-1-1-UTF-7","UNICODEBIG","UNICODELITTLE","US","US-ASCII","UTF-16","UTF-16BE","UTF-16LE","UTF-32","UTF-32BE","UTF-32LE","UTF-7","UTF-8","VISCII","VISCII1.1-1","WCHAR_T","WINBALTRIM","WINDOWS-1250","WINDOWS-1251","WINDOWS-1252","WINDOWS-1253","WINDOWS-1254","WINDOWS-1255","WINDOWS-1256","WINDOWS-1257","WINDOWS-1258","WINDOWS-874","WINDOWS-936","X0201","X0208","X0212"],"type":"string"},"input":{"type":"object","description":"The input location to get the ASSA file from","properties":{"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"}},"required":["inputId","inputPath"]}},"required":["characterEncoding","id","input"]}},"required":["properties"]}}}}},"watermarking":{"type":"object","properties":{"nexguardFileMarker":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"NexGuardFileMarker","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"license":{"description":"Use the base64 license string that Nagra provides you.","type":"string"},"watermarkType":{"description":"The type of watermarking to be used: * `OTT` - A/B watermarking (for video streams only) * `DUPLICATED` - Stream duplication to match A/B video streams in CDN delivery (for audio streams only)\n","enum":["OTT","DUPLICATED"],"type":"string"},"payload":{"description":"Specify the payload ID that you want to be associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. For PreRelease Content (NGPR), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of th ID. Neither Nagra nor Bitmovin keep track of this for you.","type":"integer"},"preset":{"description":"Enter one of the watermarking preset strings that Nagra provides you.","type":"string"},"strength":{"description":"Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.","enum":["LIGHTEST","LIGHTER","DEFAULT","STRONGER","STRONGEST"],"type":"string"}},"required":["license"]}},"required":["properties"]}}}}},"decodingConfigurations":{"type":"object","properties":{"watermarking":{"type":"object","properties":{"audio":{"type":"object","properties":{"nielsen":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DecodingConfigurationWatermarkingAudioNielsen","properties":{"id":{"type":"object","description":"ID of the Nielsen Audio Watermarking decoding-configuration"},"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"distributorId":{"type":"object","description":"The Distributor ID identifies the end-user of the transcoder, i.e. the final distributor of the media content. It is recommended to set this value to DNS domain name of your company or entity. The Distributor ID string should be less than or equal to 48 characters. If a longer value is provided it will be truncated at the 48th character."}},"required":["distributorId","id"]}},"required":["properties"]}}}}}}}}},"captions":{"type":"object","properties":{"cea":{"type":"object","properties":{"scc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SccCaption","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"input":{"type":"object","description":"Input location of the SCC file","properties":{"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"}},"required":["inputId","inputPath"]},"smpteTimecodeFlavor":{"description":"Flavor of SMPTE timecodes in the SCC file (drop-frame or non-drop)","enum":["AUTO","NON_DROP_FRAME","DROP_FRAME"],"type":"string"}},"required":["input"]}},"required":["properties"]}}},"srt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SrtToCea608708Caption","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"input":{"type":"object","description":"Input location of the SRT file","properties":{"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"}},"required":["inputId","inputPath"]},"ccChannel":{"description":"The channel number to embed the CEA subtitles in","enum":["CC1","CC3"],"type":"string"},"characterEncoding":{"description":"Character encoding of the input SRT file","enum":["ANSI_X3.4-1968","ANSI_X3.4-1986","ARABIC","ARMSCII-8","ASCII","ASMO-708","BIG-5","BIG-FIVE","BIG5","BIG5-HKSCS","BIG5-HKSCS:1999","BIG5-HKSCS:2001","BIG5-HKSCS:2004","BIG5-HKSCS:2008","BIG5HKSCS","BIGFIVE","C99","CHAR","CHINESE","CN","CN-BIG5","CN-GB","CN-GB-ISOIR165","CP1131","CP1133","CP1250","CP1251","CP1252","CP1253","CP1254","CP1255","CP1256","CP1257","CP1258","CP1361","CP154","CP367","CP819","CP850","CP862","CP866","CP874","CP932","CP936","CP949","CP950","CSASCII","CSBIG5","CSEUCKR","CSEUCPKDFMTJAPANESE","CSEUCTW","CSGB2312","CSHALFWIDTHKATAKANA","CSHPROMAN8","CSIBM866","CSISO14JISC6220RO","CSISO159JISX02121990","CSISO2022CN","CSISO2022JP","CSISO2022JP2","CSISO2022KR","CSISO57GB1988","CSISO58GB231280","CSISO87JISX0208","CSISOLATIN1","CSISOLATIN2","CSISOLATIN3","CSISOLATIN4","CSISOLATIN5","CSISOLATIN6","CSISOLATINARABIC","CSISOLATINCYRILLIC","CSISOLATINGREEK","CSISOLATINHEBREW","CSKOI8R","CSKSC56011987","CSKZ1048","CSMACINTOSH","CSPC850MULTILINGUAL","CSPC862LATINHEBREW","CSPTCP154","CSSHIFTJIS","CSUCS4","CSUNICODE","CSUNICODE11","CSUNICODE11UTF7","CSVISCII","CYRILLIC","CYRILLIC-ASIAN","ECMA-114","ECMA-118","ELOT_928","EUC-CN","EUC-JP","EUC-KR","EUC-TW","EUCCN","EUCJP","EUCKR","EUCTW","EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE","GB_1988-80","GB_2312-80","GB18030","GB2312","GBK","GEORGIAN-ACADEMY","GEORGIAN-PS","GREEK","GREEK8","HEBREW","HP-ROMAN8","HZ","HZ-GB-2312","IBM-CP1133","IBM367","IBM819","IBM850","IBM862","IBM866","ISO-10646-UCS-2","ISO-10646-UCS-4","ISO-2022-CN","ISO-2022-CN-EXT","ISO-2022-JP","ISO-2022-JP-1","ISO-2022-JP-2","ISO-2022-KR","ISO-8859-1","ISO-8859-10","ISO-8859-11","ISO-8859-13","ISO-8859-14","ISO-8859-15","ISO-8859-16","ISO-8859-2","ISO-8859-3","ISO-8859-4","ISO-8859-5","ISO-8859-6","ISO-8859-7","ISO-8859-8","ISO-8859-9","ISO-CELTIC","ISO-IR-100","ISO-IR-101","ISO-IR-109","ISO-IR-110","ISO-IR-126","ISO-IR-127","ISO-IR-138","ISO-IR-14","ISO-IR-144","ISO-IR-148","ISO-IR-149","ISO-IR-157","ISO-IR-159","ISO-IR-165","ISO-IR-166","ISO-IR-179","ISO-IR-199","ISO-IR-203","ISO-IR-226","ISO-IR-57","ISO-IR-58","ISO-IR-6","ISO-IR-87","ISO_646.IRV:1991","ISO_8859-1:1987","ISO_8859-10:1992","ISO_8859-14:1998","ISO_8859-15:1998","ISO_8859-16:2001","ISO_8859-2:1987","ISO_8859-3:1988","ISO_8859-4:1988","ISO_8859-5:1988","ISO_8859-6:1987","ISO_8859-7:1987","ISO_8859-7:2003","ISO_8859-8:1988","ISO_8859-9:1989","ISO646-CN","ISO646-JP","ISO646-US","ISO8859-1","ISO8859-10","ISO8859-11","ISO8859-13","ISO8859-14","ISO8859-15","ISO8859-16","ISO8859-2","ISO8859-3","ISO8859-4","ISO8859-5","ISO8859-6","ISO8859-7","ISO8859-8","ISO8859-9","JAVA","JIS_C6220-1969-RO","JIS_C6226-1983","JIS_X0201","JIS_X0208","JIS_X0208-1983","JIS_X0208-1990","JIS_X0212","JIS_X0212-1990","JIS_X0212.1990-0","JIS0208","JISX0201-1976","JOHAB","JP","KOI8-R","KOI8-RU","KOI8-T","KOI8-U","KOREAN","KS_C_5601-1987","KS_C_5601-1989","KSC_5601","KZ-1048","L1","L10","L2","L3","L4","L5","L6","L7","L8","LATIN-9","LATIN1","LATIN10","LATIN2","LATIN3","LATIN4","LATIN5","LATIN6","LATIN7","LATIN8","MAC","MACARABIC","MACCENTRALEUROPE","MACCROATIAN","MACCYRILLIC","MACGREEK","MACHEBREW","MACICELAND","MACINTOSH","MACROMAN","MACROMANIA","MACTHAI","MACTURKISH","MACUKRAINE","MS-ANSI","MS-ARAB","MS-CYRL","MS-EE","MS-GREEK","MS-HEBR","MS-TURK","MS_KANJI","MS936","MULELAO-1","NEXTSTEP","PT154","PTCP154","R8","RK1048","ROMAN8","SHIFT-JIS","SJIS","STRK1048-2002","TCVN","TCVN-5712","TCVN5712-1","TCVN5712-1:1993","TIS-620","TIS620","TIS620-0","TIS620.2529-1","TIS620.2533-0","TIS620.2533-1","UCS-2","UCS-2-INTERNAL","UCS-2-SWAPPED","UCS-2BE","UCS-2LE","UCS-4","UCS-4-INTERNAL","UCS-4-SWAPPED","UCS-4BE","UCS-4LE","UHC","UNICODE-1-1","UNICODE-1-1-UTF-7","UNICODEBIG","UNICODELITTLE","US","US-ASCII","UTF-16","UTF-16BE","UTF-16LE","UTF-32","UTF-32BE","UTF-32LE","UTF-7","UTF-8","VISCII","VISCII1.1-1","WCHAR_T","WINBALTRIM","WINDOWS-1250","WINDOWS-1251","WINDOWS-1252","WINDOWS-1253","WINDOWS-1254","WINDOWS-1255","WINDOWS-1256","WINDOWS-1257","WINDOWS-1258","WINDOWS-874","WINDOWS-936","X0201","X0208","X0212"],"type":"string"}},"required":["ccChannel","characterEncoding","input"]}},"required":["properties"]}}}}}}},"bifs":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Bif","description":"Either height or width is required. It is also possible to set both properties.","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"height":{"description":"Height of one thumbnail","type":"integer"},"width":{"description":"Width of one thumbnail. Roku recommends a width of 240 for SD and 320 for HD.","type":"integer"},"distance":{"description":"Distance in seconds between a screenshot","minimum":0,"format":"double","type":"number"},"filename":{"description":"Filename of the Bif image.","type":"string"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"aspectMode":{"description":"Specifies the aspect mode that is used when both height and width are specified\nOnly supported starting with encoder version `2.85.0`.\n","enum":["PAD","CROP","STRETCH"],"type":"string"}},"required":["distance","filename","outputs"]}},"required":["properties"]}}},"hdr":{"type":"object","properties":{"dolbyVision":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyVisionMetadata","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"profile":{"description":"Dolby Vision Profile","enum":["DVHE_04","DVHE_05","DVHE_07","HEV1_08","AVC3_09"],"type":"string"},"metadataSource":{"description":"Dolby Vision Metadata Source","enum":["INPUT_STREAM","EMBEDDED"],"type":"string"},"metadataInputStreamId":{"description":"ID of the Dolby Vision Metadata Ingest Input Stream which provides the XML Metadata file. Required if metadataSource is set to INPUT_STREAM.","type":"string"}},"required":["metadataSource"]}},"required":["properties"]}}}}},"thumbnails":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Thumbnail","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"height":{"description":"Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.\n","type":"integer"},"width":{"description":"Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported\n","type":"integer"},"pattern":{"description":" Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s).","type":"string"},"interval":{"description":"The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1.","format":"double","type":"number"},"positions":{"description":"Position in the unit where the thumbnail should be created from. Mutually exclusive with interval.","items":{"type":"number"},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"unit":{"description":"Unit of the values in the positions array.","enum":["SECONDS","PERCENTS"],"type":"string"},"aspectMode":{"description":"Specifies the aspect mode that is used when both height and width are specified\nOnly supported starting with encoder version `2.85.0`.\n","enum":["PAD","CROP","STRETCH"],"type":"string"}},"required":["outputs","pattern"]}},"required":["properties"]}}},"sprites":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Sprite","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"height":{"description":"Height of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required\n","type":"integer"},"width":{"description":"Width of one thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 both are required\n","type":"integer"},"unit":{"enum":["SECONDS","PERCENTS"],"type":"string"},"distance":{"description":"Distance in the given unit between a screenshot","format":"double","type":"number"},"spriteName":{"description":"Name of the sprite image. File extension \".jpg\"/\".jpeg\" or \".png\" is required.","type":"string"},"filename":{"description":"Filename of the sprite image. If not set, spriteName will be used, but without an extension.","type":"string"},"vttName":{"description":"Filename of the vtt-file. The file-extension \".vtt\" is required.","type":"string"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"imagesPerFile":{"description":"Number of images per file. If more images are generated than specified in this value, multiple sprites will be created. You can use the placeholder '%number%' in the spriteName to specify the naming policy. Either this property must be set or hTiles and vTiles.\n","type":"integer"},"hTiles":{"description":"Number of rows of images per file.\n\nHas to be set together with vTiles. If this property and vTiles are set, the imagesPerFile property must not be set.\n\nIt is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites.\n\nOnly supported starting with encoder version `2.76.0`.\n","minimum":1,"type":"integer"},"vTiles":{"description":"Number of columns of images per file.\n\nHas to be set together with hTiles. If this property and hTiles are set, the imagesPerFile property must not be set.\n\nIt is recommended to use the placeholder '%number%' in the spriteName to allow the generation of multiple sprites.\n\nOnly supported starting with encoder version `2.76.0`.\n","minimum":1,"type":"integer"},"jpegConfig":{"type":"object","description":"Additional configuration for JPEG sprite generation.\n\nIf this property is set the extension of the file must be '.jpg.' or '.jpeg'\n\nOnly supported starting with encoder version `2.76.0`\n","properties":{"quality":{"description":"Quality of the JPEG file in percent. Allowed values 20 - 100","minimum":20,"maximum":100,"type":"integer"}},"required":["quality"]},"creationMode":{"description":"The creation mode for the thumbnails in the Sprite.\n\nTwo possible creation modes exist: generate thumbnails starting with the beginning of the video or after the first configured period.\n\nWhen using distance=10 and unit=SECONDS and INTERVAL_END, the first image of the sprite is from the second 10 of the video.\nWhen using distance=10 and unit=SECONDS and INTERVAL_START, the first image of the sprite is from the very start of the video, while the second image is from second 10 of the video.\n\nIt is recommended to use 'INTERVAL_START' when using the sprites for trick play so that there is an additional thumbnail from the beginning of the video.\n\nOnly supported starting with encoder version `2.76.0`.\n","enum":["INTERVAL_END","INTERVAL_START"],"type":"string"},"aspectMode":{"description":"Specifies the aspect mode that is used when both height and width are specified\nOnly supported starting with encoder version `2.85.0`.\n","enum":["PAD","CROP","STRETCH"],"type":"string"}},"required":["spriteName"]}},"required":["properties"]}}}},"required":["properties"]}}},"inputStreams":{"type":"object","properties":{"audioMix":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AudioMixInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"channelLayout":{"description":"Channel layout of the audio mix input stream","enum":["NONE","MONO","STEREO","SURROUND","QUAD","HEXAGONAL","OCTAGONAL","STEREO_DOWNMIX","2.1","2.2","3.1","4.0","4.1","5.0","5.1","5.0_BACK","5.1_BACK","6.0","6.0_FRONT","6.1","6.1_FRONT","6.1_BACK","7.0","7.0_FRONT","7.1","7.1_WIDE","7.1_WIDE_BACK"],"type":"string"},"audioMixChannels":{"items":{"type":"object","title":"AudioMixInputStreamChannel","properties":{"inputStreamId":{"description":"The id of the input stream that should be used for mixing.","type":"string"},"outputChannelType":{"enum":["CHANNEL_NUMBER","FRONT_LEFT","FRONT_RIGHT","CENTER","LOW_FREQUENCY","BACK_LEFT","BACK_RIGHT","SURROUND_LEFT","SURROUND_RIGHT"],"type":"string"},"outputChannelNumber":{"description":"Number of this output channel. If type is 'CHANNEL_NUMBER', this must be set.","type":"integer"},"sourceChannels":{"description":"List of source channels to be mixed","items":{"type":"object","title":"AudioMixInputStreamSourceChannel","properties":{"gain":{"description":"Gain for this source channel. Default is 1.0.","format":"double","type":"number"},"type":{"enum":["CHANNEL_NUMBER","FRONT_LEFT","FRONT_RIGHT","CENTER","LOW_FREQUENCY","BACK_LEFT","BACK_RIGHT","SURROUND_LEFT","SURROUND_RIGHT"],"type":"string"},"channelNumber":{"description":"Number of this source channel. If type is 'CHANNEL_NUMBER', this must be set.","type":"integer"}},"required":["type"]},"type":"array"}},"required":["outputChannelType"]},"type":"array"}}}},"required":["properties"]}}},"ingest":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"IngestInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"ID of an Input resource defining the input storage","type":"string"},"inputPath":{"description":"Path to an input media file","type":"string"},"selectionMode":{"description":"Specifies the strategy for selecting a stream from the input file","enum":["AUTO","POSITION_ABSOLUTE","VIDEO_RELATIVE","AUDIO_RELATIVE","SUBTITLE_RELATIVE"],"type":"string"},"position":{"description":"Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.","minimum":0,"type":"integer"}},"required":["inputId","inputPath"]}},"required":["properties"]}}},"sidecar":{"type":"object","properties":{"dolbyVisionMetadataIngest":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyVisionMetadataIngestInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to Dolby Vision Metadata file","type":"string"}},"required":["inputId","inputPath"]}},"required":["properties"]}}}}},"concatenation":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ConcatenationInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"concatenation":{"description":"Concatenation configuration for the output of this stream","items":{"type":"object","title":"ConcatenationInputConfiguration","properties":{"inputStreamId":{"description":"The ID of the input stream to be concatenated. This can be an ingest input stream or a trimming input stream","type":"string"},"isMain":{"type":"boolean","description":"Exactly one input stream of a concatenation must have this set to true, which will be used as reference for scaling, aspect ratio, FPS, sample rate, etc. "},"position":{"description":"A unique integer value that determines concatenation order","minimum":0,"type":"integer"},"paddingBefore":{"type":"object","description":"Inserts a padding sequence (black frames and/or silent audio) before the input stream.","properties":{"duration":{"description":"Duration of the padding sequence, given in the unit specified by the `unit` property. The maximum duration is 300 frames or 10 seconds. If the unit is `FRAMES`, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). `FRAMES` is not allowed if the encoding does not contain a video output stream.\n","minimum":0,"format":"double","type":"number"},"unit":{"description":"The unit of the `duration` property","enum":["SECONDS","FRAMES"],"type":"string"}},"required":["duration"]},"paddingAfter":{"type":"object","description":"Inserts a padding sequence (black frames and/or silent audio) after the input stream.","properties":{"duration":{"description":"Duration of the padding sequence, given in the unit specified by the `unit` property. The maximum duration is 300 frames or 10 seconds. If the unit is `FRAMES`, this needs to be an integer value and will be interpreted based on the input frame rate of the main part of the ConcatenationInputStream that is used by your video output stream(s). `FRAMES` is not allowed if the encoding does not contain a video output stream.\n","minimum":0,"format":"double","type":"number"},"unit":{"description":"The unit of the `duration` property","enum":["SECONDS","FRAMES"],"type":"string"}},"required":["duration"]},"aspectMode":{"description":"Specifies the aspect mode that is used when adapting to the main input stream's aspect ratio","enum":["PAD","CROP","STRETCH"],"type":"string"}},"required":["inputStreamId","position"]},"type":"array"}}}},"required":["properties"]}}},"file":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FileInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to file","type":"string"},"fileType":{"enum":["TTML","WEBVTT","SRT"],"type":"string"}},"required":["fileType","inputId","inputPath"]}},"required":["properties"]}}},"trimming":{"type":"object","properties":{"timeBased":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"TimeBasedTrimmingInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputStreamId":{"description":"The id of the ingest input stream that should be trimmed","type":"string"},"offset":{"description":"Defines the offset in seconds at which the encoding should start, beginning at 0. The frame indicated by this value will be included in the encoding","minimum":0,"format":"double","type":"number"},"duration":{"description":"Defines how many seconds of the input will be encoded. Not defining or setting it to null indicates that the remaining input (considering offset) will be encoded.","minimum":0,"format":"double","type":"number"}}}},"required":["properties"]}}},"timecodeTrack":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"TimecodeTrackTrimmingInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputStreamId":{"description":"The id of the ingest input stream that should be trimmed","type":"string"},"startTimeCode":{"description":"Defines the timecode, in SMPTE-12M format, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding","type":"string"},"endTimeCode":{"description":"Defines the timecode, in SMPTE-12M format, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding","type":"string"}},"required":["endTimeCode","inputStreamId","startTimeCode"]}},"required":["properties"]}}},"h264PictureTiming":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"H264PictureTimingTrimmingInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputStreamId":{"description":"The id of the ingest input stream that should be trimmed","type":"string"},"startPicTiming":{"description":"Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame from which the encoding should start. The frame indicated by this value will be included in the encoding","type":"string"},"endPicTiming":{"description":"Defines the H264 SEI picture timing, as specified in ISO/IEC 14496-10:2008, of the frame at which the encoding should stop. The frame indicated by this value will be included in the encoding","type":"string"}}}},"required":["properties"]}}}}},"subtitles":{"type":"object","properties":{"dvbSubtitle":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DvbSubtitleInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"ID of an Input resource defining the input storage","type":"string"},"inputPath":{"description":"Path to an input media file","type":"string"},"selectionMode":{"description":"Specifies the strategy for selecting a stream from the input file. Supported values for VOD encodings: AUTO, POSITION_ABSOLUTE, SUBTITLE_RELATIVE. Supported values for LIVE encodings: POSITION_ABSOLUTE","enum":["AUTO","POSITION_ABSOLUTE","VIDEO_RELATIVE","AUDIO_RELATIVE","SUBTITLE_RELATIVE"],"type":"string"},"position":{"description":"Position of the stream to be selected from the input file (zero-based). Must not be set in combination with selectionMode 'AUTO', defaults to 0 for any other selectionMode.","minimum":0,"type":"integer"}}}},"required":["properties"]}}}}},"captions":{"type":"object","properties":{"cea608":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Cea608CaptionInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of the Input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"},"channel":{"description":"The channel number of the subtitle on the respective stream position","enum":["CC1","CC3"],"type":"string"}},"required":["channel","inputId","inputPath"]}},"required":["properties"]}}},"cea708":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Cea708CaptionInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of the Input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"},"channel":{"description":"The channel number of the subtitle on the respective stream position. Must not be smaller than 1","type":"integer"}},"required":["channel","inputId","inputPath"]}},"required":["properties"]}}}}},"dolbyAtmos":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyAtmosIngestInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to the Dolby Atmos input file","type":"string"},"inputFormat":{"description":"Input file format of the Dolby Atmos input file. Set it to DAMF if the given input file is a Dolby Atmos Master File (.atmos). Set it to ADM if the given input file is an Audio Definition Model Broadcast Wave Format file (.wav)","enum":["DAMF","ADM"],"type":"string"}},"required":["inputFormat","inputId","inputPath"]}},"required":["properties"]}}},"dolbyVision":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DolbyVisionInputStream","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of input","type":"string"},"videoInputPath":{"description":"Path to Dolby Vision input video file.","type":"string"},"metadataInputPath":{"description":"Path to Dolby Vision Metadata file. This field is required when the metadata is not embedded in the video input file.","type":"string"}},"required":["inputId","videoInputPath"]}},"required":["properties"]}}}}},"live":{"type":"object","properties":{"insertableContent":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"InsertableContent","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputs":{"description":"Either a list of movie files to be inserted in the live stream or a single image file. The movie files must have a video stream at stream position 0, which matches the codec, resolution and framerate of the livestream. The number of audio streams must also be the same and they have to match the sample format, number of channels and sample rate of the audio streams of the livestream. Supported image formats are: `.Y.U.V`, `Alias PIX`, `animated GIF`, `APNG`, `BMP`, `DPX`, `FITS`, `JPEG`, `JPEG 2000`, `JPEG-LS`, `PAM`, `PBM`, `PCX`, `PGM`, `PGMYUV`, `PNG`, `PPM`, `SGI`, `Sun Rasterfile`, `TIFF`, `Truevision Targa`, `WebP`, `XBM`, `XFace`, `XPM`, `XWD`","items":{"type":"object","title":"InsertableContentInput","properties":{"inputId":{"description":"Id of the input hosting the video file","type":"string"},"inputPath":{"description":"Path to the file on the input","type":"string"},"description":{"description":"Description of this input","type":"string"}},"required":["inputId","inputPath"]},"type":"array"},"status":{"description":"Status of the insertable content.","enum":["CREATED","DOWNLOADING","READY","ERROR"],"type":"string"}}},"schedule":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ScheduledInsertableContent","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"contentId":{"description":"Id of the insertable content to play instead of the live stream","type":"string"},"runAt":{"type":"object","description":"Time to play the content in UTC: YYYY-MM-DDThh:mm:ssZ, if this property is not set the content will be played as soon as possible."},"durationInSeconds":{"description":"Duration for how long to play the content. Cut off if shorter, loop if longer than actual duration. This property is required if the insertable content is an image.","format":"double","type":"number"},"status":{"description":"Status of the scheduled insertable content.","enum":["CREATED","SCHEDULED","TO_BE_DESCHEDULED","DESCHEDULED","ERROR"],"type":"string"}}}},"required":["properties"]}}}},"required":["properties"]}}},"scte35Cue":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Scte35Cue","properties":{"cueDuration":{"description":"Cue out duration in seconds.","format":"double","type":"number"},"manifestIds":{"description":"The ids of the manifests to update. If this property is not set, all the manifests tied to the encoding are updated.","items":{"type":"string"},"type":"array"}},"required":["cueDuration"]}},"required":["properties"]}}},"resetLiveManifestTimeshift":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ResetLiveManifestTimeShift","properties":{"residualPeriodInSeconds":{"description":"Determines how many seconds will be left in the manifest after segments are removed.\nIf this is not set, all but one segment will be removed.\n","format":"double","type":"number"},"offsetInSeconds":{"description":"Offset in seconds from the start of the live event, defining the point from which all segments within that duration will be removed from the given manifests.\nE.g.: The segment length is 2 seconds and a timeshift of 120 seconds (2 minutes) is configured. \nThe manifest contains 60 segments with the last segment number being 80 (`segment_80.ts`). \nThis means the manifest contains `segment_20.ts` to `segment_80.ts` (timeshift of 2 minutes equals 60 segments in manifest)\nIf you set `offsetInSeconds` to `120`, all segments below segment number 60 (`segment_60.ts`) will be removed. (`targetSegmentNumber = offsetInSeconds / segmentLength`)\nThe manifests will then contain `segment_60.ts` to `segment_80.ts`\n*Note:* Only `offsetInSeconds` or `residualPeriodInSeconds` can be set.\n","format":"double","type":"number"},"manifestIds":{"description":"The ids of the manifests to update. If this property is not set, all manifests tied to the encoding are updated.","items":{"type":"string"},"type":"array"},"shiftProgressiveMuxingStartPosition":{"type":"boolean","description":"If set to true, the Progressive muxing start position will be shifted to the start of the first remaining segment after the removal. NOTE: This only works for Progressive MP4 muxings."}}}},"required":["properties"]}}},"start":{"type":"object","properties":{"properties":{"type":"object","title":"StartLiveEncodingRequest","properties":{"streamKey":{"description":"Key for the stream. (a-zA-Z, 3-20 characters)","type":"string"},"hlsManifests":{"description":"HLS manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"LiveHlsManifest","properties":{"manifestId":{"description":"HLS manifest id","type":"string"},"timeshift":{"description":"Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.\n","format":"double","type":"number"},"liveEdgeOffset":{"description":"Live edge offset in seconds","format":"double","type":"number"},"insertProgramDateTime":{"type":"boolean","description":"Specifies if the EXT-X-PROGRAM-DATETIME tag will be included"},"programDateTimeSettings":{"type":"object","description":"Configuration for the EXT-X-PROGRAM-DATETIME tag","properties":{"programDateTimeSource":{"title":"ProgramDateTimeSource","description":"Source for the EXT-X-PROGRAM-DATETIME tag","enum":["SYSTEM_CLOCK","EMBEDDED"],"type":"string"},"programDateTimePlacement":{"type":"object","title":"ProgramDateTimePlacement","properties":{"programDateTimePlacementMode":{"title":"ProgramDateTimePlacementMode","description":"Placement mode of the ProgramDateTime tag.","enum":["ONCE_PER_PLAYLIST","SEGMENTS_INTERVAL","SECONDS_INTERVAL"],"type":"string"},"interval":{"description":"Interval for placing ProgramDateTime. Only required for SEGMENTS_INTERVAL or SECONDS_INTERVAL.","type":"integer"}}}}},"adMarkerSettings":{"type":"object","description":"Configuration for tags related to ad markers (e.g. Scte35)","properties":{"enabledMarkerTypes":{"description":"Ad marker types that will be inserted. More than one type is possible.\n\n- EXT_X_CUE_OUT_IN: Ad markers will be inserted using `#EXT-X-CUE-OUT` and `#EXT-X-CUE-IN` tags\n- EXT_OATCLS_SCTE35: Ad markers will be inserted using `#EXT-OATCLS-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\n- EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using `#EXT-X-SPLICEPOINT-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\n- EXT_X_DATERANGE: Ad markers will be inserted using `#EXT-X-DATERANGE` tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger.\n- EXT_X_SCTE35: Ad markers will be inserted using `#EXT-X-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\n","items":{"type":"string","title":"HlsManifestAdMarkerType"},"type":"array"}}}},"required":["manifestId"]},"type":"array"},"dashManifests":{"description":"DASH manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"LiveDashManifest","properties":{"manifestId":{"description":"Dash manifest id","type":"string"},"timeshift":{"description":"Timeshift in seconds","format":"double","type":"number"},"liveEdgeOffset":{"description":"Live edge offset in seconds","format":"double","type":"number"},"suggestedPresentationDelay":{"description":"The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.","format":"double","type":"number"},"minimumUpdatePeriod":{"description":"The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.","format":"double","type":"number"},"availabilityStartTimeMode":{"description":"The mode to trigger the availabilityStartTime initialization.","enum":["ON_FIRST_SEGMENT","ON_STREAM_INGEST"],"type":"string"},"adMarkerSettings":{"type":"object","properties":{"periodOption":{"enum":["SINGLE_PERIOD","MULTI_PERIOD"],"type":"string"},"eventStreamSignalling":{"enum":["XML","XML_BIN"],"type":"string"}}}},"required":["manifestId"]},"type":"array"},"liveEncodingMode":{"description":"The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"reuploadSettings":{"type":"object","description":"Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage","properties":{"dashManifestInterval":{"description":"Interval in seconds to reupload the DASH manifest. Valid values are either `null` to never reupload the dash manifest or at least `30`.","minimum":30,"format":"double","type":"number"},"hlsManifestInterval":{"description":"Interval in seconds to reupload the HLS master file. Valid values are either `0` to never reupload the hls manifest or at least `30`. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.","format":"double","type":"number"},"muxingInitFileInterval":{"description":"The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either `null` to never reupload the init file for segmented muxings or at least `30`.","minimum":30,"format":"double","type":"number"}}},"manifestGenerator":{"description":"Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\n","enum":["LEGACY","V2"],"type":"string"},"autoRestartConfiguration":{"type":"object","description":"Configuration for auto restarting the live encoding","properties":{"segmentsWrittenTimeout":{"description":"If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"bytesWrittenTimeout":{"description":"If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"framesWrittenTimeout":{"description":"If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"hlsManifestsUpdateTimeout":{"description":"If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"dashManifestsUpdateTimeout":{"description":"If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"scheduleExpression":{"description":"Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)","type":"string"},"restartOnEncoderError":{"type":"boolean","description":"Defines if the encoding should be restarted in case of an error during encoding."}}},"autoShutdownConfiguration":{"type":"object","description":"Configuration for auto shutdown of the live encoding","properties":{"bytesReadTimeoutSeconds":{"description":"Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.","minimum":30,"type":"integer"},"streamTimeoutMinutes":{"description":"Automatically shutdown the live stream after a predefined runtime in minutes.","minimum":5,"type":"integer"},"waitingForFirstConnectTimeoutMinutes":{"description":"Automatically shutdown the live stream if input is never connected for a predefined number of minutes.","minimum":5,"type":"integer"}}},"esamSettings":{"type":"object","description":"Configuration for Event Signaling and Management (ESAM) system, \nallowing the encoder to communicate with an ESAM server for signal processing and dynamic ad insertion update.'\n","properties":{"poisEndpoint":{"description":"The URL of the Placement Opportunity Information System (POIS) signal processing endpoint. \nThe encoder transmits SignalProcessingEvents to this endpoint whenever SCTE-35 messages are detected.\n","type":"string"},"acquisitionPointIdentity":{"description":"A unique identifier representing the `Acquisition Point Identity` defined in the ESAM specification.\n","type":"string"},"zoneIdentity":{"description":"Specifies the `Zone Identity` defined in the ESAM specification.\n","type":"string"},"adAvailOffset":{"description":"Defines an offset (in milliseconds) to be applied to the stream event timestamp. \nThis offset adjusts the `StreamTime` values (such as PTS) associated with ad opportunities \nor content insertions. It is used to fine-tune timing for embedded SCTE-104/35 messages \nto ensure precise frame alignment in the transport stream.\n","minimum":0,"type":"integer"},"poisEndpointCredentials":{"type":"object","description":"If authentication is required to access the POIS endpoint, credentials must be provided.\n","properties":{"username":{"description":"The username required to authenticate with the POIS server.\n","type":"string"},"password":{"description":"The password required for authentication with the POIS server.\n","type":"string"}}}}},"cacheControlSettings":{"type":"object","description":"Configuration of cache control policies for media segments, HLS, and DASH manifests. \nYou can set caching for the HLS multivariant playlist, HLS media playlist, DASH timeline manifest, \nDASH template manifest, initialization segment, and media segment.\n","properties":{"hls":{"type":"object","description":"Cache control settings for HLS manifest.","properties":{"multiVariantPlaylist":{"type":"object","description":"Cache control settings for HLS Multivariant playlist.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}},"variantPlaylist":{"type":"object","description":"Cache control settings for HLS Media playlist.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}}}},"dash":{"type":"object","description":"Cache control settings for DASH manifest.","properties":{"timelineManifest":{"type":"object","description":"Cache control settings for DASH Timeline manifest.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}},"templateManifest":{"type":"object","description":"Cache control settings for DASH Template manifest.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}}}},"segments":{"type":"object","description":"Cache control settings for segments.","properties":{"initSegment":{"type":"object","description":"Cache control settings for init segment.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}},"mediaSegment":{"type":"object","description":"Cache control settings for media segment.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}}}}}}},"required":["streamKey"]}},"required":["properties"]},"hd":{"type":"object","properties":{"start":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"StartLiveChannelEncodingRequest","properties":{"streamKey":{"description":"Key for the stream. (a-zA-Z, 3-20 characters)","type":"string"},"hlsManifests":{"description":"HLS manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"LiveHlsManifest","properties":{"manifestId":{"description":"HLS manifest id","type":"string"},"timeshift":{"description":"Timeshift in seconds. We recommend to use a timeshift value not greater than 3 hours (10800.0 seconds). Longer values could negatively impact the manifest update frequency.\n","format":"double","type":"number"},"liveEdgeOffset":{"description":"Live edge offset in seconds","format":"double","type":"number"},"insertProgramDateTime":{"type":"boolean","description":"Specifies if the EXT-X-PROGRAM-DATETIME tag will be included"},"programDateTimeSettings":{"type":"object","description":"Configuration for the EXT-X-PROGRAM-DATETIME tag","properties":{"programDateTimeSource":{"title":"ProgramDateTimeSource","description":"Source for the EXT-X-PROGRAM-DATETIME tag","enum":["SYSTEM_CLOCK","EMBEDDED"],"type":"string"},"programDateTimePlacement":{"type":"object","title":"ProgramDateTimePlacement","properties":{"programDateTimePlacementMode":{"title":"ProgramDateTimePlacementMode","description":"Placement mode of the ProgramDateTime tag.","enum":["ONCE_PER_PLAYLIST","SEGMENTS_INTERVAL","SECONDS_INTERVAL"],"type":"string"},"interval":{"description":"Interval for placing ProgramDateTime. Only required for SEGMENTS_INTERVAL or SECONDS_INTERVAL.","type":"integer"}}}}},"adMarkerSettings":{"type":"object","description":"Configuration for tags related to ad markers (e.g. Scte35)","properties":{"enabledMarkerTypes":{"description":"Ad marker types that will be inserted. More than one type is possible.\n\n- EXT_X_CUE_OUT_IN: Ad markers will be inserted using `#EXT-X-CUE-OUT` and `#EXT-X-CUE-IN` tags\n- EXT_OATCLS_SCTE35: Ad markers will be inserted using `#EXT-OATCLS-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\n- EXT_X_SPLICEPOINT_SCTE35: Ad markers will be inserted using `#EXT-X-SPLICEPOINT-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\n- EXT_X_DATERANGE: Ad markers will be inserted using `#EXT-X-DATERANGE` tags. They contain the ID, start timestamp and hex encoded raw bytes of the original SCTE-35 trigger.\n- EXT_X_SCTE35: Ad markers will be inserted using `#EXT-X-SCTE35` tags. They contain the base64 encoded raw bytes of the original SCTE-35 trigger.\n","items":{"type":"string","title":"HlsManifestAdMarkerType"},"type":"array"}}}},"required":["manifestId"]},"type":"array"},"dashManifests":{"description":"DASH manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"LiveDashManifest","properties":{"manifestId":{"description":"Dash manifest id","type":"string"},"timeshift":{"description":"Timeshift in seconds","format":"double","type":"number"},"liveEdgeOffset":{"description":"Live edge offset in seconds","format":"double","type":"number"},"suggestedPresentationDelay":{"description":"The suggestedPresentationDelay to be set in the DASH manifest. If nothing is set, no value will be set.","format":"double","type":"number"},"minimumUpdatePeriod":{"description":"The minimumUpdatePeriod to be set in the DASH manifest. If nothing is set, the segment duration will be set.","format":"double","type":"number"},"availabilityStartTimeMode":{"description":"The mode to trigger the availabilityStartTime initialization.","enum":["ON_FIRST_SEGMENT","ON_STREAM_INGEST"],"type":"string"},"adMarkerSettings":{"type":"object","properties":{"periodOption":{"enum":["SINGLE_PERIOD","MULTI_PERIOD"],"type":"string"},"eventStreamSignalling":{"enum":["XML","XML_BIN"],"type":"string"}}}},"required":["manifestId"]},"type":"array"},"liveEncodingMode":{"description":"The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"reuploadSettings":{"type":"object","description":"Reupload specific files during a live encoding. This can be helpful if an automatic life cycle policy is enabled on the output storage","properties":{"dashManifestInterval":{"description":"Interval in seconds to reupload the DASH manifest. Valid values are either `null` to never reupload the dash manifest or at least `30`.","minimum":30,"format":"double","type":"number"},"hlsManifestInterval":{"description":"Interval in seconds to reupload the HLS master file. Valid values are either `0` to never reupload the hls manifest or at least `30`. This is currently not used, as the master file will always be uploaded when one of the playlist files has changed.","format":"double","type":"number"},"muxingInitFileInterval":{"description":"The interval in seconds to reupload the init file for segmented muxings, e.g. fMP4, WebM. Valid values are either `null` to never reupload the init file for segmented muxings or at least `30`.","minimum":30,"format":"double","type":"number"}}},"manifestGenerator":{"description":"Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\n","enum":["LEGACY","V2"],"type":"string"},"autoRestartConfiguration":{"type":"object","description":"Configuration for auto restarting the live encoding","properties":{"segmentsWrittenTimeout":{"description":"If no segments were generated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"bytesWrittenTimeout":{"description":"If no data was written for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"framesWrittenTimeout":{"description":"If no frames were generated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"hlsManifestsUpdateTimeout":{"description":"If HLS manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"dashManifestsUpdateTimeout":{"description":"If DASH manifests were not updated for the given number of seconds, a restart is triggered. Minimum: 30.0","minimum":30,"format":"double","type":"number"},"scheduleExpression":{"description":"Defines a schedule for restarts using the unix crontab syntax. This example would trigger a restart every monday at 05:30 (AM)","type":"string"},"restartOnEncoderError":{"type":"boolean","description":"Defines if the encoding should be restarted in case of an error during encoding."}}},"autoShutdownConfiguration":{"type":"object","description":"Configuration for auto shutdown of the live encoding","properties":{"bytesReadTimeoutSeconds":{"description":"Automatically shutdown the live stream if there is no input anymore for a predefined number of seconds.","minimum":30,"type":"integer"},"streamTimeoutMinutes":{"description":"Automatically shutdown the live stream after a predefined runtime in minutes.","minimum":5,"type":"integer"},"waitingForFirstConnectTimeoutMinutes":{"description":"Automatically shutdown the live stream if input is never connected for a predefined number of minutes.","minimum":5,"type":"integer"}}},"esamSettings":{"type":"object","description":"Configuration for Event Signaling and Management (ESAM) system, \nallowing the encoder to communicate with an ESAM server for signal processing and dynamic ad insertion update.'\n","properties":{"poisEndpoint":{"description":"The URL of the Placement Opportunity Information System (POIS) signal processing endpoint. \nThe encoder transmits SignalProcessingEvents to this endpoint whenever SCTE-35 messages are detected.\n","type":"string"},"acquisitionPointIdentity":{"description":"A unique identifier representing the `Acquisition Point Identity` defined in the ESAM specification.\n","type":"string"},"zoneIdentity":{"description":"Specifies the `Zone Identity` defined in the ESAM specification.\n","type":"string"},"adAvailOffset":{"description":"Defines an offset (in milliseconds) to be applied to the stream event timestamp. \nThis offset adjusts the `StreamTime` values (such as PTS) associated with ad opportunities \nor content insertions. It is used to fine-tune timing for embedded SCTE-104/35 messages \nto ensure precise frame alignment in the transport stream.\n","minimum":0,"type":"integer"},"poisEndpointCredentials":{"type":"object","description":"If authentication is required to access the POIS endpoint, credentials must be provided.\n","properties":{"username":{"description":"The username required to authenticate with the POIS server.\n","type":"string"},"password":{"description":"The password required for authentication with the POIS server.\n","type":"string"}}}}},"cacheControlSettings":{"type":"object","description":"Configuration of cache control policies for media segments, HLS, and DASH manifests. \nYou can set caching for the HLS multivariant playlist, HLS media playlist, DASH timeline manifest, \nDASH template manifest, initialization segment, and media segment.\n","properties":{"hls":{"type":"object","description":"Cache control settings for HLS manifest.","properties":{"multiVariantPlaylist":{"type":"object","description":"Cache control settings for HLS Multivariant playlist.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}},"variantPlaylist":{"type":"object","description":"Cache control settings for HLS Media playlist.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}}}},"dash":{"type":"object","description":"Cache control settings for DASH manifest.","properties":{"timelineManifest":{"type":"object","description":"Cache control settings for DASH Timeline manifest.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}},"templateManifest":{"type":"object","description":"Cache control settings for DASH Template manifest.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}}}},"segments":{"type":"object","description":"Cache control settings for segments.","properties":{"initSegment":{"type":"object","description":"Cache control settings for init segment.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}},"mediaSegment":{"type":"object","description":"Cache control settings for media segment.","properties":{"cacheControl":{"description":"Cache control for storing data on CDN. Example \"public, max-age=0, no-cache\". Cache control is supported on S3, GCS and Azure output storage providers.","type":"string"}}}}}}}},"required":["streamKey"]}},"required":["properties"]}}}}}}},"muxings":{"type":"object","properties":{"fmp4":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Fmp4Muxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the fragments in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy","type":"string"},"segmentNamingTemplate":{"description":"Segment naming policy containing one or both of the following placeholders:\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\n Intended to avoid re-use of segment names after restarting a live encoding.\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\n\nIf segmentNamingTemplate is set, segmentNaming must not be set.\n","type":"string"},"initSegmentName":{"description":"Init segment name","type":"string"},"initSegmentNameTemplate":{"description":"Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.","type":"string"},"writeDurationPerSample":{"type":"boolean","description":"Writes the duration per sample into the sample entry in the Track Fragment Run Box. This could help to fix playback issues on legacy players. Enabling this flag increases the muxing overhead by 4 bytes per sample/frame."},"signalScte35AsEmsg":{"type":"boolean","description":"Insert scte35 triggers as emsg boxes into the fMP4 segments."},"ptsAlignMode":{"description":"Alignment mode for composition / presentation timestamps (CTS/PTS). Only applies to h.264 and h.265","enum":["ALIGN_ZERO_NEGATIVE_CTO"],"type":"string"}},"required":["segmentLength","streams"]},"drm":{"type":"object","properties":{"widevine":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WidevineDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte Key id, 32 hexadecimal characters","type":"string"},"pssh":{"description":"Base 64 Encoded","type":"string"}},"required":["key","kid","pssh","outputs"]}},"required":["properties"]}}},"playready":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PlayReadyDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required","type":"string"},"keySeed":{"description":"Key seed to generate key. Either key or keySeed is required","type":"string"},"laUrl":{"description":"URL of the license server","type":"string"},"pssh":{"description":"Base64 encoded pssh payload","type":"string"},"method":{"enum":["MPEG_CENC","PIFF_CTR"],"type":"string"},"kid":{"description":"Key identifier","type":"string"},"additionalInformation":{"type":"object","properties":{"wrmHeaderCustomAttributes":{"description":"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.","type":"string"}}}},"required":["outputs"]}},"required":["properties"]}}},"primetime":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PrimeTimeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte Key id, 32 hexadecimal characters","type":"string"},"pssh":{"description":"Base 64 Encoded","type":"string"}},"required":["key","kid","pssh","outputs"]}},"required":["properties"]}}},"fairplay":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FairPlayDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"uri":{"description":"Url of the licensing server","type":"string"}},"required":["iv","key","outputs"]}},"required":["properties"]}}},"marlin":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"MarlinDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte key in hex (32 characters)","type":"string"},"kid":{"description":"16 byte key in hex (32 characters)","type":"string"}},"required":["key","kid","outputs"]}},"required":["properties"]}}},"clearkey":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ClearKeyDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte key id","type":"string"}},"required":["key","kid","outputs"]}},"required":["properties"]}}},"cenc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CencDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte encryption key id. Required for any other DRM but FairPlay","type":"string"},"encryptionMode":{"description":"The encryption method to use. Default is `CTR`","enum":["CTR","CBC"],"type":"string"},"ivSize":{"description":"Size of the initialization vector","enum":["8_BYTES","16_BYTES"],"type":"string"},"enablePiffCompatibility":{"type":"boolean","description":"Enables compatibility with the Protected Interoperable File Format (PIFF) specification"},"widevine":{"type":"object","description":"Configuration for Widevine DRM","properties":{"pssh":{"description":"Base64 encoded pssh payload","type":"string"}},"required":["pssh"]},"playReady":{"type":"object","description":"Configuration for PlayReady DRM","properties":{"laUrl":{"description":"Url of the license server. Either the laUrl or the pssh needs to be provided.","type":"string"},"pssh":{"description":"Base64 encoded pssh payload.","type":"string"},"additionalInformation":{"type":"object","properties":{"wrmHeaderCustomAttributes":{"description":"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.","type":"string"}}}}},"marlin":{"type":"object","description":"Configuration for Marlin DRM"},"fairPlay":{"type":"object","description":"Configuration for FairPlay DRM","properties":{"iv":{"description":"Initialization vector as hexadecimal string","type":"string"},"uri":{"description":"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.","type":"string"}}}},"required":["encryptionMode","key","outputs"]}},"required":["properties"]}}},"aes":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AesEncryptionDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"keyFileUri":{"description":"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.","type":"string"},"method":{"enum":["SAMPLE_AES","AES_128"],"type":"string"}},"required":["key","method","outputs"]}},"required":["properties"]}}},"speke":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpekeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"contentId":{"description":"Unique Identifier of the content, will be generated if not set","type":"string"},"kid":{"description":"Optional key identifier, will be generated if not set.\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\nwill provide the same keys.\n","type":"string"},"iv":{"description":"16 byte initialization vector represented by a 32-character text string.\nIt is mandatory if systemIds contains AES128 or FairPlay.\n","type":"string"},"provider":{"type":"object","description":"Key provider configuration for SPEKE","properties":{"url":{"description":"URL of the endpoint","type":"string"},"username":{"description":"Your username for Basic Authentication","type":"string"},"password":{"description":"Your password for Basic Authentication","type":"string"},"apiKey":{"description":"Your API key for authentication via X-API-Key HTTP Header","type":"string"},"roleArn":{"description":"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\n\nDuring the key exchange the role will be assumed to be able to access the key provider.\n\nThis role is to be created in the customer's account and must be granted access to the\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\nhas to be added to the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\nommitted.\n\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"execute-api:Invoke\"\n ],\n \"Resource\": [\n \"arn:aws:execute-api:{{region}}:*:*/*/POST/*\"\n ]\n }\n ]\n}\n```\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\ngive the role access to all regions.\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume access to\nthe SPEKE server on AWS.\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"gatewayRegion":{"description":"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\nin the execute-api policy for the role as described in 'roleArn'.\n","type":"string"}},"required":["url"]},"systemIds":{"description":"DRM system identifier of the content protection scheme. At minimum one is expected.\nNot all systemIds are currently supported, support depends on the muxing type.\n\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\n","items":{"type":"string"},"type":"array"}},"required":["provider","systemIds","outputs"]}},"required":["properties"]}}}}},"id3":{"type":"object","properties":{"watermarking":{"type":"object","properties":{"audio":{"type":"object","properties":{"nielsen":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WatermarkingAudioNielsenId3Tag","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"watermarkId":{"description":"ID of the Nielsen Audio Watermarking decoding-configuration","type":"string"}},"required":["watermarkId"]}},"required":["properties"]}}}}}}}}}},"required":["properties"]}}},"chunkedText":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ChunkedTextMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the segments in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy","type":"string"},"segmentNamingTemplate":{"description":"Segment naming policy containing one or both of the following placeholders:\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\n Intended to avoid re-use of segment names after restarting a live encoding.\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\n\nIf segmentNamingTemplate is set, segmentNaming must not be set.\n","type":"string"},"startOffset":{"description":"Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). For example, if set to 10 seconds, *X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000* will be added after each *WEBVTT* header. The default for ChunkedTextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for `startOffset` for [TsMuxings](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same `startOffset`.","type":"integer"}},"required":["segmentLength","streams"]}},"required":["properties"]}}},"cmaf":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CmafMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the fragments in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy","type":"string"},"segmentNamingTemplate":{"description":"Segment naming policy containing one or both of the following placeholders:\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\n Intended to avoid re-use of segment names after restarting a live encoding.\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\n\nIf segmentNamingTemplate is set, segmentNaming must not be set.\n","type":"string"},"initSegmentName":{"description":"Init segment name","type":"string"},"initSegmentNameTemplate":{"description":"Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.","type":"string"},"framesPerCmafChunk":{"description":"Number of media frames per CMAF chunk. Defaults to: Length of a segment in frames. Minimum: 1. Maximum: Length of a segment in frames.","type":"integer"}},"required":["segmentLength","streams"]}},"required":["properties"]}}},"segmentedRaw":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SegmentedRawMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the fragments in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy","type":"string"}},"required":["segmentLength","segmentNaming","streams"]}},"required":["properties"]}}},"packedAudio":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PackedAudioMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Duration of a segment, given in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy. The required filename extension depends on the codec (e.g. '.aac' for AAC). Either this or *segmentNamingTemplate* must be set.","type":"string"},"segmentNamingTemplate":{"description":"Segment naming policy containing one or both of the following placeholders:\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\n Intended to avoid re-use of segment names after restarting a live encoding.\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\n\nIf segmentNamingTemplate is set, segmentNaming must not be set.\nThe required filename extension depends on the codec (e.g. '.aac' for AAC).\n","type":"string"},"startOffset":{"description":"Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).","type":"integer"}},"required":["segmentLength","streams"]},"drm":{"type":"object","properties":{"aes":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AesEncryptionDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"keyFileUri":{"description":"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.","type":"string"},"method":{"enum":["SAMPLE_AES","AES_128"],"type":"string"}},"required":["key","method","outputs"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"text":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"TextMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file","type":"string"},"startOffset":{"description":"Offset of MPEG-TS timestamps in seconds. This only affects streams with [WebVttConfiguration](#/Encoding/PostEncodingConfigurationsSubtitlesWebVtt). If set, the X-TIMESTAMP-MAP will be added as described in the [HLS specification](https://datatracker.ietf.org/doc/html/rfc8216#section-3.5). For example, if set to 10 seconds, *X-TIMESTAMP-MAP=MPEGTS:900000,LOCAL:00:00:00.000* will be added after each *WEBVTT* header. The default for TextMuxing is that the X-TIMESTAMP-MAP will not be written. Important to note is that the default for `startOffset` for [TsMuxings](#/Encoding/PostEncodingEncodingsMuxingsTsByEncodingId) and [ProgressiveTsMuxings](#/Encoding/PostEncodingEncodingsMuxingsProgressiveTsByEncodingId) is 10 seconds. If the output of this muxing is used for HLS together with video/audio streams using TsMuxings and ProgressiveTsMuxings, this value should be set to the same `startOffset`.","type":"integer"}},"required":["filename","streams"]}},"required":["properties"]}}},"ts":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"TsMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the fragments in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy","type":"string"},"segmentNamingTemplate":{"description":"Segment naming policy containing one or both of the following placeholders:\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\n Intended to avoid re-use of segment names after restarting a live encoding.\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\n\nIf segmentNamingTemplate is set, segmentNaming must not be set.\n","type":"string"},"startOffset":{"description":"Offset of MPEG-TS timestamps in seconds. E.g., first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).","type":"integer"},"configuration":{"type":"object","description":"Advanced Configuration of the MPEG Transport Stream Parameters","properties":{"programNumber":{"description":"An integer value. Value for program_number field in the MPEG Transport Stream Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.","minimum":1,"maximum":65535,"type":"integer"},"pmt":{"type":"object","properties":{"pid":{"description":"An integer value. Packet Identifier (PID) for the MPEG Transport Stream PMT.","minimum":16,"maximum":8190,"type":"integer"}}},"pcr":{"type":"object","properties":{"pid":{"description":"An integer value. Packet Identifier (PID) for the MPEG Transport Stream PCR. This should generally point to the video stream PID. If it is not explicitly set it will point to the video stream PID if exists, otherwise to the audio stream PID.","minimum":16,"maximum":8190,"type":"integer"},"interval":{"description":"An integer value. Nominal time between MPEG Transport Stream PCRs in milliseconds.","minimum":1,"maximum":65535,"type":"integer"}}},"videoStreams":{"items":{"type":"object","title":"TsVideoStreamConfiguration","properties":{"streamId":{"description":"The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.","type":"string"},"pid":{"description":"An integer value. MPEG Transport Stream Packet Identifier (PID) for this video stream.","minimum":16,"maximum":8190,"type":"integer"}},"required":["pid","streamId"]},"type":"array"},"audioStreams":{"items":{"type":"object","title":"TsAudioStreamConfiguration","properties":{"streamId":{"description":"The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.","type":"string"},"pid":{"description":"An integer value. MPEG Transport Stream Packet Identifier (PID) for this audio stream.","minimum":16,"maximum":8190,"type":"integer"}},"required":["pid","streamId"]},"type":"array"}}}},"required":["streams"]},"drm":{"type":"object","properties":{"fairplay":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FairPlayDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"uri":{"description":"Url of the licensing server","type":"string"}},"required":["iv","key","outputs"]}},"required":["properties"]}}},"aes":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AesEncryptionDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"keyFileUri":{"description":"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.","type":"string"},"method":{"enum":["SAMPLE_AES","AES_128"],"type":"string"}},"required":["key","method","outputs"]}},"required":["properties"]}}},"speke":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpekeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"contentId":{"description":"Unique Identifier of the content, will be generated if not set","type":"string"},"kid":{"description":"Optional key identifier, will be generated if not set.\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\nwill provide the same keys.\n","type":"string"},"iv":{"description":"16 byte initialization vector represented by a 32-character text string.\nIt is mandatory if systemIds contains AES128 or FairPlay.\n","type":"string"},"provider":{"type":"object","description":"Key provider configuration for SPEKE","properties":{"url":{"description":"URL of the endpoint","type":"string"},"username":{"description":"Your username for Basic Authentication","type":"string"},"password":{"description":"Your password for Basic Authentication","type":"string"},"apiKey":{"description":"Your API key for authentication via X-API-Key HTTP Header","type":"string"},"roleArn":{"description":"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\n\nDuring the key exchange the role will be assumed to be able to access the key provider.\n\nThis role is to be created in the customer's account and must be granted access to the\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\nhas to be added to the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\nommitted.\n\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"execute-api:Invoke\"\n ],\n \"Resource\": [\n \"arn:aws:execute-api:{{region}}:*:*/*/POST/*\"\n ]\n }\n ]\n}\n```\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\ngive the role access to all regions.\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume access to\nthe SPEKE server on AWS.\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"gatewayRegion":{"description":"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\nin the execute-api policy for the role as described in 'roleArn'.\n","type":"string"}},"required":["url"]},"systemIds":{"description":"DRM system identifier of the content protection scheme. At minimum one is expected.\nNot all systemIds are currently supported, support depends on the muxing type.\n\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\n","items":{"type":"string"},"type":"array"}},"required":["provider","systemIds","outputs"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"webm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WebmMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the fragments in seconds","format":"double","type":"number"},"segmentNaming":{"description":"Segment naming policy","type":"string"},"segmentNamingTemplate":{"description":"Segment naming policy containing one or both of the following placeholders:\n- '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n on each (re)start of the encoding. The resulting string will be copied to the segmentNaming property.\n Intended to avoid re-use of segment names after restarting a live encoding.\n- '{segment_rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32)\n for each different segment. This is intended to avoid guessing segment URLs by replacing segment numbers.\n\nIf segmentNamingTemplate is set, segmentNaming must not be set.\n","type":"string"},"initSegmentName":{"description":"Init segment name","type":"string"},"initSegmentNameTemplate":{"description":"Segment naming policy containing a placeholder of the format '{rand_chars:x}', which will be replaced by a random alphanumeric string of length x (default 32) on each (re)start of the encoding. The resulting string will be copied to the initSegmentName property. Intended to avoid re-use of segment names after restarting a live encoding. If initSegmentNameTemplate is set, initSegmentName must not be set.","type":"string"}},"required":["segmentLength","streams"]},"drm":{"type":"object","properties":{"cenc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CencDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte encryption key id. Required for any other DRM but FairPlay","type":"string"},"encryptionMode":{"description":"The encryption method to use. Default is `CTR`","enum":["CTR","CBC"],"type":"string"},"ivSize":{"description":"Size of the initialization vector","enum":["8_BYTES","16_BYTES"],"type":"string"},"enablePiffCompatibility":{"type":"boolean","description":"Enables compatibility with the Protected Interoperable File Format (PIFF) specification"},"widevine":{"type":"object","description":"Configuration for Widevine DRM","properties":{"pssh":{"description":"Base64 encoded pssh payload","type":"string"}},"required":["pssh"]},"playReady":{"type":"object","description":"Configuration for PlayReady DRM","properties":{"laUrl":{"description":"Url of the license server. Either the laUrl or the pssh needs to be provided.","type":"string"},"pssh":{"description":"Base64 encoded pssh payload.","type":"string"},"additionalInformation":{"type":"object","properties":{"wrmHeaderCustomAttributes":{"description":"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.","type":"string"}}}}},"marlin":{"type":"object","description":"Configuration for Marlin DRM"},"fairPlay":{"type":"object","description":"Configuration for FairPlay DRM","properties":{"iv":{"description":"Initialization vector as hexadecimal string","type":"string"},"uri":{"description":"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.","type":"string"}}}},"required":["encryptionMode","key","outputs"]}},"required":["properties"]}}},"speke":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpekeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"contentId":{"description":"Unique Identifier of the content, will be generated if not set","type":"string"},"kid":{"description":"Optional key identifier, will be generated if not set.\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\nwill provide the same keys.\n","type":"string"},"iv":{"description":"16 byte initialization vector represented by a 32-character text string.\nIt is mandatory if systemIds contains AES128 or FairPlay.\n","type":"string"},"provider":{"type":"object","description":"Key provider configuration for SPEKE","properties":{"url":{"description":"URL of the endpoint","type":"string"},"username":{"description":"Your username for Basic Authentication","type":"string"},"password":{"description":"Your password for Basic Authentication","type":"string"},"apiKey":{"description":"Your API key for authentication via X-API-Key HTTP Header","type":"string"},"roleArn":{"description":"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\n\nDuring the key exchange the role will be assumed to be able to access the key provider.\n\nThis role is to be created in the customer's account and must be granted access to the\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\nhas to be added to the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\nommitted.\n\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"execute-api:Invoke\"\n ],\n \"Resource\": [\n \"arn:aws:execute-api:{{region}}:*:*/*/POST/*\"\n ]\n }\n ]\n}\n```\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\ngive the role access to all regions.\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume access to\nthe SPEKE server on AWS.\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"gatewayRegion":{"description":"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\nin the execute-api policy for the role as described in 'roleArn'.\n","type":"string"}},"required":["url"]},"systemIds":{"description":"DRM system identifier of the content protection scheme. At minimum one is expected.\nNot all systemIds are currently supported, support depends on the muxing type.\n\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\n","items":{"type":"string"},"type":"array"}},"required":["provider","systemIds","outputs"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"mp3":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Mp3Muxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file","type":"string"}},"required":["filename","streams"]}},"required":["properties"]}}},"mp4":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Mp4Muxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file (either `filename` or `name` is required, prefer `filename`)","type":"string"},"fragmentDuration":{"description":" Duration of fragments in milliseconds. Required for Fragmented MP4 Muxing (for Smooth Streaming or DASH On-Demand). Not setting this will result in unfragmented mp4.","type":"integer"},"fragmentedMP4MuxingManifestType":{"enum":["SMOOTH","DASH_ON_DEMAND","HLS_BYTE_RANGES","NONE","HLS_BYTE_RANGES_AND_IFRAME_PLAYLIST"],"type":"string"},"dolbyVisionConfiguration":{"type":"object","description":"Dolby Vision specific configuration","properties":{"trackSampleEntryName":{"title":"DolbyVisionTrackSampleEntryName","description":"Dolby Vision track's sample entry name","enum":["DVHE","DVH1"],"type":"string"}}}},"required":["streams"]},"drm":{"type":"object","properties":{"playready":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PlayReadyDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters. Either key or keySeed is required","type":"string"},"keySeed":{"description":"Key seed to generate key. Either key or keySeed is required","type":"string"},"laUrl":{"description":"URL of the license server","type":"string"},"pssh":{"description":"Base64 encoded pssh payload","type":"string"},"method":{"enum":["MPEG_CENC","PIFF_CTR"],"type":"string"},"kid":{"description":"Key identifier","type":"string"},"additionalInformation":{"type":"object","properties":{"wrmHeaderCustomAttributes":{"description":"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.","type":"string"}}}},"required":["outputs"]}},"required":["properties"]}}},"clearkey":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ClearKeyDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte key id","type":"string"}},"required":["key","kid","outputs"]}},"required":["properties"]}}},"widevine":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WidevineDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte Key id, 32 hexadecimal characters","type":"string"},"pssh":{"description":"Base 64 Encoded","type":"string"}},"required":["key","kid","pssh","outputs"]}},"required":["properties"]}}},"marlin":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"MarlinDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte key in hex (32 characters)","type":"string"},"kid":{"description":"16 byte key in hex (32 characters)","type":"string"}},"required":["key","kid","outputs"]}},"required":["properties"]}}},"cenc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CencDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte encryption key id. Required for any other DRM but FairPlay","type":"string"},"encryptionMode":{"description":"The encryption method to use. Default is `CTR`","enum":["CTR","CBC"],"type":"string"},"ivSize":{"description":"Size of the initialization vector","enum":["8_BYTES","16_BYTES"],"type":"string"},"enablePiffCompatibility":{"type":"boolean","description":"Enables compatibility with the Protected Interoperable File Format (PIFF) specification"},"widevine":{"type":"object","description":"Configuration for Widevine DRM","properties":{"pssh":{"description":"Base64 encoded pssh payload","type":"string"}},"required":["pssh"]},"playReady":{"type":"object","description":"Configuration for PlayReady DRM","properties":{"laUrl":{"description":"Url of the license server. Either the laUrl or the pssh needs to be provided.","type":"string"},"pssh":{"description":"Base64 encoded pssh payload.","type":"string"},"additionalInformation":{"type":"object","properties":{"wrmHeaderCustomAttributes":{"description":"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.","type":"string"}}}}},"marlin":{"type":"object","description":"Configuration for Marlin DRM"},"fairPlay":{"type":"object","description":"Configuration for FairPlay DRM","properties":{"iv":{"description":"Initialization vector as hexadecimal string","type":"string"},"uri":{"description":"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.","type":"string"}}}},"required":["encryptionMode","key","outputs"]}},"required":["properties"]}}},"speke":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpekeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"contentId":{"description":"Unique Identifier of the content, will be generated if not set","type":"string"},"kid":{"description":"Optional key identifier, will be generated if not set.\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\nwill provide the same keys.\n","type":"string"},"iv":{"description":"16 byte initialization vector represented by a 32-character text string.\nIt is mandatory if systemIds contains AES128 or FairPlay.\n","type":"string"},"provider":{"type":"object","description":"Key provider configuration for SPEKE","properties":{"url":{"description":"URL of the endpoint","type":"string"},"username":{"description":"Your username for Basic Authentication","type":"string"},"password":{"description":"Your password for Basic Authentication","type":"string"},"apiKey":{"description":"Your API key for authentication via X-API-Key HTTP Header","type":"string"},"roleArn":{"description":"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\n\nDuring the key exchange the role will be assumed to be able to access the key provider.\n\nThis role is to be created in the customer's account and must be granted access to the\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\nhas to be added to the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\nommitted.\n\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"execute-api:Invoke\"\n ],\n \"Resource\": [\n \"arn:aws:execute-api:{{region}}:*:*/*/POST/*\"\n ]\n }\n ]\n}\n```\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\ngive the role access to all regions.\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume access to\nthe SPEKE server on AWS.\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"gatewayRegion":{"description":"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\nin the execute-api policy for the role as described in 'roleArn'.\n","type":"string"}},"required":["url"]},"systemIds":{"description":"DRM system identifier of the content protection scheme. At minimum one is expected.\nNot all systemIds are currently supported, support depends on the muxing type.\n\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\n","items":{"type":"string"},"type":"array"}},"required":["provider","systemIds","outputs"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"mxf":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"MxfMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file","type":"string"}},"required":["filename","streams"]}},"required":["properties"]}}},"progressiveTs":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ProgressiveTsMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the segments in seconds","format":"double","type":"number"},"filename":{"description":"Name of the output file","type":"string"},"startOffset":{"description":"Offset of MPEG-TS timestamps in seconds. e.g. first packet will start with PTS 900,000 for a 10 seconds offset (90,000 MPEG-TS timescale).","type":"integer"}},"required":["streams"]},"id3":{"type":"object","properties":{"raw":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"RawId3Tag","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"positionMode":{"enum":["TIME","FRAME"],"type":"string"},"frame":{"description":"Frame number at which the Tag should be inserted","type":"integer"},"time":{"description":"Time in seconds where the Tag should be inserted","format":"double","type":"number"},"bytes":{"description":"Base64 Encoded Data","type":"string"}},"required":["bytes"]}},"required":["properties"]}}},"frameId":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FrameIdId3Tag","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"positionMode":{"enum":["TIME","FRAME"],"type":"string"},"frame":{"description":"Frame number at which the Tag should be inserted","type":"integer"},"time":{"description":"Time in seconds where the Tag should be inserted","format":"double","type":"number"},"bytes":{"description":"Base64 Encoded Data","type":"string"},"frameId":{"description":"4 character long Frame ID","type":"string"}},"required":["bytes","frameId"]}},"required":["properties"]}}},"plainText":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"PlaintextId3Tag","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"positionMode":{"enum":["TIME","FRAME"],"type":"string"},"frame":{"description":"Frame number at which the Tag should be inserted","type":"integer"},"time":{"description":"Time in seconds where the Tag should be inserted","format":"double","type":"number"},"text":{"description":"Plain Text Data","type":"string"},"frameId":{"description":"4 character long Frame ID","type":"string"}},"required":["frameId","text"]}},"required":["properties"]}}}}},"drm":{"type":"object","properties":{"fairplay":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"FairPlayDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"uri":{"description":"Url of the licensing server","type":"string"}},"required":["iv","key","outputs"]}},"required":["properties"]}}},"aes":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AesEncryptionDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte Encryption key, 32 hexadecimal characters","type":"string"},"iv":{"description":"16 byte initialization vector","type":"string"},"keyFileUri":{"description":"Path relative to the output for referencing in the manifest. If this value is not set the key file will be written automatically to the output folder.","type":"string"},"method":{"enum":["SAMPLE_AES","AES_128"],"type":"string"}},"required":["key","method","outputs"]}},"required":["properties"]}}},"speke":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpekeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"contentId":{"description":"Unique Identifier of the content, will be generated if not set","type":"string"},"kid":{"description":"Optional key identifier, will be generated if not set.\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\nwill provide the same keys.\n","type":"string"},"iv":{"description":"16 byte initialization vector represented by a 32-character text string.\nIt is mandatory if systemIds contains AES128 or FairPlay.\n","type":"string"},"provider":{"type":"object","description":"Key provider configuration for SPEKE","properties":{"url":{"description":"URL of the endpoint","type":"string"},"username":{"description":"Your username for Basic Authentication","type":"string"},"password":{"description":"Your password for Basic Authentication","type":"string"},"apiKey":{"description":"Your API key for authentication via X-API-Key HTTP Header","type":"string"},"roleArn":{"description":"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\n\nDuring the key exchange the role will be assumed to be able to access the key provider.\n\nThis role is to be created in the customer's account and must be granted access to the\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\nhas to be added to the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\nommitted.\n\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"execute-api:Invoke\"\n ],\n \"Resource\": [\n \"arn:aws:execute-api:{{region}}:*:*/*/POST/*\"\n ]\n }\n ]\n}\n```\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\ngive the role access to all regions.\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume access to\nthe SPEKE server on AWS.\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"gatewayRegion":{"description":"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\nin the execute-api policy for the role as described in 'roleArn'.\n","type":"string"}},"required":["url"]},"systemIds":{"description":"DRM system identifier of the content protection scheme. At minimum one is expected.\nNot all systemIds are currently supported, support depends on the muxing type.\n\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\n","items":{"type":"string"},"type":"array"}},"required":["provider","systemIds","outputs"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"broadcastTs":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"BroadcastTsMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"segmentLength":{"description":"Length of the segments in seconds.","format":"double","type":"number"},"filename":{"description":"Name of the output file","type":"string"},"configuration":{"type":"object","properties":{"transport":{"type":"object","description":"Transport configuration details for the Broadcast TS muxing.","properties":{"muxrate":{"description":"Output rate in bps. The value zero implies to use minimal rate. The minimal rate leaves approximately 15kbps of null packets in the stream.","minimum":0,"maximum":1000000000,"format":"double","type":"number"},"stopOnError":{"type":"boolean","description":"Stop mux on errors. If true, implies halt multiplexing when any error is encountered. If false, errors are ignored and multiplexing continues. Note that the recovery from an error will usually result in an illegal transport stream and artifacts on a decoder."},"preventEmptyAdaptionFieldsInVideo":{"type":"boolean","description":"If true, prevents adaptation fields with length field equal to zero in video, i.e., zero-length AF. Please note that this condition can only occur when pesAlign for the input stream is set to true."},"patRepetitionRatePerSec":{"description":"Program Association Table (PAT) repetition rate per second. Number of PATs per second.","minimum":0.001,"maximum":1000,"format":"double","type":"number"},"pmtRepetitionRatePerSec":{"description":"Program Map Table (PMT) repetition rate per second. Number of PMTs for each program per second.","minimum":0.001,"maximum":1000,"format":"double","type":"number"},"variableMuxRate":{"type":"boolean","description":"When false, the output stream is created at a constant bit rate. When true, the output rate is allowed to vary from a maximum rate set by the muxrate parameter down to the minimum required to carry the stream."},"initialPresentationTimeStamp":{"description":"Presentation time stamp value for the first video frame. The timestamp is specified in the timescale of 90000","minimum":0,"maximum":5400000,"format":"double","type":"number"},"initialProgramClockReference":{"description":"Program Clock Reference value at the beginning of the first packet for the transport stream. The PCR is specified in the timescale of 90000","minimum":0,"maximum":2576980377600,"format":"double","type":"number"}}},"program":{"type":"object","description":"Program configuration details for the Broadcast TS muxing.","properties":{"programNumber":{"description":"An integer value. Value for program_number field in Program Map Table (PMT). The value zero is reserved for the NIT PID entry in the PAT.","minimum":1,"maximum":65535,"type":"integer"},"pidForPMT":{"description":"An integer value. Packet identifier (PID) to use for Program Map Table (PMT). Recommended value is 2 x programNumber.","minimum":10,"maximum":8190,"type":"integer"},"insertProgramClockRefOnPes":{"type":"boolean","description":"Insert Program Clock References (PCRs) on all packetized elemementary stream packets. When false, indicates that PCRs should be inserted on every PES header. This parameter is effective only when the PCR packet identifier is the same as a video or audio elementary stream."},"programClockRefInterval":{"description":"Interval between Program Clock References (PCRs) in milliseconds. Defines the period between PCR fields inserted in the stream. The default value is 90ms.","minimum":1,"maximum":100,"type":"integer"}}},"videoStreams":{"items":{"type":"object","title":"BroadcastTsVideoInputStreamConfiguration","properties":{"streamId":{"description":"The UUID of the stream to which this configuration belongs to. This has to be a ID of a stream that has been added to the current muxing.","type":"string"},"packetIdentifier":{"description":"An integer value. Packet Identifier (PID) for this stream.","minimum":16,"maximum":8190,"type":"integer"},"startWithDiscontinuityIndicator":{"type":"boolean","description":"Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID."},"alignPes":{"type":"boolean","description":"Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet."},"setRaiOnAu":{"enum":["NONE","ALL_PES_PACKETS","ACQUISITION_POINT_PACKETS","ACCORDING_TO_INPUT"],"type":"string"},"insertAccessUnitDelimiterInAvc":{"type":"boolean","description":"If true, add access unit delimiters (AUD) to AVC stream if AUD is missing from input elementary stream."},"maxDecodeDelay":{"description":"Maximum Decoder Delay in 90 KHz cycles. When non-zero, the difference between the PCR and the DTS for each picture as it is inserted into the output transport stream is limited to this number of 90 KHz cycles. Values below 1000 are treated as 0 and ignored. Valid Range [0, 1000-900000]","minimum":1000,"maximum":900000,"type":"integer"}}},"type":"array"},"audioStreams":{"items":{"type":"object","title":"BroadcastTsAudioInputStreamConfiguration","properties":{"streamId":{"description":"The UUID of the audio stream to which this configuration belongs to. This has to be an ID of an audio stream that has been added to the current muxing.","type":"string"},"packetIdentifier":{"description":"An integer value. Packet Identifier (PID) for this stream.","minimum":16,"maximum":8190,"type":"integer"},"startWithDiscontinuityIndicator":{"type":"boolean","description":"Start stream with initial discontinuity indicator set to one. If true, set the discontinuity indicator in the first packet for this PID."},"alignPes":{"type":"boolean","description":"Align access units to PES packets. If true, align access units to PES packet headers. Uses adaptation field stuffing to position an access unit at the beginning of each PES packet."},"setRaiOnAu":{"enum":["NONE","ALL_PES_PACKETS","ACQUISITION_POINT_PACKETS","ACCORDING_TO_INPUT"],"type":"string"},"useATSCBufferModel":{"type":"boolean","description":"Use ATSC buffer model for AC-3. If true, use the ATSC version of the T-STD buffer model is used. This parameter applies to AC-3 streams only."},"language":{"description":"Language of the audio stream. Specified according to the ISO 639-2 alpha code for the language descriptor.","type":"string"}},"required":["streamId"]},"type":"array"},"subtitleStreams":{"items":{"type":"object","title":"BroadcastTsSubtitleInputStreamConfiguration","properties":{"streamId":{"description":"The UUID of the subtitle stream to which this configuration belongs to. This has to be an ID of an subtitle stream that has been added to the current muxing.\n","type":"string"},"packetIdentifier":{"description":"An integer value. Packet Identifier (PID) for this stream.","minimum":16,"maximum":8190,"type":"integer"},"rate":{"description":"The rate parameter determines the maximum rate in bits per second that should be used for the subtitle stream. The valid range is `100` to `60 000 000` bps or `0`. If the value is set to 0, we will examine the first 100 packets of subtitle packet data and use the highest rate that was computed. If the value is set too low, not enough to accommodate the subtitle bit-rate, then some PES packets corresponding to DVB subtitle stream will be dropped. This parameter is optional and the default value is 0.\n","minimum":0,"maximum":60000000,"type":"integer"}}},"type":"array"}}}},"required":["streams"]}},"required":["properties"]}}},"progressiveWav":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ProgressiveWavMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file","type":"string"}},"required":["filename","streams"]}},"required":["properties"]}}},"progressiveWebm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ProgressiveWebmMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file","type":"string"},"manifestType":{"enum":["DASH_ON_DEMAND","NONE"],"type":"string"},"segmentLength":{"description":"Determines the length of segments in seconds if manifestType is set to DASH_ON_DEMAND. Defaults to 4 seconds","format":"double","type":"number"}},"required":["streams"]},"drm":{"type":"object","properties":{"cenc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CencDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"key":{"description":"16 byte encryption key, 32 hexadecimal characters","type":"string"},"kid":{"description":"16 byte encryption key id. Required for any other DRM but FairPlay","type":"string"},"encryptionMode":{"description":"The encryption method to use. Default is `CTR`","enum":["CTR","CBC"],"type":"string"},"ivSize":{"description":"Size of the initialization vector","enum":["8_BYTES","16_BYTES"],"type":"string"},"enablePiffCompatibility":{"type":"boolean","description":"Enables compatibility with the Protected Interoperable File Format (PIFF) specification"},"widevine":{"type":"object","description":"Configuration for Widevine DRM","properties":{"pssh":{"description":"Base64 encoded pssh payload","type":"string"}},"required":["pssh"]},"playReady":{"type":"object","description":"Configuration for PlayReady DRM","properties":{"laUrl":{"description":"Url of the license server. Either the laUrl or the pssh needs to be provided.","type":"string"},"pssh":{"description":"Base64 encoded pssh payload.","type":"string"},"additionalInformation":{"type":"object","properties":{"wrmHeaderCustomAttributes":{"description":"Custom attributes that you want to add to the WRM header. This string must be valid xml. Some DRM providers require some information in the custom attributes of the msr:pro tag of the DASH manifest, otherwise the content does not play on certain devices.","type":"string"}}}}},"marlin":{"type":"object","description":"Configuration for Marlin DRM"},"fairPlay":{"type":"object","description":"Configuration for FairPlay DRM","properties":{"iv":{"description":"Initialization vector as hexadecimal string","type":"string"},"uri":{"description":"URL of the licensing server. Typically starts with a skd://. Please check with your DRM provider on their required format.","type":"string"}}}},"required":["encryptionMode","key","outputs"]}},"required":["properties"]}}},"speke":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpekeDrm","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"contentId":{"description":"Unique Identifier of the content, will be generated if not set","type":"string"},"kid":{"description":"Optional key identifier, will be generated if not set.\nFor SPEKE DRM Configurations with the same contentId and kid the key provider\nwill provide the same keys.\n","type":"string"},"iv":{"description":"16 byte initialization vector represented by a 32-character text string.\nIt is mandatory if systemIds contains AES128 or FairPlay.\n","type":"string"},"provider":{"type":"object","description":"Key provider configuration for SPEKE","properties":{"url":{"description":"URL of the endpoint","type":"string"},"username":{"description":"Your username for Basic Authentication","type":"string"},"password":{"description":"Your password for Basic Authentication","type":"string"},"apiKey":{"description":"Your API key for authentication via X-API-Key HTTP Header","type":"string"},"roleArn":{"description":"AWS role that will be assumed for the key exchange in case the provider runs on AWS.\n\nDuring the key exchange the role will be assumed to be able to access the key provider.\n\nThis role is to be created in the customer's account and must be granted access to the\nAPI Gateway of the SPEKE server. For Bitmovin to be able to assume this role, the following\nhas to be added to the trust policy of the role:\n\n```\n{\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerSpekeAccess\"\n },\n \"Action\": \"sts:AssumeRole\",\n \"Condition\": {\n \"StringEquals\": {\n \"sts:ExternalId\": \"{{externalId}}\"\n }\n }\n}\n```\nIt is recommended to also set the {{externalId}} due to security reasons but it can also be\nommitted.\n\nAdditionally the role needs a policy similar to the following to be able to invoke the API gateway:\n```\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": [\n \"execute-api:Invoke\"\n ],\n \"Resource\": [\n \"arn:aws:execute-api:{{region}}:*:*/*/POST/*\"\n ]\n }\n ]\n}\n```\nwhere `{{region}}` is the region of the API gateway (for example `us-west-2`), the same has\nto be set in the property 'gatewayRegion'. It's also possible to set `{{region}` to `*` to\ngive the role access to all regions.\n","type":"string"},"externalId":{"description":"External ID used together with the IAM role identified by `roleArn` to assume access to\nthe SPEKE server on AWS.\n","type":"string"},"externalIdMode":{"enum":["CUSTOM","GLOBAL","GENERATED"],"type":"string"},"gatewayRegion":{"description":"Describes the region of the AWS API Gateway that is used to access the SPEKE server.\nThis property is mandatory when setting 'roleArn' and has to indicate in which region\nthe AWS API Gateway is setup. This usually corresponds to the `{{region}}` one sets\nin the execute-api policy for the role as described in 'roleArn'.\n","type":"string"}},"required":["url"]},"systemIds":{"description":"DRM system identifier of the content protection scheme. At minimum one is expected.\nNot all systemIds are currently supported, support depends on the muxing type.\n\nRelates to SPEKE implementation. See https://dashif.org/identifiers/content_protection/\n","items":{"type":"string"},"type":"array"}},"required":["provider","systemIds","outputs"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"progressiveMov":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ProgressiveMovMuxing","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"streams":{"items":{"type":"object","title":"MuxingStream","properties":{"streamId":{"type":"string"}},"required":["streamId"]},"type":"array"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"streamConditionsMode":{"description":"Specifies how to proceed with the Muxing when some of its Streams are ignored (see 'condition' property of the Stream resource). The settings only make a difference for Muxings with more than one Stream. When retrieving the resource after the analysis step of the encoding has finished, 'ignoredBy' will indicate if and why it has been ignored.","enum":["DROP_MUXING","DROP_STREAM"],"type":"string"},"filename":{"description":"Name of the output file","type":"string"}},"required":["streams"]}},"required":["properties"]}}}}},"captions":{"type":"object","properties":{"scc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ConvertSccCaption","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"input":{"type":"object","description":"The input location to get the scc file from","properties":{"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to media file","type":"string"}},"required":["inputId","inputPath"]},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"fileName":{"description":"Name of the captions file","type":"string"},"outputFormat":{"enum":["WEBVTT"],"type":"string"},"webVttSettings":{"type":"object","description":"Optional settings when converting SCC to WebVTT","properties":{"positionMode":{"title":"ConvertSccPositionMode","enum":["FULL","SIMPLE","NONE"],"type":"string"},"removeFlash":{"type":"boolean","description":"Remove flash (blinking) information when converting SCC to WebVTT"},"removeColor":{"type":"boolean","description":"Remove color information when converting SCC to WebVTT"}}}},"required":["fileName","input","outputFormat","outputs"]}},"required":["properties"]}}}}},"sidecars":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SidecarFile","description":"A file that is added to an encoding. The size limit for a sidecar file is 10 MB","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to sidecar file","type":"string"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"errorMode":{"description":"This defines how errors should be handled","enum":["FAIL_ON_ERROR","CONTINUE_ON_ERROR"],"type":"string"}},"required":["inputId","inputPath"]},"webvtt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"WebVttSidecarFile","description":"An external WebVTT file that is added to an encoding. The size limit for a sidecar file is 10 MB","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"inputId":{"description":"Id of input","type":"string"},"inputPath":{"description":"Path to sidecar file","type":"string"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"errorMode":{"description":"This defines how errors should be handled","enum":["FAIL_ON_ERROR","CONTINUE_ON_ERROR"],"type":"string"},"segmentation":{"type":"object","properties":{"segmentLength":{"description":"The length of the WebVTT fragments in seconds","format":"double","type":"number"}},"required":["segmentLength"]}},"required":["inputId","inputPath"]}},"required":["properties"]}}}},"required":["properties"]}}},"keyframes":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Keyframe","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"time":{"description":"Time in seconds where the keyframe should be inserted","format":"double","type":"number"}},"required":["time"]}},"required":["properties"]}}},"scte35Triggers":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Scte35Trigger","properties":{"time":{"description":"Time in seconds where the SCTE 35 trigger should be inserted","format":"double","type":"number"},"base64EncodedMetadata":{"description":"The base 64 encoded data for the SCTE trigger","type":"string"}},"required":["base64EncodedMetadata","time"]}},"required":["properties"]}}},"start":{"type":"object","properties":{"properties":{"type":"object","title":"StartEncodingRequest","properties":{"trimming":{"type":"object","description":"Allows to encode only part of the input. Defines start (offset) and duration of the desired section. This is not allowed when the Encoding uses any kind of Input Stream resource.","properties":{"offset":{"description":"Defines the offset in seconds from which the encoding should start, beginning at 0.","minimum":0,"format":"double","type":"number"},"duration":{"description":"Defines how many seconds from the input will be encoded. If not set, the input will be encoded until its end.","minimum":0,"format":"double","type":"number"},"ignoreDurationIfInputTooShort":{"type":"boolean","description":"When true, \"duration\" will be interpreted as a maximum and not cause an error if the input is too short"},"startPicTiming":{"description":"Defines the H264 picture timing of the first frame from which the encoding should start. Any defined offset or duration in seconds will be ignored.","type":"string"},"endPicTiming":{"description":"Defines the H264 picture timing of the last frame, that will be included in the encoding. Any defined offset or duration in seconds will be ignored.","type":"string"}}},"scheduling":{"type":"object","description":"Scheduling parameters of the encoding.","properties":{"priority":{"description":"Specifies the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.","minimum":0,"maximum":100,"type":"integer"},"prewarmedEncoderPoolIds":{"description":"List of prewarmed encoder pools. If set, prewarmed encoders from pools with these IDs will be used for the encoding if available. The pool IDs will be tried in the order in which they are passed.","items":{"type":"string"},"type":"array"}}},"tweaks":{"type":"object","description":"Special tweaks for your encoding job.","properties":{"audioVideoSyncMode":{"description":"Different modes for syncing the start and end of audio input streams with the video inputs.\nThis feature does not work with Dolby Digital (Plus) or Dolby Atmos.","enum":["STANDARD","RESYNC_AT_START","RESYNC_AT_START_AND_END"],"type":"string"}}},"handleVariableInputFps":{"type":"boolean","description":"Enable frame dropping/duplication to handle variable frames per seconds of video input streams"},"encodingMode":{"description":"The pass mode of the encoding. Must only be set when `encodingMode` is not set on any codec configuration used by this encoding.","enum":["STANDARD","SINGLE_PASS","TWO_PASS","THREE_PASS"],"type":"string"},"previewDashManifests":{"description":"DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"ManifestResource","properties":{"manifestId":{"description":"Id of the manifest resource","type":"string"}},"required":["manifestId"]},"type":"array"},"previewHlsManifests":{"description":"HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"ManifestResource","properties":{"manifestId":{"description":"Id of the manifest resource","type":"string"}},"required":["manifestId"]},"type":"array"},"vodDashManifests":{"description":"DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"ManifestResource","properties":{"manifestId":{"description":"Id of the manifest resource","type":"string"}},"required":["manifestId"]},"type":"array"},"vodHlsManifests":{"description":"HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"ManifestResource","properties":{"manifestId":{"description":"Id of the manifest resource","type":"string"}},"required":["manifestId"]},"type":"array"},"vodSmoothManifests":{"description":"Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)","items":{"type":"object","title":"ManifestResource","properties":{"manifestId":{"description":"Id of the manifest resource","type":"string"}},"required":["manifestId"]},"type":"array"},"manifestGenerator":{"description":"Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\n","enum":["LEGACY","V2"],"type":"string"},"perTitle":{"type":"object","description":"Per-Title settings","properties":{"h264Configuration":{"type":"object","description":"Per-Title configuration for H264","properties":{"minBitrate":{"description":"The minimum bitrate that will be used by the Per-Title algorithm.","type":"integer"},"maxBitrate":{"description":"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.","type":"integer"},"minBitrateStepSize":{"description":"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000","format":"double","type":"number"},"maxBitrateStepSize":{"description":"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000","format":"double","type":"number"},"autoRepresentations":{"type":"object","properties":{"adoptConfigurationThreshold":{"description":"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.","format":"double","type":"number"}}},"complexityFactor":{"description":"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition","minimum":0,"format":"double","type":"number"},"fixedResolutionAndBitrateConfiguration":{"type":"object","description":"Additional configuration for fixed resolution and bitrate templates","properties":{"forcedRenditionAboveHighestFixedRepresentation":{"description":"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.","minimum":1,"type":"integer"},"forcedRenditionAboveHighestFixedRepresentationFactor":{"description":"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.","format":"double","type":"number"},"forcedRenditionAboveHighestFixedRepresentationCalculationMode":{"description":"Mode to calculate the bitrate of the next representation","enum":["LAST_CALCULATED_BITRATE","MINIMUM","MAXIMUM","AVERAGE"],"type":"string"}}},"resolutionScaleFactor":{"description":"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.","format":"double","type":"number"},"codecMinBitrateFactor":{"description":"This factor doesn't have any impact!","format":"double","type":"number"},"codecMaxBitrateFactor":{"description":"This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate","format":"double","type":"number"},"codecBufsizeFactor":{"description":"This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate","format":"double","type":"number"},"targetQualityCrf":{"description":"Desired target quality of the highest representation expressed as CRF value","format":"double","type":"number"}}},"h265Configuration":{"type":"object","description":"Per-Title configuration for H265","properties":{"minBitrate":{"description":"The minimum bitrate that will be used by the Per-Title algorithm.","type":"integer"},"maxBitrate":{"description":"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.","type":"integer"},"minBitrateStepSize":{"description":"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000","format":"double","type":"number"},"maxBitrateStepSize":{"description":"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000","format":"double","type":"number"},"autoRepresentations":{"type":"object","properties":{"adoptConfigurationThreshold":{"description":"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.","format":"double","type":"number"}}},"complexityFactor":{"description":"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition","minimum":0,"format":"double","type":"number"},"fixedResolutionAndBitrateConfiguration":{"type":"object","description":"Additional configuration for fixed resolution and bitrate templates","properties":{"forcedRenditionAboveHighestFixedRepresentation":{"description":"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.","minimum":1,"type":"integer"},"forcedRenditionAboveHighestFixedRepresentationFactor":{"description":"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.","format":"double","type":"number"},"forcedRenditionAboveHighestFixedRepresentationCalculationMode":{"description":"Mode to calculate the bitrate of the next representation","enum":["LAST_CALCULATED_BITRATE","MINIMUM","MAXIMUM","AVERAGE"],"type":"string"}}},"resolutionScaleFactor":{"description":"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.","format":"double","type":"number"},"codecMinBitrateFactor":{"description":"This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate","format":"double","type":"number"},"codecMaxBitrateFactor":{"description":"This factor is used to calculate the maxBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate","format":"double","type":"number"},"codecBufsizeFactor":{"description":"This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate","format":"double","type":"number"},"targetQualityCrf":{"description":"Desired target quality of the highest representation expressed as CRF value","format":"double","type":"number"}}},"vp9Configuration":{"type":"object","description":"Per-Title configuration for VP9","properties":{"minBitrate":{"description":"The minimum bitrate that will be used by the Per-Title algorithm.","type":"integer"},"maxBitrate":{"description":"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.","type":"integer"},"minBitrateStepSize":{"description":"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000","format":"double","type":"number"},"maxBitrateStepSize":{"description":"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000","format":"double","type":"number"},"autoRepresentations":{"type":"object","properties":{"adoptConfigurationThreshold":{"description":"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.","format":"double","type":"number"}}},"complexityFactor":{"description":"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition","minimum":0,"format":"double","type":"number"},"fixedResolutionAndBitrateConfiguration":{"type":"object","description":"Additional configuration for fixed resolution and bitrate templates","properties":{"forcedRenditionAboveHighestFixedRepresentation":{"description":"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.","minimum":1,"type":"integer"},"forcedRenditionAboveHighestFixedRepresentationFactor":{"description":"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.","format":"double","type":"number"},"forcedRenditionAboveHighestFixedRepresentationCalculationMode":{"description":"Mode to calculate the bitrate of the next representation","enum":["LAST_CALCULATED_BITRATE","MINIMUM","MAXIMUM","AVERAGE"],"type":"string"}}},"resolutionScaleFactor":{"description":"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.","format":"double","type":"number"},"targetQualityCrf":{"description":"Desired target quality of the highest representation expressed as CRF value","format":"double","type":"number"}}},"av1Configuration":{"type":"object","description":"Per-Title configuration for AV1","properties":{"minBitrate":{"description":"The minimum bitrate that will be used by the Per-Title algorithm.","type":"integer"},"maxBitrate":{"description":"The maximum bitrate that will be used by the Per-Title algorithm. It will not generate any rendition with a higher bitrate.","type":"integer"},"minBitrateStepSize":{"description":"The minimum ratio between the bitrates of generated renditions, e.g. if the first bitrate is 240,000, a minimum ratio of 1.5 will require the next higher bitrate to be at least 360,000","format":"double","type":"number"},"maxBitrateStepSize":{"description":"The maximum ratio between the bitrates of neighbouring renditions, e.g., if the first bitrate is 240,000, a maximum ratio of 1.9 will require the next higher bitrate to be at most 456,000","format":"double","type":"number"},"autoRepresentations":{"type":"object","properties":{"adoptConfigurationThreshold":{"description":"This is the threshold that determines whether the settings of the lower or the upper template representation (codec configuration) should be used, when representations are added automatically. The value must be between 0 and 1. Values nearer 0 will favour the higher representation, values nearer 1 will favour the lower representation.","format":"double","type":"number"}}},"complexityFactor":{"description":"Will modify the assumed complexity for the Per-Title algorithm (> 0.0). Values higher than 1 will increase complexity and thus select smaller resolutions for given bitrates. This will also result in a higher bitrate for the top rendition. Values lower than 1 will decrease assumed complexity and thus select higher resolutions for given bitrates and also decrease the bitrate of the top rendition","minimum":0,"format":"double","type":"number"},"fixedResolutionAndBitrateConfiguration":{"type":"object","description":"Additional configuration for fixed resolution and bitrate templates","properties":{"forcedRenditionAboveHighestFixedRepresentation":{"description":"Number of forced renditions above the highest fixed representation (e.g. FIXED_RESOLUTION_AND_BITRATE). Forced renditions will be added, also if the Per-Title algorithm chooses the user defined force rendition to be the highest one.","minimum":1,"type":"integer"},"forcedRenditionAboveHighestFixedRepresentationFactor":{"description":"The factor to calculate the bitrate that will be chosen based on the bitrate of the last FIXED_RESOLUTION.","format":"double","type":"number"},"forcedRenditionAboveHighestFixedRepresentationCalculationMode":{"description":"Mode to calculate the bitrate of the next representation","enum":["LAST_CALCULATED_BITRATE","MINIMUM","MAXIMUM","AVERAGE"],"type":"string"}}},"resolutionScaleFactor":{"description":"This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.","format":"double","type":"number"},"targetQualityCrf":{"description":"Desired target quality of the highest representation expressed as CRF value","format":"double","type":"number"}}}}},"aiSceneAnalysis":{"type":"object","description":"AI scene analysis settings","properties":{"aiService":{"type":"object","description":"AI service settings","properties":{"provider":{"description":"AI service provider","enum":["GOOGLE"],"type":"string"}}},"features":{"type":"object","description":"Features of the AI scene analysis","properties":{"assetDescription":{"type":"object","description":"AI scene analysis will create an asset description file.\n","properties":{"filename":{"description":"Name of the output json file","type":"string"},"outputs":{"items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"}}},"automaticAdPlacement":{"type":"object","description":"Ad markers placed on detected scene changes and configured positions.\n","properties":{"schedule":{"description":"Ad placements schedule\n","items":{"type":"object","title":"AutomaticAdPlacementPosition","properties":{"position":{"description":"Position of the ad placement in seconds.","format":"double","type":"number"},"maxDeviation":{"description":"Maximum deviation in seconds to the ad placement position.","format":"double","type":"number"},"duration":{"description":"The desired duration in seconds of the ad to be inserted.","minimum":0,"format":"double","type":"number"}}},"type":"array"}}}}}}}}}},"required":["properties"]},"reprioritize":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ReprioritizeEncodingRequest","properties":{"priority":{"description":"Priority of the Encoding","minimum":0,"maximum":100,"type":"integer"}},"required":["priority"]}},"required":["properties"]}}},"reschedule":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"RescheduleEncodingRequest","properties":{"infrastructureId":{"description":"Id of a custom infrastructure, e.g., AWS Cloud Connect","type":"string"}}}},"required":["properties"]}}}},"required":["properties"],"oneOf":[{"required":["start"]},{"required":["live"]}]}}},"live":{"type":"object","properties":{"streamKeys":{"type":"object","properties":{"actions":{"type":"object","properties":{"unassign":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"StreamKeysUnassignAction","properties":{"encodingId":{"description":"Encoding ID for which stream keys should be unassigned","type":"string"}}}},"required":["properties"]}}}}}},"patternProperties":{"^(?!.*\\b(?:actions)\\b)[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"StreamKey","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"value":{"description":"Stream key used for live streaming. This stream key is reserved and can be re-used with different live encodings.\nIf this value is not provided, a unique random stream key will be generated.\n**Important:** This value has to be globally unique. If it is set manually, be sure to use a secure value.\nIf the stream key value is guessed by others your live encoding can be compromised.\n","type":"string"},"status":{"description":"Status of the stream key","enum":["ASSIGNED","UNASSIGNED"],"type":"string"},"type":{"description":"Type of the stream key","enum":["RESERVED","TEMPORARY"],"type":"string"}}}}}}},"standbyPools":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"LiveStandbyPoolRequest","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"targetPoolSize":{"description":"Number of instances to keep ready for streaming while the pool is running","minimum":0,"type":"integer"},"encodingTemplate":{"description":"Base64 encoded template used to start the encodings in the pool","type":"string"}},"required":["encodingTemplate","targetPoolSize"]}},"required":["properties"]}}}}},"manifests":{"type":"object","properties":{"dash":{"type":"object","properties":{"defaultapi":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashManifestDefault","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"enum":["DASH","HLS","SMOOTH_STREAMING"],"type":"string"},"outputs":{"description":"The outputs to store the manifest","items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"status":{"description":"Current status","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"generatorVersion":{"description":"The version of the generator used to create the manifest","enum":["LEGACY","V2"],"type":"string"},"profile":{"description":"Determines if segmented or progressive representations can appear in the manifest","enum":["LIVE","ON_DEMAND"],"type":"string"},"manifestName":{"description":"The filename of your manifest","type":"string"},"namespaces":{"description":"List of additional XML namespaces to add to the DASH Manifest","items":{"type":"object","title":"XmlNamespace","properties":{"prefix":{"description":"Name of the XML Namespace reference","type":"string"},"uri":{"description":"Source of the XML Namespace reference","type":"string"}},"required":["prefix","uri"]},"type":"array"},"utcTimings":{"description":"List of UTC Timings to use for live streaming","items":{"type":"object","title":"UtcTiming","properties":{"value":{"description":"The server to get the time from","type":"string"},"schemeIdUri":{"description":"The scheme id to use. Please refer to the DASH standard.","type":"string"}},"required":["schemeIdUri","value"]},"type":"array"},"dashEditionCompatibility":{"description":"The manifest compatibility with the standard DASH Edition.","enum":["V4"],"type":"string"},"iso8601TimestampFormat":{"description":"Determines how timestamps should appear in the manifest","enum":["LONG","SHORT"],"type":"string"},"encodingId":{"description":"The id of the encoding to create a default manifest for. Either \"encodingId\" or \"periods\" is required.","type":"string"},"version":{"description":"Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the \"manifestGenerator\" version of the \"Start\" request.","enum":["V1","V2"],"type":"string"},"periods":{"description":"Adds a period for every item. Can only be used when setting \"version\" to \"V2\". Either \"periods\" or \"encodingId\" is required.","items":{"type":"object","title":"DefaultDashManifestPeriod","properties":{"encodingIds":{"description":"List the encoding ids for which the conditions should apply","items":{"type":"string"},"type":"array"},"adaptationSets":{"description":"Adds an adaption set for every item to the period","items":{"type":"object","title":"DefaultManifestCondition"},"type":"array"}}},"type":"array"}},"required":["outputs"]}},"required":["properties"]}}}},"patternProperties":{"^(?!.*\\b(?:defaultapi)\\b)[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashManifest","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"enum":["DASH","HLS","SMOOTH_STREAMING"],"type":"string"},"outputs":{"description":"The outputs to store the manifest","items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"status":{"description":"Current status","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"generatorVersion":{"description":"The version of the generator used to create the manifest","enum":["LEGACY","V2"],"type":"string"},"profile":{"description":"Determines if segmented or progressive representations can appear in the manifest","enum":["LIVE","ON_DEMAND"],"type":"string"},"manifestName":{"description":"The filename of your manifest","type":"string"},"namespaces":{"description":"List of additional XML namespaces to add to the DASH Manifest","items":{"type":"object","title":"XmlNamespace","properties":{"prefix":{"description":"Name of the XML Namespace reference","type":"string"},"uri":{"description":"Source of the XML Namespace reference","type":"string"}},"required":["prefix","uri"]},"type":"array"},"utcTimings":{"description":"List of UTC Timings to use for live streaming","items":{"type":"object","title":"UtcTiming","properties":{"value":{"description":"The server to get the time from","type":"string"},"schemeIdUri":{"description":"The scheme id to use. Please refer to the DASH standard.","type":"string"}},"required":["schemeIdUri","value"]},"type":"array"},"dashEditionCompatibility":{"description":"The manifest compatibility with the standard DASH Edition.","enum":["V4"],"type":"string"},"iso8601TimestampFormat":{"description":"Determines how timestamps should appear in the manifest","enum":["LONG","SHORT"],"type":"string"}},"required":["outputs"]},"periods":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"Period","properties":{"start":{"description":"Starting time in seconds","format":"double","type":"number"},"duration":{"description":"Duration in seconds.<br/>Please note that the duration of a Period is usually determined by the media contained therein.<br/>Setting the `duration` property to a specific value will override this default behaviour.<br/>Warning: Use at your own risk!","format":"double","type":"number"}}},"customXmlElements":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CustomXmlElement","properties":{"data":{"description":"String representation of the XML element","type":"string"}},"required":["data"]}},"required":["properties"]}}},"adaptationsets":{"type":"object","properties":{"audio":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AudioAdaptationSet","properties":{"customAttributes":{"description":"Custom adaptation set attributes","items":{"type":"object","title":"CustomAttribute","properties":{"key":{"description":"unique string identifier for the custom attribute","type":"string"},"value":{"description":"value of the custom attribute","type":"string"}},"required":["key"]},"type":"array"},"roles":{"description":"Roles of the adaptation set","items":{"type":"string","title":"AdaptationSetRole"},"type":"array"},"accessibilities":{"description":"Provide signaling of CEA 607 and CEA 708","items":{"type":"object","title":"Accessibility","properties":{"value":{"description":"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)","type":"string"},"schemeIdUri":{"description":"The scheme id to use. Please refer to the DASH standard.","type":"string"}},"required":["schemeIdUri","value"]},"type":"array"},"labels":{"description":"List of labels","items":{"type":"object","title":"Label","properties":{"id":{"description":"Identifier of the label.","minimum":0,"type":"integer"},"lang":{"description":"Specifies the language of the label.","type":"string"},"value":{"description":"Content of the label.","type":"string"}},"required":["value"]},"type":"array"},"lang":{"description":"ISO 639-1 (Alpha-2) code identifying the language of the audio adaptation set","type":"string"}},"required":["lang"]}},"required":["properties"]}}},"video":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"VideoAdaptationSet","properties":{"customAttributes":{"description":"Custom adaptation set attributes","items":{"type":"object","title":"CustomAttribute","properties":{"key":{"description":"unique string identifier for the custom attribute","type":"string"},"value":{"description":"value of the custom attribute","type":"string"}},"required":["key"]},"type":"array"},"roles":{"description":"Roles of the adaptation set","items":{"type":"string","title":"AdaptationSetRole"},"type":"array"},"accessibilities":{"description":"Provide signaling of CEA 607 and CEA 708","items":{"type":"object","title":"Accessibility","properties":{"value":{"description":"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)","type":"string"},"schemeIdUri":{"description":"The scheme id to use. Please refer to the DASH standard.","type":"string"}},"required":["schemeIdUri","value"]},"type":"array"},"labels":{"description":"List of labels","items":{"type":"object","title":"Label","properties":{"id":{"description":"Identifier of the label.","minimum":0,"type":"integer"},"lang":{"description":"Specifies the language of the label.","type":"string"},"value":{"description":"Content of the label.","type":"string"}},"required":["value"]},"type":"array"}}}},"required":["properties"]}}},"subtitle":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SubtitleAdaptationSet","properties":{"customAttributes":{"description":"Custom adaptation set attributes","items":{"type":"object","title":"CustomAttribute","properties":{"key":{"description":"unique string identifier for the custom attribute","type":"string"},"value":{"description":"value of the custom attribute","type":"string"}},"required":["key"]},"type":"array"},"roles":{"description":"Roles of the adaptation set","items":{"type":"string","title":"AdaptationSetRole"},"type":"array"},"accessibilities":{"description":"Provide signaling of CEA 607 and CEA 708","items":{"type":"object","title":"Accessibility","properties":{"value":{"description":"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)","type":"string"},"schemeIdUri":{"description":"The scheme id to use. Please refer to the DASH standard.","type":"string"}},"required":["schemeIdUri","value"]},"type":"array"},"labels":{"description":"List of labels","items":{"type":"object","title":"Label","properties":{"id":{"description":"Identifier of the label.","minimum":0,"type":"integer"},"lang":{"description":"Specifies the language of the label.","type":"string"},"value":{"description":"Content of the label.","type":"string"}},"required":["value"]},"type":"array"},"lang":{"description":"ISO 639-1 (Alpha-2) code identifying the language of the subtitle adaptation set","type":"string"}},"required":["lang"]}},"required":["properties"]}}},"image":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ImageAdaptationSet","properties":{"customAttributes":{"description":"Custom adaptation set attributes","items":{"type":"object","title":"CustomAttribute","properties":{"key":{"description":"unique string identifier for the custom attribute","type":"string"},"value":{"description":"value of the custom attribute","type":"string"}},"required":["key"]},"type":"array"},"roles":{"description":"Roles of the adaptation set","items":{"type":"string","title":"AdaptationSetRole"},"type":"array"},"accessibilities":{"description":"Provide signaling of CEA 607 and CEA 708","items":{"type":"object","title":"Accessibility","properties":{"value":{"description":"Can be either list of languages or a complete map of services (or CC channels, in CEA-608 terminology)","type":"string"},"schemeIdUri":{"description":"The scheme id to use. Please refer to the DASH standard.","type":"string"}},"required":["schemeIdUri","value"]},"type":"array"},"labels":{"description":"List of labels","items":{"type":"object","title":"Label","properties":{"id":{"description":"Identifier of the label.","minimum":0,"type":"integer"},"lang":{"description":"Specifies the language of the label.","type":"string"},"value":{"description":"Content of the label.","type":"string"}},"required":["value"]},"type":"array"}}}},"required":["properties"]}}},"representations":{"type":"object","properties":{"vtt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashVttRepresentation","properties":{"vttUrl":{"description":"URL of the referenced VTT file","type":"string"}},"required":["vttUrl"]}},"required":["properties"]}}},"imsc":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashImscRepresentation","properties":{"imscUrl":{"description":"URL of the referenced IMSC file","type":"string"}},"required":["imscUrl"]}},"required":["properties"]}}},"sprite":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SpriteRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"streamId":{"description":"UUID of a stream","type":"string"},"spriteId":{"description":"UUID of a Sprite","type":"string"},"segmentPath":{"description":"Path to sprite segments. Will be used as the representation id in the manifest.","type":"string"}},"required":["encodingId","segmentPath","spriteId","streamId"]}},"required":["properties"]}}},"fmp4":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashFmp4Representation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"type":{"enum":["TEMPLATE","LIST","TIMELINE"],"type":"string"},"mode":{"enum":["TEMPLATE_REPRESENTATION","TEMPLATE_ADAPTATION_SET"],"type":"string"},"segmentPath":{"description":"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET","type":"string"},"startSegmentNumber":{"description":"Number of the first segment","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded","type":"integer"},"startKeyframeId":{"description":"Id of the keyframe to start with. It takes precedence over startSegmentNumber","type":"string"},"endKeyframeId":{"description":"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.","type":"string"}},"required":["segmentPath","type","encodingId","muxingId"]},"drm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashFmp4DrmRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"type":{"enum":["TEMPLATE","LIST","TIMELINE"],"type":"string"},"mode":{"enum":["TEMPLATE_REPRESENTATION","TEMPLATE_ADAPTATION_SET"],"type":"string"},"segmentPath":{"description":"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET","type":"string"},"startSegmentNumber":{"description":"Number of the first segment","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded","type":"integer"},"startKeyframeId":{"description":"Id of the keyframe to start with. It takes precedence over startSegmentNumber","type":"string"},"endKeyframeId":{"description":"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.","type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","segmentPath","type","encodingId","muxingId"]},"contentprotection":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ContentProtection","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","encodingId","muxingId"]}},"required":["properties"]}}}},"required":["properties"]}}},"contentprotection":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ContentProtection","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","encodingId","muxingId"]}},"required":["properties"]}}}},"required":["properties"]}}},"chunkedText":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashChunkedTextRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"type":{"enum":["TEMPLATE","LIST","TIMELINE"],"type":"string"},"mode":{"enum":["TEMPLATE_REPRESENTATION","TEMPLATE_ADAPTATION_SET"],"type":"string"},"segmentPath":{"description":"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET","type":"string"},"startSegmentNumber":{"description":"Number of the first segment","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded","type":"integer"},"startKeyframeId":{"description":"Id of the keyframe to start with. It takes precedence over startSegmentNumber","type":"string"},"endKeyframeId":{"description":"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.","type":"string"}},"required":["segmentPath","type","encodingId","muxingId"]}},"required":["properties"]}}},"cmaf":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashCmafRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"type":{"enum":["TEMPLATE","LIST","TIMELINE"],"type":"string"},"mode":{"enum":["TEMPLATE_REPRESENTATION","TEMPLATE_ADAPTATION_SET"],"type":"string"},"segmentPath":{"description":"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET","type":"string"},"startSegmentNumber":{"description":"Number of the first segment","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded","type":"integer"},"startKeyframeId":{"description":"Id of the keyframe to start with. It takes precedence over startSegmentNumber","type":"string"},"endKeyframeId":{"description":"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.","type":"string"}},"required":["segmentPath","type","encodingId","muxingId"]},"contentprotection":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ContentProtection","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","encodingId","muxingId"]}},"required":["properties"]}}}},"required":["properties"]}}},"mp4":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashMp4Representation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"filePath":{"description":"Path to the MP4 file","type":"string"},"type":{"description":"The type of the dash representation","enum":["SEGMENT_BASE","SEGMENT_LIST"],"type":"string"}},"required":["filePath","encodingId","muxingId"]},"drm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashMp4DrmRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"filePath":{"description":"Path to the MP4 file","type":"string"},"type":{"description":"The type of the dash representation","enum":["SEGMENT_BASE","SEGMENT_LIST"],"type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","filePath","encodingId","muxingId"]}},"required":["properties"]}}}},"required":["properties"]}}},"webm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashWebmRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"type":{"enum":["TEMPLATE","LIST","TIMELINE"],"type":"string"},"mode":{"enum":["TEMPLATE_REPRESENTATION","TEMPLATE_ADAPTATION_SET"],"type":"string"},"segmentPath":{"description":"Path to segments. Will be used as the representation id if the type is set to TEMPLATE_ADAPTATION_SET","type":"string"},"startSegmentNumber":{"description":"Number of the first segment","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded","type":"integer"},"startKeyframeId":{"description":"Id of the keyframe to start with. It takes precedence over startSegmentNumber","type":"string"},"endKeyframeId":{"description":"Id of the keyframe to end with. It takes precedence over endSegmentNumber. The segment containing the end keyframe is not included in the representation.","type":"string"}},"required":["segmentPath","type","encodingId","muxingId"]},"contentprotection":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ContentProtection","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","encodingId","muxingId"]}},"required":["properties"]}}}},"required":["properties"]}}},"progressiveWebm":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"DashProgressiveWebmRepresentation","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"filePath":{"description":"Path to the Progressive WebM file","type":"string"}},"required":["filePath","encodingId","muxingId"]}},"required":["properties"]}}}}},"contentprotection":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ContentProtection","properties":{"encodingId":{"description":"UUID of an encoding","type":"string"},"muxingId":{"description":"UUID of a muxing","type":"string"},"dependencyId":{"description":"Used to signal a dependency with another representation. The representation may belong to a different adaptation set","type":"string"},"drmId":{"description":"DRM Id","type":"string"}},"required":["drmId","encodingId","muxingId"]}},"required":["properties"]}}}}}},"required":["properties"]}}},"start":{"type":"object","properties":{"properties":{"type":"object","title":"StartManifestRequest","properties":{"manifestGenerator":{"description":"Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions:\n2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\n","enum":["LEGACY","V2"],"type":"string"}}}},"required":["properties"]}}}}},"hls":{"type":"object","properties":{"defaultapi":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HlsManifestDefault","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"enum":["DASH","HLS","SMOOTH_STREAMING"],"type":"string"},"outputs":{"description":"The outputs to store the manifest","items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"status":{"description":"Current status","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"generatorVersion":{"description":"The version of the generator used to create the manifest","enum":["LEGACY","V2"],"type":"string"},"manifestName":{"description":"The filename of your manifest. If this is not set, the `name` is used as output file name. Either one of `name` or `manifestName` is required. Be aware that spaces will be replaced with underlines (`_`) on the output.","type":"string"},"hlsMediaPlaylistVersion":{"description":"If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version","enum":["3","4","5","6","7","8"],"type":"string"},"hlsMasterPlaylistVersion":{"description":"If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version","enum":["3","4","5","6","7","8"],"type":"string"},"channelsAttributeForAudio":{"description":"Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag","enum":["ALWAYS","STANDARD_CONFORM","LEGACY"],"type":"string"},"targetDurationRoundingMode":{"description":"The rounding applied to target duration.\nTwo possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer,\nor UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.\n","enum":["UPWARD_ROUNDING","NORMAL_ROUNDING"],"type":"string"},"encodingId":{"description":"The id of the encoding to create a default manifest for","type":"string"},"version":{"description":"Currently not in use","enum":["V1"],"type":"string"}},"required":["encodingId","outputs"]}},"required":["properties"]}}}},"patternProperties":{"^(?!.*\\b(?:defaultapi)\\b)[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"HlsManifest","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"enum":["DASH","HLS","SMOOTH_STREAMING"],"type":"string"},"outputs":{"description":"The outputs to store the manifest","items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"status":{"description":"Current status","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"generatorVersion":{"description":"The version of the generator used to create the manifest","enum":["LEGACY","V2"],"type":"string"},"manifestName":{"description":"The filename of your manifest. If this is not set, the `name` is used as output file name. Either one of `name` or `manifestName` is required. Be aware that spaces will be replaced with underlines (`_`) on the output.","type":"string"},"hlsMediaPlaylistVersion":{"description":"If this is set, the EXT-X-VERSION tags of the Media Playlists are set to the provided version","enum":["3","4","5","6","7","8"],"type":"string"},"hlsMasterPlaylistVersion":{"description":"If this is set, the EXT-X-VERSION tag of the Master Playlist is set to the provided version","enum":["3","4","5","6","7","8"],"type":"string"},"channelsAttributeForAudio":{"description":"Controls the behaviour of the CHANNELS attribute for the EXT-X-VERSION tag","enum":["ALWAYS","STANDARD_CONFORM","LEGACY"],"type":"string"},"targetDurationRoundingMode":{"description":"The rounding applied to target duration.\nTwo possible rouding modes exist: NORMAL_ROUNDING, when the target duration is rounded to the nearest integer,\nor UPWARDS_ROUNDING, when the target duration is rounded to the highest integer.\n","enum":["UPWARD_ROUNDING","NORMAL_ROUNDING"],"type":"string"}},"required":["outputs"]},"streams":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"StreamInfo","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"audio":{"description":"It MUST match the value of the GROUP-ID attribute of an Audio EXT-X-MEDIA tag elsewhere in the Master Playlist. Either this or `audioGroups` must be set.","type":"string"},"audioGroups":{"type":"object","description":"HLS Audio Group Configuration. You will want to use this configuration property in case you specify conditions on audio streams. The first matching audio group will be used for the specific variant stream. Either this or `audio` must be set.","properties":{"droppingMode":{"description":"Dropping mode","enum":["STREAM","AUDIO"],"type":"string"},"groups":{"description":"Audio groups","items":{"type":"object","title":"AudioGroup","properties":{"name":{"description":"Name of the audio group","type":"string"},"priority":{"description":"Priority of the audio group","minimum":0,"maximum":100,"type":"integer"}},"required":["priority"]},"type":"array"}},"required":["droppingMode","groups"]},"video":{"description":"It MUST match the value of the GROUP-ID attribute of a Video EXT-X-MEDIA tag elsewhere in the Master Playlist","type":"string"},"subtitles":{"description":"It MUST match the value of the GROUP-ID attribute of a Subtitles EXT-X-MEDIA tag elsewhere in the Master Playlist","type":"string"},"closedCaptions":{"description":"If the value is not 'NONE', it MUST match the value of the GROUP-ID attribute of a Closed Captions EXT-X-MEDIA tag elsewhere in the Playlist","type":"string"},"encodingId":{"description":"Id of the encoding.","type":"string"},"streamId":{"description":"Id of the stream.","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"drmId":{"description":"Id of the DRM.","type":"string"},"segmentPath":{"description":"Path to segments.","type":"string"},"uri":{"description":"The URI of the playlist file.","type":"string"},"startSegmentNumber":{"description":"Number of the first segment. Default is 0.","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded.","type":"integer"},"forceFrameRateAttribute":{"type":"boolean","description":"Force the addition of the frame rate attribute to all stream infos."},"forceVideoRangeAttribute":{"type":"boolean","description":"Force the addition of the video-range attribute to all stream infos."}},"required":["encodingId","muxingId","segmentPath","streamId","uri"]},"customTags":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CustomTag","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"positionMode":{"description":"The positioning mode that should be used when inserting the placement opportunity","enum":["KEYFRAME","TIME","SEGMENT"],"type":"string"},"keyframeId":{"description":"Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.","type":"string"},"time":{"description":"Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.","format":"double","type":"number"},"segment":{"description":"The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.","type":"integer"},"data":{"description":"The data to be contained in the custom tag.","type":"string"}},"required":["data","positionMode"]}},"required":["properties"]}}},"iframe":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"IFramePlaylist","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"filename":{"description":"The filename of your I-frame playlist","type":"string"}},"required":["filename"]}},"required":["properties"]}}}},"required":["properties"]}}},"media":{"type":"object","properties":{"customTags":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"CustomTag","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"positionMode":{"description":"The positioning mode that should be used when inserting the placement opportunity","enum":["KEYFRAME","TIME","SEGMENT"],"type":"string"},"keyframeId":{"description":"Id of keyframe where the custom tag should be inserted. Required, when KEYFRAME is selected as position mode.","type":"string"},"time":{"description":"Time in seconds where the custom tag should be inserted. Required, when TIME is selected as position mode.","format":"double","type":"number"},"segment":{"description":"The custom tag will be inserted before the specified segment. Required, when SEGMENT is selected as position mode.","type":"integer"},"data":{"description":"The data to be contained in the custom tag.","type":"string"}},"required":["data","positionMode"]}},"required":["properties"]}}},"video":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"VideoMediaInfo","properties":{"groupId":{"description":"The value is a quoted-string which specifies the group to which the Rendition belongs.","type":"string"},"language":{"description":"Primary language in the rendition.","type":"string"},"assocLanguage":{"description":"Identifies a language that is associated with the Rendition.","type":"string"},"name":{"description":"Human readable description of the rendition.","type":"string"},"isDefault":{"type":"boolean","description":"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user."},"autoselect":{"type":"boolean","description":"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference."},"characteristics":{"description":"Contains Uniform Type Identifiers","items":{"type":"string"},"type":"array"},"segmentPath":{"description":"Path to segments.","type":"string"},"encodingId":{"description":"Id of the encoding.","type":"string"},"streamId":{"description":"Id of the stream.","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"drmId":{"description":"Id of the DRM.","type":"string"},"startSegmentNumber":{"description":"Number of the first segment. Default is 0.","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded.","type":"integer"},"uri":{"description":"The URI of the Rendition","type":"string"}},"required":["uri","encodingId","muxingId","segmentPath","streamId","groupId"]}},"required":["properties"]}}},"audio":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"AudioMediaInfo","properties":{"groupId":{"description":"The value is a quoted-string which specifies the group to which the Rendition belongs.","type":"string"},"language":{"description":"Primary language in the rendition.","type":"string"},"assocLanguage":{"description":"Identifies a language that is associated with the Rendition.","type":"string"},"name":{"description":"Human readable description of the rendition.","type":"string"},"isDefault":{"type":"boolean","description":"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user."},"autoselect":{"type":"boolean","description":"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference."},"characteristics":{"description":"Contains Uniform Type Identifiers","items":{"type":"string"},"type":"array"},"segmentPath":{"description":"Path to segments.","type":"string"},"encodingId":{"description":"Id of the encoding.","type":"string"},"streamId":{"description":"Id of the stream.","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"drmId":{"description":"Id of the DRM.","type":"string"},"startSegmentNumber":{"description":"Number of the first segment. Default is 0.","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded.","type":"integer"},"uri":{"description":"The URI of the Rendition","type":"string"},"forced":{"type":"boolean","description":"A value of true indicates that the Rendition contains content which is considered essential to play."}},"required":["uri","encodingId","muxingId","segmentPath","streamId","groupId"]}},"required":["properties"]}}},"subtitles":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SubtitlesMediaInfo","properties":{"groupId":{"description":"The value is a quoted-string which specifies the group to which the Rendition belongs.","type":"string"},"language":{"description":"Primary language in the rendition.","type":"string"},"assocLanguage":{"description":"Identifies a language that is associated with the Rendition.","type":"string"},"name":{"description":"Human readable description of the rendition.","type":"string"},"isDefault":{"type":"boolean","description":"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user."},"autoselect":{"type":"boolean","description":"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference."},"characteristics":{"description":"Contains Uniform Type Identifiers","items":{"type":"string"},"type":"array"},"segmentPath":{"description":"Path to segments.","type":"string"},"encodingId":{"description":"Id of the encoding.","type":"string"},"streamId":{"description":"Id of the stream.","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"drmId":{"description":"Id of the DRM.","type":"string"},"startSegmentNumber":{"description":"Number of the first segment. Default is 0.","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded.","type":"integer"},"uri":{"description":"The URI of the Rendition","type":"string"},"forced":{"type":"boolean","description":"A value of true indicates that the Rendition contains content which is considered essential to play."}},"required":["uri","encodingId","muxingId","segmentPath","streamId","groupId"]}},"required":["properties"]}}},"vtt":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"VttMediaInfo","properties":{"groupId":{"description":"The value is a quoted-string which specifies the group to which the Rendition belongs.","type":"string"},"language":{"description":"Primary language in the rendition.","type":"string"},"assocLanguage":{"description":"Identifies a language that is associated with the Rendition.","type":"string"},"name":{"description":"Human readable description of the rendition.","type":"string"},"isDefault":{"type":"boolean","description":"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user."},"autoselect":{"type":"boolean","description":"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference."},"characteristics":{"description":"Contains Uniform Type Identifiers","items":{"type":"string"},"type":"array"},"vttUrl":{"description":"The URL of the referenced VTT file","type":"string"},"uri":{"description":"The URI of the Rendition","type":"string"},"forced":{"type":"boolean","description":"A value of true indicates that the Rendition contains content which is considered essential to play."}},"required":["uri","vttUrl","groupId"]}},"required":["properties"]}}},"closedCaptions":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"ClosedCaptionsMediaInfo","properties":{"groupId":{"description":"The value is a quoted-string which specifies the group to which the Rendition belongs.","type":"string"},"language":{"description":"Primary language in the rendition.","type":"string"},"assocLanguage":{"description":"Identifies a language that is associated with the Rendition.","type":"string"},"name":{"description":"Human readable description of the rendition.","type":"string"},"isDefault":{"type":"boolean","description":"If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user."},"autoselect":{"type":"boolean","description":"If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference."},"characteristics":{"description":"Contains Uniform Type Identifiers","items":{"type":"string"},"type":"array"},"segmentPath":{"description":"Path to segments.","type":"string"},"encodingId":{"description":"Id of the encoding.","type":"string"},"streamId":{"description":"Id of the stream.","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"drmId":{"description":"Id of the DRM.","type":"string"},"startSegmentNumber":{"description":"Number of the first segment. Default is 0.","type":"integer"},"endSegmentNumber":{"description":"Number of the last segment. Default is the last one that was encoded.","type":"integer"},"instreamId":{"description":"Specifies a Rendition within the segments in the Media Playlist. (See HLS spec 4.3.4.1. EXT-X-MEDIA INSTREAM-ID)","type":"string"},"forced":{"type":"boolean","description":"A value of true indicates that the Rendition contains content which is considered essential to play."}},"required":["instreamId","encodingId","muxingId","segmentPath","streamId","groupId"]}},"required":["properties"]}}}}},"start":{"type":"object","properties":{"properties":{"type":"object","title":"StartManifestRequest","properties":{"manifestGenerator":{"description":"Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions:\n2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\n","enum":["LEGACY","V2"],"type":"string"}}}},"required":["properties"]}}}}},"smooth":{"type":"object","properties":{"defaultapi":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SmoothManifestDefault","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"enum":["DASH","HLS","SMOOTH_STREAMING"],"type":"string"},"outputs":{"description":"The outputs to store the manifest","items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"status":{"description":"Current status","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"generatorVersion":{"description":"The version of the generator used to create the manifest","enum":["LEGACY","V2"],"type":"string"},"serverManifestName":{"description":"Filename of the server manifest","type":"string"},"clientManifestName":{"description":"Filename of the client manifest","type":"string"},"encodingId":{"description":"The id of the encoding to create a default manifest for","type":"string"},"version":{"description":"Currently not in use","enum":["V1"],"type":"string"}},"required":["encodingId","outputs"]}},"required":["properties"]}}}},"patternProperties":{"^(?!.*\\b(?:defaultapi)\\b)[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SmoothStreamingManifest","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"type":{"enum":["DASH","HLS","SMOOTH_STREAMING"],"type":"string"},"outputs":{"description":"The outputs to store the manifest","items":{"type":"object","title":"EncodingOutput","properties":{"outputId":{"description":"Id of the corresponding output","type":"string"},"outputPath":{"description":"Subdirectory where to save the files to","type":"string"},"acl":{"description":"Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL","items":{"type":"object","title":"AclEntry","properties":{"scope":{"description":"Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all","type":"string"},"permission":{"enum":["PUBLIC_READ","PRIVATE"],"type":"string"}},"required":["permission"]},"type":"array"}},"required":["outputId","outputPath"]},"type":"array"},"status":{"description":"Current status","enum":["CREATED","QUEUED","RUNNING","FINISHED","ERROR","CANCELED","TRANSFER_ERROR"],"type":"string"},"generatorVersion":{"description":"The version of the generator used to create the manifest","enum":["LEGACY","V2"],"type":"string"},"serverManifestName":{"description":"Filename of the server manifest","type":"string"},"clientManifestName":{"description":"Filename of the client manifest","type":"string"}},"required":["outputs"]},"representations":{"type":"object","properties":{"mp4":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SmoothStreamingRepresentation","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"encodingId":{"description":"Id of the encoding","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"mediaFile":{"description":"The Smooth Streaming ismv or isma file that will be referenced in the manifest.","type":"string"},"language":{"description":"Language of the MP4 file","type":"string"},"trackName":{"description":"Track where this MP4 shoudl be added","type":"string"},"priority":{"description":"Specifies the priority of this representation. In the manifest, representations will appear ordered by descending priority values.","type":"integer"}},"required":["encodingId","mediaFile","muxingId"]}},"required":["properties"]}}}}},"contentprotection":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"SmoothManifestContentProtection","properties":{"name":{"description":"Name of the resource. Can be freely chosen by the user.","type":"string"},"description":{"description":"Description of the resource. Can be freely chosen by the user.","type":"string"},"customData":{"type":"object","description":"User-specific meta data. This can hold anything."},"encodingId":{"description":"Id of the encoding.","type":"string"},"muxingId":{"description":"Id of the muxing.","type":"string"},"drmId":{"description":"Id of the drm.","type":"string"}},"required":["drmId","encodingId","muxingId"]}},"required":["properties"]}}},"start":{"type":"object","patternProperties":{"^[A-Za-z0-9_-]+$":{"type":"object","properties":{"properties":{"type":"object","title":"StartManifestRequest","properties":{"manifestGenerator":{"description":"Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions:\n2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.\n","enum":["LEGACY","V2"],"type":"string"}}}},"required":["properties"]}}}}}}}}}},"required":["metadata","encodings"],"type":"object"}
|
Provide a JSON object that satisfies the schema "Bitmovin Encoding Template JSON Schema". Here are the required top‑level fields: metadata, encodings. Return only the valid JSON object.
|
Bitmovin Encoding Template JSON Schema
|
schema-store
|
schema_store_91
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"$ref\":\"#/definitions/StepModel\",\"definitions\":{\"AptGetDepModel\":{\"properties\":{\"name\":{\"type\":\"string\"},\"bin_name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BashStepToolkitModel\":{\"properties\":{\"entry_file\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BrewDepModel\":{\"properties\":{\"name\":{\"type\":\"string\"},\"bin_name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"CheckOnlyDepModel\":{\"properties\":{\"name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"DependencyModel\":{\"properties\":{\"manager\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"DepsModel\":{\"properties\":{\"brew\":{\"items\":{\"$ref\":\"#/definitions/BrewDepModel\"},\"type\":\"array\"},\"apt_get\":{\"items\":{\"$ref\":\"#/definitions/AptGetDepModel\"},\"type\":\"array\"},\"check_only\":{\"items\":{\"$ref\":\"#/definitions/CheckOnlyDepModel\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"GoStepToolkitModel\":{\"required\":[\"package_name\"],\"properties\":{\"package_name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StepModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"website\":{\"type\":\"string\"},\"source_code_url\":{\"type\":\"string\"},\"support_url\":{\"type\":\"string\"},\"published_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"source\":{\"$ref\":\"#/definitions/StepSourceModel\"},\"asset_urls\":{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},\"host_os_tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"project_type_tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type_tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"dependencies\":{\"items\":{\"$ref\":\"#/definitions/DependencyModel\"},\"type\":\"array\"},\"toolkit\":{\"$ref\":\"#/definitions/StepToolkitModel\"},\"deps\":{\"$ref\":\"#/definitions/DepsModel\"},\"is_requires_admin_user\":{\"type\":\"boolean\"},\"is_always_run\":{\"type\":\"boolean\"},\"is_skippable\":{\"type\":\"boolean\"},\"run_if\":{\"type\":\"string\"},\"timeout\":{\"type\":\"integer\"},\"meta\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"},\"inputs\":{\"items\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"},\"type\":\"array\"},\"outputs\":{\"items\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StepSourceModel\":{\"properties\":{\"git\":{\"type\":\"string\"},\"commit\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StepToolkitModel\":{\"properties\":{\"bash\":{\"$ref\":\"#/definitions/BashStepToolkitModel\"},\"go\":{\"$ref\":\"#/definitions/GoStepToolkitModel\"}},\"additionalProperties\":false,\"type\":\"object\"}},\"id\":\"https://json.schemastore.org/bitrise-step.json\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"bitrise-step\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","$ref":"#/definitions/StepModel","definitions":{"AptGetDepModel":{"properties":{"name":{"type":"string"},"bin_name":{"type":"string"}},"additionalProperties":false,"type":"object"},"BashStepToolkitModel":{"properties":{"entry_file":{"type":"string"}},"additionalProperties":false,"type":"object"},"BrewDepModel":{"properties":{"name":{"type":"string"},"bin_name":{"type":"string"}},"additionalProperties":false,"type":"object"},"CheckOnlyDepModel":{"properties":{"name":{"type":"string"}},"additionalProperties":false,"type":"object"},"DependencyModel":{"properties":{"manager":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false,"type":"object"},"DepsModel":{"properties":{"brew":{"items":{"$ref":"#/definitions/BrewDepModel"},"type":"array"},"apt_get":{"items":{"$ref":"#/definitions/AptGetDepModel"},"type":"array"},"check_only":{"items":{"$ref":"#/definitions/CheckOnlyDepModel"},"type":"array"}},"additionalProperties":false,"type":"object"},"GoStepToolkitModel":{"required":["package_name"],"properties":{"package_name":{"type":"string"}},"additionalProperties":false,"type":"object"},"StepModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"website":{"type":"string"},"source_code_url":{"type":"string"},"support_url":{"type":"string"},"published_at":{"type":"string","format":"date-time"},"source":{"$ref":"#/definitions/StepSourceModel"},"asset_urls":{"patternProperties":{".*":{"type":"string"}},"type":"object"},"host_os_tags":{"items":{"type":"string"},"type":"array"},"project_type_tags":{"items":{"type":"string"},"type":"array"},"type_tags":{"items":{"type":"string"},"type":"array"},"dependencies":{"items":{"$ref":"#/definitions/DependencyModel"},"type":"array"},"toolkit":{"$ref":"#/definitions/StepToolkitModel"},"deps":{"$ref":"#/definitions/DepsModel"},"is_requires_admin_user":{"type":"boolean"},"is_always_run":{"type":"boolean"},"is_skippable":{"type":"boolean"},"run_if":{"type":"string"},"timeout":{"type":"integer"},"meta":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"},"inputs":{"items":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"},"type":"array"},"outputs":{"items":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"},"type":"array"}},"additionalProperties":false,"type":"object"},"StepSourceModel":{"properties":{"git":{"type":"string"},"commit":{"type":"string"}},"additionalProperties":false,"type":"object"},"StepToolkitModel":{"properties":{"bash":{"$ref":"#/definitions/BashStepToolkitModel"},"go":{"$ref":"#/definitions/GoStepToolkitModel"}},"additionalProperties":false,"type":"object"}},"id":"https://json.schemastore.org/bitrise-step.json"}
|
Provide a JSON object that satisfies the schema "bitrise-step". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
bitrise-step
|
schema-store
|
schema_store_92
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/bitrise.json\",\"$ref\":\"#/definitions/BitriseDataModel\",\"definitions\":{\"AppModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"status_report_name\":{\"$ref\":\"#/definitions/StatusReportNameModel\"},\"envs\":{\"$ref\":\"#/definitions/EnvModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"AptGetDepModel\":{\"properties\":{\"name\":{\"type\":\"string\"},\"bin_name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BashStepToolkitModel\":{\"properties\":{\"entry_file\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BitriseDataModel\":{\"anyOf\":[{\"required\":[\"format_version\"]},{\"required\":[\"include\"]}],\"properties\":{\"format_version\":{\"type\":\"string\"},\"default_step_lib_source\":{\"type\":\"string\"},\"project_type\":{\"type\":\"string\"},\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"services\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/ContainerModel\"}},\"type\":\"object\"},\"containers\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/ContainerModel\"}},\"type\":\"object\"},\"app\":{\"$ref\":\"#/definitions/AppModel\"},\"meta\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"},\"trigger_map\":{\"items\":{\"$ref\":\"#/definitions/TriggerMapItemModel\"},\"type\":\"array\"},\"pipelines\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/PipelineModel\"}},\"type\":\"object\"},\"stages\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/StageModel\"}},\"type\":\"object\"},\"workflows\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/WorkflowModel\"}},\"type\":\"object\"},\"step_bundles\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/StepBundleModel\"}},\"type\":\"object\"},\"include\":{\"items\":{\"$ref\":\"#/definitions/IncludeItemModel\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"BrewDepModel\":{\"properties\":{\"name\":{\"type\":\"string\"},\"bin_name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"CheckOnlyDepModel\":{\"properties\":{\"name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"ContainerModel\":{\"required\":[\"image\"],\"properties\":{\"image\":{\"type\":\"string\"},\"credentials\":{\"$ref\":\"#/definitions/DockerCredentialModel\"},\"ports\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"envs\":{\"$ref\":\"#/definitions/EnvModel\"},\"options\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"DepsModel\":{\"properties\":{\"brew\":{\"items\":{\"$ref\":\"#/definitions/BrewDepModel\"},\"type\":\"array\"},\"apt_get\":{\"items\":{\"$ref\":\"#/definitions/AptGetDepModel\"},\"type\":\"array\"},\"check_only\":{\"items\":{\"$ref\":\"#/definitions/CheckOnlyDepModel\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"DockerCredentialModel\":{\"required\":[\"username\",\"password\"],\"properties\":{\"username\":{\"type\":\"string\"},\"password\":{\"type\":\"string\"},\"server\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"EnvModel\":{\"items\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"},\"type\":\"array\"},\"GoStepToolkitModel\":{\"required\":[\"package_name\"],\"properties\":{\"package_name\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"PipelineModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"triggers\":{\"$ref\":\"#/definitions/TriggersModel\"},\"status_report_name\":{\"$ref\":\"#/definitions/StatusReportNameModel\"},\"stages\":{\"items\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/StageModel\"}},\"type\":\"object\"},\"type\":\"array\"},\"workflows\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/GraphPipelineWorkflowModel\"}},\"type\":\"object\"},\"priority\":{\"$ref\":\"#/definitions/PriorityModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"GraphPipelineWorkflowModel\":{\"properties\":{\"depends_on\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"abort_on_fail\":{\"type\":\"boolean\"},\"should_always_run\":{\"type\":\"string\",\"enum\":[\"off\",\"workflow\"]},\"run_if\":{\"$ref\":\"#/definitions/GraphPipelineWorkflowRunIfModel\"},\"parallel\":{\"oneOf\":[{\"type\":\"integer\"},{\"type\":\"string\"}]},\"uses\":{\"type\":\"string\"},\"inputs\":{\"$ref\":\"#/definitions/EnvModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"GraphPipelineWorkflowRunIfModel\":{\"required\":[\"expression\"],\"properties\":{\"expression\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StageModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"abort_on_fail\":{\"type\":\"boolean\"},\"should_always_run\":{\"type\":\"boolean\"},\"workflows\":{\"items\":{\"patternProperties\":{\".*\":{\"$ref\":\"#/definitions/WorkflowStageConfigModel\"}},\"type\":\"object\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StatusReportNameModel\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":100,\"pattern\":\"^[a-zA-Z0-9,./():\\\\-_ <>\\\\[\\\\]\\\\|]*$\"},\"StepModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"website\":{\"type\":\"string\"},\"source_code_url\":{\"type\":\"string\"},\"support_url\":{\"type\":\"string\"},\"published_at\":{\"type\":\"string\",\"format\":\"date-time\"},\"source\":{\"$ref\":\"#/definitions/StepSourceModel\"},\"asset_urls\":{\"patternProperties\":{\".*\":{\"type\":\"string\"}},\"type\":\"object\"},\"host_os_tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"project_type_tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"type_tags\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"toolkit\":{\"$ref\":\"#/definitions/StepToolkitModel\"},\"deps\":{\"$ref\":\"#/definitions/DepsModel\"},\"is_requires_admin_user\":{\"type\":\"boolean\"},\"is_always_run\":{\"type\":\"boolean\"},\"is_skippable\":{\"type\":\"boolean\"},\"run_if\":{\"type\":\"string\"},\"timeout\":{\"type\":\"integer\"},\"no_output_timeout\":{\"type\":\"integer\"},\"meta\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"},\"inputs\":{\"$ref\":\"#/definitions/EnvModel\"},\"outputs\":{\"$ref\":\"#/definitions/EnvModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"TriggersModel\":{\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"push\":{\"items\":{\"$ref\":\"#/definitions/PushTriggerModel\"},\"type\":\"array\"},\"pull_request\":{\"items\":{\"$ref\":\"#/definitions/PullrequestTriggerModel\"},\"type\":\"array\"},\"tag\":{\"items\":{\"$ref\":\"#/definitions/TagTriggerModel\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"PushTriggerMapItemModelCommitsCondition\":{\"oneOf\":[{\"required\":[\"pattern\"],\"properties\":{\"pattern\":{\"type\":\"string\"},\"last_commit\":{\"type\":\"boolean\"}}},{\"required\":[\"regex\"],\"properties\":{\"regex\":{\"type\":\"string\"},\"last_commit\":{\"type\":\"boolean\"}}}],\"additionalProperties\":false,\"type\":\"object\"},\"PushTriggerModel\":{\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"priority\":{\"$ref\":\"#/definitions/PriorityModel\"},\"branch\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"commit_message\":{\"oneOf\":[{\"$ref\":\"#/definitions/PushTriggerMapItemModelCommitsCondition\"},{\"type\":\"string\"}]},\"changed_files\":{\"oneOf\":[{\"$ref\":\"#/definitions/PushTriggerMapItemModelCommitsCondition\"},{\"type\":\"string\"}]}},\"additionalProperties\":false,\"type\":\"object\"},\"PullrequestTriggerModel\":{\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"priority\":{\"$ref\":\"#/definitions/PriorityModel\"},\"draft_enabled\":{\"type\":\"boolean\"},\"source_branch\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"target_branch\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"label\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"comment\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"commit_message\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"changed_files\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]}},\"additionalProperties\":false,\"type\":\"object\"},\"TagTriggerModel\":{\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"priority\":{\"$ref\":\"#/definitions/PriorityModel\"},\"name\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]}},\"additionalProperties\":false,\"type\":\"object\"},\"StepSourceModel\":{\"properties\":{\"git\":{\"type\":\"string\"},\"commit\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StepToolkitModel\":{\"properties\":{\"bash\":{\"$ref\":\"#/definitions/BashStepToolkitModel\"},\"go\":{\"$ref\":\"#/definitions/GoStepToolkitModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"TriggerMapItemModelRegexCondition\":{\"properties\":{\"regex\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"TriggerMapItemModel\":{\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"push\",\"pull_request\",\"tag\"]},\"enabled\":{\"type\":\"boolean\"},\"pipeline\":{\"type\":\"string\"},\"workflow\":{\"type\":\"string\"},\"push_branch\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"commit_message\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"changed_files\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"pull_request_source_branch\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"pull_request_target_branch\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"draft_pull_request_enabled\":{\"type\":\"boolean\"},\"pull_request_label\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"pull_request_comment\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"tag\":{\"oneOf\":[{\"$ref\":\"#/definitions/TriggerMapItemModelRegexCondition\"},{\"type\":\"string\"}]},\"pattern\":{\"type\":\"string\"},\"is_pull_request_allowed\":{\"type\":\"boolean\"}},\"additionalProperties\":false,\"type\":\"object\"},\"WithModel\":{\"required\":[\"steps\"],\"properties\":{\"container\":{\"type\":\"string\"},\"services\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"steps\":{\"items\":{\"patternProperties\":{\"^(?!bundle::)(?!with$).*\":{\"$ref\":\"#/definitions/StepModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"WorkflowStageConfigModel\":{\"properties\":{\"run_if\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"WorkflowModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"triggers\":{\"$ref\":\"#/definitions/TriggersModel\"},\"status_report_name\":{\"$ref\":\"#/definitions/StatusReportNameModel\"},\"before_run\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"after_run\":{\"items\":{\"type\":\"string\"},\"type\":\"array\"},\"envs\":{\"$ref\":\"#/definitions/EnvModel\"},\"steps\":{\"items\":{\"patternProperties\":{\"^bundle::.+\":{\"$ref\":\"#/definitions/StepBundleOverrideModel\"},\"^with$\":{\"$ref\":\"#/definitions/WithModel\"},\"^(?!bundle::)(?!with$).*\":{\"$ref\":\"#/definitions/StepModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"type\":\"array\"},\"priority\":{\"$ref\":\"#/definitions/PriorityModel\"},\"meta\":{\"patternProperties\":{\".*\":{\"additionalProperties\":true}},\"type\":\"object\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StepBundleModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"envs\":{\"$ref\":\"#/definitions/EnvModel\"},\"inputs\":{\"$ref\":\"#/definitions/EnvModel\"},\"steps\":{\"items\":{\"patternProperties\":{\"^bundle::.+\":{\"$ref\":\"#/definitions/StepBundleOverrideModel\"},\"^(?!bundle::)(?!with$).*\":{\"$ref\":\"#/definitions/StepModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"type\":\"array\"}},\"additionalProperties\":false,\"type\":\"object\"},\"StepBundleOverrideModel\":{\"properties\":{\"title\":{\"type\":\"string\"},\"summary\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"envs\":{\"$ref\":\"#/definitions/EnvModel\"},\"inputs\":{\"$ref\":\"#/definitions/EnvModel\"}},\"additionalProperties\":false,\"type\":\"object\"},\"IncludeItemModel\":{\"required\":[\"path\"],\"properties\":{\"path\":{\"type\":\"string\",\"minLength\":1},\"repository\":{\"type\":\"string\"},\"branch\":{\"type\":\"string\"},\"commit\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"}},\"additionalProperties\":false,\"type\":\"object\"},\"PriorityModel\":{\"type\":\"integer\",\"maximum\":100,\"minimum\":-100}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"bitrise\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/bitrise.json","$ref":"#/definitions/BitriseDataModel","definitions":{"AppModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"status_report_name":{"$ref":"#/definitions/StatusReportNameModel"},"envs":{"$ref":"#/definitions/EnvModel"}},"additionalProperties":false,"type":"object"},"AptGetDepModel":{"properties":{"name":{"type":"string"},"bin_name":{"type":"string"}},"additionalProperties":false,"type":"object"},"BashStepToolkitModel":{"properties":{"entry_file":{"type":"string"}},"additionalProperties":false,"type":"object"},"BitriseDataModel":{"anyOf":[{"required":["format_version"]},{"required":["include"]}],"properties":{"format_version":{"type":"string"},"default_step_lib_source":{"type":"string"},"project_type":{"type":"string"},"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"services":{"patternProperties":{".*":{"$ref":"#/definitions/ContainerModel"}},"type":"object"},"containers":{"patternProperties":{".*":{"$ref":"#/definitions/ContainerModel"}},"type":"object"},"app":{"$ref":"#/definitions/AppModel"},"meta":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"},"trigger_map":{"items":{"$ref":"#/definitions/TriggerMapItemModel"},"type":"array"},"pipelines":{"patternProperties":{".*":{"$ref":"#/definitions/PipelineModel"}},"type":"object"},"stages":{"patternProperties":{".*":{"$ref":"#/definitions/StageModel"}},"type":"object"},"workflows":{"patternProperties":{".*":{"$ref":"#/definitions/WorkflowModel"}},"type":"object"},"step_bundles":{"patternProperties":{".*":{"$ref":"#/definitions/StepBundleModel"}},"type":"object"},"include":{"items":{"$ref":"#/definitions/IncludeItemModel"},"type":"array"}},"additionalProperties":false,"type":"object"},"BrewDepModel":{"properties":{"name":{"type":"string"},"bin_name":{"type":"string"}},"additionalProperties":false,"type":"object"},"CheckOnlyDepModel":{"properties":{"name":{"type":"string"}},"additionalProperties":false,"type":"object"},"ContainerModel":{"required":["image"],"properties":{"image":{"type":"string"},"credentials":{"$ref":"#/definitions/DockerCredentialModel"},"ports":{"type":"array","items":{"type":"string"}},"envs":{"$ref":"#/definitions/EnvModel"},"options":{"type":"string"}},"additionalProperties":false,"type":"object"},"DepsModel":{"properties":{"brew":{"items":{"$ref":"#/definitions/BrewDepModel"},"type":"array"},"apt_get":{"items":{"$ref":"#/definitions/AptGetDepModel"},"type":"array"},"check_only":{"items":{"$ref":"#/definitions/CheckOnlyDepModel"},"type":"array"}},"additionalProperties":false,"type":"object"},"DockerCredentialModel":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"},"server":{"type":"string"}},"additionalProperties":false,"type":"object"},"EnvModel":{"items":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"},"type":"array"},"GoStepToolkitModel":{"required":["package_name"],"properties":{"package_name":{"type":"string"}},"additionalProperties":false,"type":"object"},"PipelineModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"triggers":{"$ref":"#/definitions/TriggersModel"},"status_report_name":{"$ref":"#/definitions/StatusReportNameModel"},"stages":{"items":{"patternProperties":{".*":{"$ref":"#/definitions/StageModel"}},"type":"object"},"type":"array"},"workflows":{"patternProperties":{".*":{"$ref":"#/definitions/GraphPipelineWorkflowModel"}},"type":"object"},"priority":{"$ref":"#/definitions/PriorityModel"}},"additionalProperties":false,"type":"object"},"GraphPipelineWorkflowModel":{"properties":{"depends_on":{"items":{"type":"string"},"type":"array"},"abort_on_fail":{"type":"boolean"},"should_always_run":{"type":"string","enum":["off","workflow"]},"run_if":{"$ref":"#/definitions/GraphPipelineWorkflowRunIfModel"},"parallel":{"oneOf":[{"type":"integer"},{"type":"string"}]},"uses":{"type":"string"},"inputs":{"$ref":"#/definitions/EnvModel"}},"additionalProperties":false,"type":"object"},"GraphPipelineWorkflowRunIfModel":{"required":["expression"],"properties":{"expression":{"type":"string"}},"additionalProperties":false,"type":"object"},"StageModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"abort_on_fail":{"type":"boolean"},"should_always_run":{"type":"boolean"},"workflows":{"items":{"patternProperties":{".*":{"$ref":"#/definitions/WorkflowStageConfigModel"}},"type":"object"},"type":"array"}},"additionalProperties":false,"type":"object"},"StatusReportNameModel":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9,./():\\-_ <>\\[\\]\\|]*$"},"StepModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"website":{"type":"string"},"source_code_url":{"type":"string"},"support_url":{"type":"string"},"published_at":{"type":"string","format":"date-time"},"source":{"$ref":"#/definitions/StepSourceModel"},"asset_urls":{"patternProperties":{".*":{"type":"string"}},"type":"object"},"host_os_tags":{"items":{"type":"string"},"type":"array"},"project_type_tags":{"items":{"type":"string"},"type":"array"},"type_tags":{"items":{"type":"string"},"type":"array"},"toolkit":{"$ref":"#/definitions/StepToolkitModel"},"deps":{"$ref":"#/definitions/DepsModel"},"is_requires_admin_user":{"type":"boolean"},"is_always_run":{"type":"boolean"},"is_skippable":{"type":"boolean"},"run_if":{"type":"string"},"timeout":{"type":"integer"},"no_output_timeout":{"type":"integer"},"meta":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"},"inputs":{"$ref":"#/definitions/EnvModel"},"outputs":{"$ref":"#/definitions/EnvModel"}},"additionalProperties":false,"type":"object"},"TriggersModel":{"properties":{"enabled":{"type":"boolean"},"push":{"items":{"$ref":"#/definitions/PushTriggerModel"},"type":"array"},"pull_request":{"items":{"$ref":"#/definitions/PullrequestTriggerModel"},"type":"array"},"tag":{"items":{"$ref":"#/definitions/TagTriggerModel"},"type":"array"}},"additionalProperties":false,"type":"object"},"PushTriggerMapItemModelCommitsCondition":{"oneOf":[{"required":["pattern"],"properties":{"pattern":{"type":"string"},"last_commit":{"type":"boolean"}}},{"required":["regex"],"properties":{"regex":{"type":"string"},"last_commit":{"type":"boolean"}}}],"additionalProperties":false,"type":"object"},"PushTriggerModel":{"properties":{"enabled":{"type":"boolean"},"priority":{"$ref":"#/definitions/PriorityModel"},"branch":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"commit_message":{"oneOf":[{"$ref":"#/definitions/PushTriggerMapItemModelCommitsCondition"},{"type":"string"}]},"changed_files":{"oneOf":[{"$ref":"#/definitions/PushTriggerMapItemModelCommitsCondition"},{"type":"string"}]}},"additionalProperties":false,"type":"object"},"PullrequestTriggerModel":{"properties":{"enabled":{"type":"boolean"},"priority":{"$ref":"#/definitions/PriorityModel"},"draft_enabled":{"type":"boolean"},"source_branch":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"target_branch":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"label":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"comment":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"commit_message":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"changed_files":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]}},"additionalProperties":false,"type":"object"},"TagTriggerModel":{"properties":{"enabled":{"type":"boolean"},"priority":{"$ref":"#/definitions/PriorityModel"},"name":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]}},"additionalProperties":false,"type":"object"},"StepSourceModel":{"properties":{"git":{"type":"string"},"commit":{"type":"string"}},"additionalProperties":false,"type":"object"},"StepToolkitModel":{"properties":{"bash":{"$ref":"#/definitions/BashStepToolkitModel"},"go":{"$ref":"#/definitions/GoStepToolkitModel"}},"additionalProperties":false,"type":"object"},"TriggerMapItemModelRegexCondition":{"properties":{"regex":{"type":"string"}},"additionalProperties":false,"type":"object"},"TriggerMapItemModel":{"properties":{"type":{"type":"string","enum":["push","pull_request","tag"]},"enabled":{"type":"boolean"},"pipeline":{"type":"string"},"workflow":{"type":"string"},"push_branch":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"commit_message":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"changed_files":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"pull_request_source_branch":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"pull_request_target_branch":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"draft_pull_request_enabled":{"type":"boolean"},"pull_request_label":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"pull_request_comment":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"tag":{"oneOf":[{"$ref":"#/definitions/TriggerMapItemModelRegexCondition"},{"type":"string"}]},"pattern":{"type":"string"},"is_pull_request_allowed":{"type":"boolean"}},"additionalProperties":false,"type":"object"},"WithModel":{"required":["steps"],"properties":{"container":{"type":"string"},"services":{"type":"array","items":{"type":"string"}},"steps":{"items":{"patternProperties":{"^(?!bundle::)(?!with$).*":{"$ref":"#/definitions/StepModel"}},"additionalProperties":false,"type":"object"},"type":"array"}},"additionalProperties":false,"type":"object"},"WorkflowStageConfigModel":{"properties":{"run_if":{"type":"string"}},"additionalProperties":false,"type":"object"},"WorkflowModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"triggers":{"$ref":"#/definitions/TriggersModel"},"status_report_name":{"$ref":"#/definitions/StatusReportNameModel"},"before_run":{"items":{"type":"string"},"type":"array"},"after_run":{"items":{"type":"string"},"type":"array"},"envs":{"$ref":"#/definitions/EnvModel"},"steps":{"items":{"patternProperties":{"^bundle::.+":{"$ref":"#/definitions/StepBundleOverrideModel"},"^with$":{"$ref":"#/definitions/WithModel"},"^(?!bundle::)(?!with$).*":{"$ref":"#/definitions/StepModel"}},"additionalProperties":false,"type":"object"},"type":"array"},"priority":{"$ref":"#/definitions/PriorityModel"},"meta":{"patternProperties":{".*":{"additionalProperties":true}},"type":"object"}},"additionalProperties":false,"type":"object"},"StepBundleModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"envs":{"$ref":"#/definitions/EnvModel"},"inputs":{"$ref":"#/definitions/EnvModel"},"steps":{"items":{"patternProperties":{"^bundle::.+":{"$ref":"#/definitions/StepBundleOverrideModel"},"^(?!bundle::)(?!with$).*":{"$ref":"#/definitions/StepModel"}},"additionalProperties":false,"type":"object"},"type":"array"}},"additionalProperties":false,"type":"object"},"StepBundleOverrideModel":{"properties":{"title":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"envs":{"$ref":"#/definitions/EnvModel"},"inputs":{"$ref":"#/definitions/EnvModel"}},"additionalProperties":false,"type":"object"},"IncludeItemModel":{"required":["path"],"properties":{"path":{"type":"string","minLength":1},"repository":{"type":"string"},"branch":{"type":"string"},"commit":{"type":"string"},"tag":{"type":"string"}},"additionalProperties":false,"type":"object"},"PriorityModel":{"type":"integer","maximum":100,"minimum":-100}}}
|
Provide a JSON object that satisfies the schema "bitrise". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
bitrise
|
schema-store
|
schema_store_93
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"BlockMetadataRepository\":{\"anyOf\":[{\"properties\":{\"directory\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"}},\"required\":[\"type\",\"url\"],\"type\":\"object\"},{\"type\":\"string\"}]},\"JsonObject\":{\"additionalProperties\":{\"$ref\":\"#/definitions/JsonValue\"},\"type\":\"object\"},\"JsonValue\":{\"anyOf\":[{\"items\":{\"$ref\":\"#/definitions/JsonValue\"},\"type\":\"array\"},{\"$ref\":\"#/definitions/JsonObject\"},{\"type\":[\"string\",\"number\",\"boolean\"]}]}},\"properties\":{\"author\":{\"description\":\"The name of the author of the block\",\"type\":\"string\"},\"blockType\":{\"description\":\"The type of block this is (e.g. custom element, React)\",\"properties\":{\"entryPoint\":{\"enum\":[\"custom-element\",\"html\",\"react\"],\"type\":\"string\"},\"tagName\":{\"type\":\"string\"}},\"required\":[\"entryPoint\"],\"type\":\"object\"},\"commit\":{\"description\":\"The commit hash of the source this block was built from. If specified, 'repository' must also be specified.\",\"type\":\"string\"},\"description\":{\"description\":\"A short description of the block, to help users understand its capabilities\",\"type\":\"string\"},\"devReloadEndpoint\":{\"description\":\"URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload.\",\"type\":\"string\"},\"displayName\":{\"description\":\"The display name used for a block\",\"type\":\"string\"},\"examples\":{\"description\":\"A list of examples property objects which comply with the block's schema, for demonstration purposes\",\"items\":{\"$ref\":\"#/definitions/JsonObject\"},\"type\":\"array\"},\"externals\":{\"$ref\":\"#/definitions/JsonObject\",\"description\":\"The dependencies a block relies on but expects the embedding application to provide, e.g. { \\\"react\\\": \\\"^18.0.0\\\" }\"},\"icon\":{\"description\":\"An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block).\",\"type\":\"string\"},\"image\":{\"description\":\"A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px.\",\"type\":\"string\"},\"license\":{\"description\":\"The license the block is made available under (e.g. MIT).\",\"type\":\"string\"},\"name\":{\"description\":\"A unique, slugified name for the block.\",\"type\":\"string\"},\"protocol\":{\"description\":\"The applicable block protocol version, e.g. 0.3\",\"type\":\"string\"},\"repository\":{\"$ref\":\"#/definitions/BlockMetadataRepository\",\"description\":\"Specify the place where your block's code lives. This is helpful for people who want to explore the source, or contribute to your block's development.\"},\"schema\":{\"description\":\"The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2\",\"type\":\"string\"},\"source\":{\"description\":\"The path or URL to the entrypoint source file (e.g. index.html, index.js).\",\"type\":\"string\"},\"variants\":{\"description\":\"A list which represents different variants of the block that the user can create.\",\"items\":{\"properties\":{\"description\":{\"type\":\"string\"},\"examples\":{\"items\":{\"$ref\":\"#/definitions/JsonObject\"},\"type\":\"array\"},\"icon\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"properties\":{\"$ref\":\"#/definitions/JsonObject\"}},\"required\":[\"name\",\"properties\"],\"type\":\"object\"},\"type\":\"array\"},\"version\":{\"description\":\"The version of the block, which should use semantic versioning (@see https://semver.org/).\",\"type\":\"string\"}},\"required\":[\"blockType\",\"name\",\"protocol\",\"schema\",\"source\",\"version\"],\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"block-metadata\". Here are the required top‑level fields: blockType, name, protocol, schema, source, version. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","definitions":{"BlockMetadataRepository":{"anyOf":[{"properties":{"directory":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"required":["type","url"],"type":"object"},{"type":"string"}]},"JsonObject":{"additionalProperties":{"$ref":"#/definitions/JsonValue"},"type":"object"},"JsonValue":{"anyOf":[{"items":{"$ref":"#/definitions/JsonValue"},"type":"array"},{"$ref":"#/definitions/JsonObject"},{"type":["string","number","boolean"]}]}},"properties":{"author":{"description":"The name of the author of the block","type":"string"},"blockType":{"description":"The type of block this is (e.g. custom element, React)","properties":{"entryPoint":{"enum":["custom-element","html","react"],"type":"string"},"tagName":{"type":"string"}},"required":["entryPoint"],"type":"object"},"commit":{"description":"The commit hash of the source this block was built from. If specified, 'repository' must also be specified.","type":"string"},"description":{"description":"A short description of the block, to help users understand its capabilities","type":"string"},"devReloadEndpoint":{"description":"URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload.","type":"string"},"displayName":{"description":"The display name used for a block","type":"string"},"examples":{"description":"A list of examples property objects which comply with the block's schema, for demonstration purposes","items":{"$ref":"#/definitions/JsonObject"},"type":"array"},"externals":{"$ref":"#/definitions/JsonObject","description":"The dependencies a block relies on but expects the embedding application to provide, e.g. { \"react\": \"^18.0.0\" }"},"icon":{"description":"An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block).","type":"string"},"image":{"description":"A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px.","type":"string"},"license":{"description":"The license the block is made available under (e.g. MIT).","type":"string"},"name":{"description":"A unique, slugified name for the block.","type":"string"},"protocol":{"description":"The applicable block protocol version, e.g. 0.3","type":"string"},"repository":{"$ref":"#/definitions/BlockMetadataRepository","description":"Specify the place where your block's code lives. This is helpful for people who want to explore the source, or contribute to your block's development."},"schema":{"description":"The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2","type":"string"},"source":{"description":"The path or URL to the entrypoint source file (e.g. index.html, index.js).","type":"string"},"variants":{"description":"A list which represents different variants of the block that the user can create.","items":{"properties":{"description":{"type":"string"},"examples":{"items":{"$ref":"#/definitions/JsonObject"},"type":"array"},"icon":{"type":"string"},"name":{"type":"string"},"properties":{"$ref":"#/definitions/JsonObject"}},"required":["name","properties"],"type":"object"},"type":"array"},"version":{"description":"The version of the block, which should use semantic versioning (@see https://semver.org/).","type":"string"}},"required":["blockType","name","protocol","schema","source","version"],"type":"object"}
|
Provide a JSON object that satisfies the schema "block-metadata". Here are the required top‑level fields: blockType, name, protocol, schema, source, version. Return only the valid JSON object.
|
block-metadata
|
schema-store
|
schema_store_94
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"title\":\"JSON schema for WordPress blocks\",\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"definitions\":{\"//\":{\"reference\":\"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-metadata/\",\"attributesReference\":\"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/\",\"contextReference\":\"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/\",\"supportsReference\":\"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/\",\"registerReference\":\"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional\"}},\"type\":\"object\",\"properties\":{\"$schema\":{\"type\":\"string\"},\"apiVersion\":{\"description\":\"The version of the Block API used by the block. The most recent version is 3 and it was introduced in WordPress 6.3.\\n\\n See the API versions documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/ for more details.\",\"type\":\"integer\",\"enum\":[1,2,3],\"default\":1},\"name\":{\"description\":\"The name for a block is a unique string that identifies a block. Names have to be structured as `namespace/block-name`, where namespace is the name of your plugin or theme.\",\"type\":\"string\",\"pattern\":\"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$\"},\"__experimental\":{\"description\":\"The name of the experiment this block is a part of, or boolean true if there is no specific experiment name.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"boolean\"}]},\"title\":{\"description\":\"This is the display title for your block, which can be translated with our translation functions. The block inserter will show this name.\",\"type\":\"string\"},\"category\":{\"description\":\"Blocks are grouped into categories to help users browse and discover them.\\n Core provided categories are: text, media, design, widgets, theme, embed\\n\\nPlugins and Themes can also register custom block categories.\\n\\nhttps://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#managing-block-categories\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"enum\":[\"text\",\"media\",\"design\",\"widgets\",\"theme\",\"embed\"]}]},\"parent\":{\"description\":\"Setting parent lets a block require that it is only available when nested within the specified blocks. For example, you might want to allow an \\u2018Add to Cart\\u2019 block to only be available within a \\u2018Product\\u2019 block.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"ancestor\":{\"description\":\"The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a \\u2018Comment Content\\u2019 block inside a \\u2018Column\\u2019 block, as long as \\u2018Column\\u2019 is somewhere within a \\u2018Comment Template\\u2019 block.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"allowedBlocks\":{\"description\":\"The `allowedBlocks` property specifies that only the listed block types can be the children of this block. For example, a \\u2018List\\u2019 block allows only \\u2018List Item\\u2019 blocks as direct children.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"icon\":{\"description\":\"An icon property should be specified to make it easier to identify a block. These can be any of WordPress\\u2019 Dashicons (slug serving also as a fallback in non-js contexts).\",\"type\":\"string\"},\"description\":{\"description\":\"This is a short description for your block, which can be translated with our translation functions. This will be shown in the block inspector.\",\"type\":\"string\"},\"keywords\":{\"description\":\"Sometimes a block could have aliases that help users discover it while searching. For example, an image block could also want to be discovered by photo. You can do so by providing an array of unlimited terms (which are translated).\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"version\":{\"description\":\"The current version number of the block, such as 1.0 or 1.0.3. It\\u2019s similar to how plugins are versioned. This field might be used with block assets to control cache invalidation, and when the block author omits it, then the installed version of WordPress is used instead.\",\"type\":\"string\"},\"textdomain\":{\"description\":\"The gettext text domain of the plugin/block. More information can be found in the Text Domain section of the How to Internationalize your Plugin page.\\n\\nhttps://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/\",\"type\":\"string\"},\"attributes\":{\"description\":\"Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface.\\n\\nSee the attributes documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/ for more details.\",\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z]\":{\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"The type indicates the type of data that is stored by the attribute. It does not indicate where the data is stored, which is defined by the source field.\\n\\nA type is required, unless an enum is provided. A type can be used with an enum.\\n\\nNote that the validity of an object is determined by your source. For an example, see the query details below.\",\"oneOf\":[{\"type\":\"string\",\"enum\":[\"null\",\"boolean\",\"object\",\"array\",\"string\",\"rich-text\",\"integer\",\"number\"]},{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\",\"enum\":[\"null\",\"boolean\",\"object\",\"array\",\"string\",\"integer\",\"number\"]}}]},\"enum\":{\"description\":\"An attribute can be defined as one of a fixed set of values. This is specified by an enum, which contains an array of allowed values:\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"number\"},{\"type\":\"string\"}]}},\"source\":{\"description\":\"Attribute sources are used to define how the attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block.\",\"type\":\"string\",\"enum\":[\"attribute\",\"text\",\"rich-text\",\"html\",\"raw\",\"query\",\"meta\"]},\"selector\":{\"description\":\"The selector can be an HTML tag, or anything queryable with querySelector, such as a class or id attribute. Examples are given below.\\n\\nFor example, a selector of img will match an img element, and img.class will match an img element that has a class of class.\",\"type\":\"string\"},\"attribute\":{\"description\":\"Use an attribute source to extract the value from an attribute in the markup. The attribute is specified by the attribute field, which must be supplied.\\n\\nExample: Extract the src attribute from an image found in the block\\u2019s markup.\",\"type\":\"string\"},\"query\":{\"description\":\"Use query to extract an array of values from markup. Entries of the array are determined by the selector argument, where each matched element within the block will have an entry structured corresponding to the second argument, an object of attribute sources.\",\"type\":\"object\"},\"meta\":{\"description\":\"Although attributes may be obtained from a post\\u2019s meta, meta attribute sources are considered deprecated; EntityProvider and related hook APIs should be used instead, as shown in the Create Meta Block how-to here:\\n\\nhttps://developer.wordpress.org/block-editor/how-to-guides/metabox/#step-2-add-meta-block\",\"type\":\"string\"},\"role\":{\"description\":\"Designates the conceptual type of the attribute.\\n\\nThe `content` value marks the attribute as user-editable content, and the `local` value marks the attribute as temporary and non-persistable.\",\"type\":\"string\",\"enum\":[\"content\",\"local\"]},\"default\":{\"description\":\"A block attribute can contain a default value, which will be used if the type and source do not match anything within the block content.\\n\\nThe value is provided by the default field, and the value should match the expected format of the attribute.\"}},\"anyOf\":[{\"required\":[\"type\"]},{\"required\":[\"enum\"]}]}},\"additionalProperties\":false},\"providesContext\":{\"description\":\"Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block\\u2019s own attribute.\\n\\nSee the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.\",\"type\":\"object\",\"patternProperties\":{\"[a-zA-Z]\":{\"type\":\"string\"}}},\"usesContext\":{\"description\":\"Array of the names of context values to inherit from an ancestor provider.\\n\\nSee the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"supports\":{\"description\":\"It contains as set of options to control features used in the editor. See the supports documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/ for more details.\",\"type\":\"object\",\"properties\":{\"anchor\":{\"description\":\"Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link.\",\"type\":\"boolean\",\"default\":false},\"align\":{\"description\":\"This property adds block controls which allow to change block\\u2019s alignment.\",\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"wide\",\"full\",\"left\",\"center\",\"right\"]}}],\"default\":false},\"alignWide\":{\"description\":\"This property allows to enable wide alignment for your theme. To disable this behavior for a single block, set this flag to false.\",\"type\":\"boolean\",\"default\":true},\"ariaLabel\":{\"description\":\"ARIA-labels let you define an accessible label for elements. This property allows enabling the definition of an aria-label for the block, without exposing a UI field.\",\"type\":\"boolean\",\"default\":false},\"className\":{\"description\":\"By default, the class .wp-block-your-block-name is added to the root element of your saved markup. This helps having a consistent mechanism for styling blocks that themes and plugins can rely on. If, for whatever reason, a class is not desired on the markup, this functionality can be disabled.\",\"type\":\"boolean\",\"default\":true},\"color\":{\"description\":\"This value signals that a block supports some of the properties related to color. When it does, the block editor will show UI controls for the user to set their values.\\n\\nNote that the background and text keys have a default value of true, so if the color property is present they\\u2019ll also be considered enabled\",\"type\":\"object\",\"properties\":{\"background\":{\"description\":\"This property adds UI controls which allow the user to apply a solid background color to a block.\\n\\nWhen color support is declared, this property is enabled by default (along with text), so simply setting color will enable background color.\\n\\nTo disable background support while keeping other color supports enabled, set to false.\\n\\nWhen the block declares support for color.background, its attributes definition is extended to include two new attributes: backgroundColor and style\",\"type\":\"boolean\",\"default\":true},\"gradients\":{\"description\":\"This property adds UI controls which allow the user to apply a gradient background to a block.\\n\\nGradient presets are sourced from editor-gradient-presets theme support.\\n\\nWhen the block declares support for color.gradient, its attributes definition is extended to include two new attributes: gradient and style\",\"type\":\"boolean\",\"default\":false},\"link\":{\"description\":\"This property adds block controls which allow the user to set link color in a block, link color is disabled by default.\\n\\nLink color presets are sourced from the editor-color-palette theme support.\\n\\nWhen the block declares support for color.link, its attributes definition is extended to include the style attribute\",\"type\":\"boolean\",\"default\":false},\"text\":{\"description\":\"This property adds block controls which allow the user to set text color in a block.\\n\\nWhen color support is declared, this property is enabled by default (along with background), so simply setting color will enable text color.\\n\\nText color presets are sourced from the editor-color-palette theme support.\\n\\nWhen the block declares support for color.text, its attributes definition is extended to include two new attributes: textColor and style\",\"type\":\"boolean\",\"default\":true},\"heading\":{\"description\":\"This property adds block controls which allow the user to set heading colors in a block. Heading color is disabled by default.\\n\\nHeading color presets are sourced from the editor-color-palette theme support.\\n\\nWhen the block declares support for color.heading, its attributes definition is extended to include the style attribute\",\"type\":\"boolean\",\"default\":false},\"button\":{\"description\":\"This property adds block controls which allow the user to set button colors in a block. Button color is disabled by default.\\n\\nButton color presets are sourced from the editor-color-palette theme support.\\n\\nWhen the block declares support for color.button, its attributes definition is extended to include the style attribute\",\"type\":\"boolean\",\"default\":false},\"enableContrastChecker\":{\"description\":\"Determines whether the contrast checker widget displays in the block editor UI.\\n\\nThe contrast checker appears only if the block declares support for color. It tests the readability of color combinations and warns if there is a potential issue. The property is enabled by default.\\n\\nSet to `false` to explicitly disable.\",\"type\":\"boolean\",\"default\":true}}},\"customClassName\":{\"description\":\"This property adds a field to define a custom className for the block\\u2019s wrapper.\",\"type\":\"boolean\",\"default\":true},\"dimensions\":{\"description\":\"This value signals that a block supports some of the CSS style properties related to dimensions. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\\n\\nWhen the block declares support for a specific dimensions property, its attributes definition is extended to include the style attribute.\",\"type\":\"object\",\"properties\":{\"aspectRatio\":{\"description\":\"Allow blocks to define an aspect ratio value.\",\"type\":\"boolean\",\"default\":false},\"minHeight\":{\"description\":\"Allow blocks to define a minimum height value.\",\"type\":\"boolean\",\"default\":false}}},\"filter\":{\"description\":\"This value signals that a block supports some of the properties related to filters. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\\n\\nWhen the block declares support for a specific filter property, its attributes definition is extended to include the style attribute.\",\"type\":\"object\",\"properties\":{\"duotone\":{\"description\":\"Allow blocks to define a duotone filter.\",\"type\":\"boolean\",\"default\":false}}},\"background\":{\"description\":\"This value signals that a block supports some of the CSS style properties related to background. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\\n\\nWhen the block declares support for a specific background property, its attributes definition is extended to include the style attribute.\",\"type\":\"object\",\"properties\":{\"backgroundImage\":{\"description\":\"Allow blocks to define a background image.\",\"type\":\"boolean\",\"default\":false},\"backgroundSize\":{\"description\":\"Allow blocks to define values related to the size of a background image, including size, position, and repeat controls\",\"type\":\"boolean\",\"default\":false}}},\"html\":{\"description\":\"By default, a block\\u2019s markup can be edited individually. To disable this behavior, set html to false.\",\"type\":\"boolean\",\"default\":true},\"inserter\":{\"description\":\"By default, all blocks will appear in the inserter, block transforms menu, Style Book, etc. To hide a block from all parts of the user interface so that it can only be inserted programmatically, set inserter to false.\",\"type\":\"boolean\",\"default\":true},\"renaming\":{\"description\":\"By default, a block can be renamed by a user from the block 'Options' dropdown or the 'Advanced' panel. To disable this behavior, set renaming to false.\",\"type\":\"boolean\",\"default\":true},\"layout\":{\"description\":\"This value only applies to blocks that are containers for inner blocks. If set to `true` the layout type will be `flow`. For other layout types it's necessary to set the `type` explicitly inside the `default` object.\",\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"object\",\"properties\":{\"default\":{\"description\":\"Allows setting the `type` property to define what layout type is default for the block, and also default values for any properties inherent to that layout type, e.g., for a `flex` layout, a default value can be set for `flexWrap`.\",\"type\":\"object\",\"properties\":{\"type\":{\"description\":\"The layout type.\",\"type\":\"string\",\"enum\":[\"constrained\",\"grid\",\"flex\"]},\"contentSize\":{\"description\":\"The content size used on all children.\",\"type\":\"string\"},\"wideSize\":{\"description\":\"The wide size used on alignwide children.\",\"type\":\"string\"},\"justifyContent\":{\"description\":\"Content justification value.\",\"type\":\"string\",\"enum\":[\"right\",\"center\",\"space-between\",\"left\",\"stretch\"]},\"orientation\":{\"description\":\"The orientation of the layout.\",\"type\":\"string\",\"enum\":[\"horizontal\",\"vertical\"]},\"flexWrap\":{\"description\":\"The flex wrap value.\",\"type\":\"string\",\"enum\":[\"wrap\",\"nowrap\"]},\"verticalAlignment\":{\"description\":\"The vertical alignment value.\",\"type\":\"string\",\"enum\":[\"top\",\"center\",\"bottom\",\"space-between\",\"stretch\"]},\"minimumColumnWidth\":{\"description\":\"The minimum column width value.\",\"type\":\"string\"},\"columnCount\":{\"description\":\"The column count value.\",\"type\":\"number\"}}},\"allowSwitching\":{\"description\":\"Exposes a switcher control that allows toggling between all existing layout types.\",\"type\":\"boolean\",\"default\":false},\"allowEditing\":{\"description\":\"Determines display of layout controls in the block sidebar. If set to false, layout controls will be hidden.\",\"type\":\"boolean\",\"default\":true},\"allowInheriting\":{\"description\":\"For the `flow` layout type only, determines display of the `Inner blocks use content width` toggle.\",\"type\":\"boolean\",\"default\":true},\"allowSizingOnChildren\":{\"description\":\"For the `flex` layout type only, determines display of sizing controls (Fit/Fill/Fixed) on all child blocks of the flex block.\",\"type\":\"boolean\",\"default\":false},\"allowVerticalAlignment\":{\"description\":\"For the `flex` layout type only, determines display of vertical alignment controls in the block toolbar.\",\"type\":\"boolean\",\"default\":true},\"allowJustification\":{\"description\":\"For the `flex` layout type, determines display of justification controls in the block toolbar and block sidebar. For the `constrained` layout type, determines display of justification control in the block sidebar.\",\"type\":\"boolean\",\"default\":true},\"allowOrientation\":{\"description\":\"For the `flex` layout type only, determines display of the orientation control in the block toolbar.\",\"type\":\"boolean\",\"default\":true},\"allowCustomContentAndWideSize\":{\"description\":\"For the `constrained` layout type only, determines display of the custom content and wide size controls in the block sidebar.\",\"type\":\"boolean\",\"default\":true}}}],\"default\":false},\"multiple\":{\"description\":\"A non-multiple block can be inserted into each post, one time only. For example, the built-in \\u2018More\\u2019 block cannot be inserted again if it already exists in the post being edited. A non-multiple block\\u2019s icon is automatically dimmed (unclickable) to prevent multiple instances.\",\"type\":\"boolean\",\"default\":true},\"reusable\":{\"description\":\"A block may want to disable the ability of being converted into a reusable block. By default all blocks can be converted to a reusable block. If supports reusable is set to false, the option to convert the block into a reusable block will not appear.\",\"type\":\"boolean\",\"default\":true},\"lock\":{\"description\":\"A block may want to disable the ability to toggle the lock state. It can be locked/unlocked by a user from the block 'Options' dropdown by default. To disable this behavior, set lock to false.\",\"type\":\"boolean\",\"default\":true},\"position\":{\"description\":\"This value signals that a block supports some of the CSS style properties related to position. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\\n\\nWhen the block declares support for a specific position property, its attributes definition is extended to include the style attribute.\",\"type\":\"object\",\"properties\":{\"sticky\":{\"description\":\"Allow blocks to stick to their immediate parent when scrolling the page.\",\"type\":\"boolean\",\"default\":false}}},\"spacing\":{\"description\":\"This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\\n\\nWhen the block declares support for a specific spacing property, its attributes definition is extended to include the style attribute.\",\"type\":\"object\",\"properties\":{\"margin\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"top\",\"right\",\"left\",\"bottom\"]}},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"vertical\",\"horizontal\"]}}]},\"padding\":{\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"top\",\"right\",\"left\",\"bottom\"]}},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"vertical\",\"horizontal\"]}}]}}},\"shadow\":{\"description\":\"Allow blocks to define a box shadow.\",\"oneOf\":[{\"description\":\"Defines whether a box shadow is enabled or not.\",\"type\":\"boolean\"},{\"type\":\"object\"}],\"default\":false},\"typography\":{\"description\":\"This value signals that a block supports some of the CSS style properties related to typography. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\\n\\nWhen the block declares support for a specific typography property, its attributes definition is extended to include the style attribute.\",\"type\":\"object\",\"properties\":{\"fontSize\":{\"description\":\"This value signals that a block supports the font-size CSS style property. When it does, the block editor will show an UI control for the user to set its value.\\n\\nThe values shown in this control are the ones declared by the theme via the editor-font-sizes theme support, or the default ones if none is provided.\\n\\nWhen the block declares support for fontSize, its attributes definition is extended to include two new attributes: fontSize and style\",\"type\":\"boolean\",\"default\":false},\"lineHeight\":{\"description\":\"This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if the theme declares support.\\n\\nWhen the block declares support for lineHeight, its attributes definition is extended to include a new attribute style of object type with no default assigned. It stores the custom value set by the user. The block can apply a default style by specifying its own style attribute with a default\",\"type\":\"boolean\",\"default\":false},\"textAlign\":{\"description\":\"This property adds block toolbar controls which allow to change block's text alignment.\",\"oneOf\":[{\"type\":\"boolean\"},{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"left\",\"center\",\"right\"]}}],\"default\":false}}},\"interactivity\":{\"description\":\"Indicates if the block is using Interactivity API features.\",\"oneOf\":[{\"description\":\"Indicates whether the block is using the Interactivity API directives.\",\"type\":\"boolean\",\"default\":false},{\"type\":\"object\",\"properties\":{\"clientNavigation\":{\"description\":\"Indicates whether a block is compatible with the Interactivity API client-side navigation.\\n\\nSet it to true only if the block is not interactive or if it is interactive using the Interactivity API. Set it to false if the block is interactive but uses vanilla JS, jQuery or another JS framework/library other than the Interactivity API.\",\"type\":\"boolean\",\"default\":false},\"interactive\":{\"description\":\"Indicates whether the block is using the Interactivity API directives.\",\"type\":\"boolean\",\"default\":false}}}]},\"splitting\":{\"description\":\"This property indicates whether the block can split when the Enter key is pressed or when blocks are pasted.\",\"type\":\"boolean\",\"default\":false}},\"additionalProperties\":true},\"selectors\":{\"description\":\"Provides custom CSS selectors and mappings for the block. Selectors may be set for the block itself or per-feature e.g. typography. Custom selectors per feature or sub-feature, allow different block styles to be applied to different elements within the block.\",\"type\":\"object\",\"properties\":{\"root\":{\"description\":\"The primary CSS class to apply to the block. This replaces the `.wp-block-name` class if set.\",\"type\":\"string\"},\"border\":{\"description\":\"Custom CSS selector used to generate rules for the block's theme.json border styles.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"root\":{\"type\":\"string\"},\"color\":{\"type\":\"string\"},\"radius\":{\"type\":\"string\"},\"style\":{\"type\":\"string\"},\"width\":{\"type\":\"string\"}}}]},\"color\":{\"description\":\"Custom CSS selector used to generate rules for the block's theme.json color styles.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"root\":{\"type\":\"string\"},\"text\":{\"type\":\"string\"},\"background\":{\"type\":\"string\"}}}]},\"dimensions\":{\"description\":\"Custom CSS selector used to generate rules for the block's theme.json dimensions styles.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"root\":{\"type\":\"string\"},\"aspectRatio\":{\"type\":\"string\"},\"minHeight\":{\"type\":\"string\"}}}]},\"spacing\":{\"description\":\"Custom CSS selector used to generate rules for the block's theme.json spacing styles.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"root\":{\"type\":\"string\"},\"blockGap\":{\"type\":\"string\"},\"padding\":{\"type\":\"string\"},\"margin\":{\"type\":\"string\"}}}]},\"typography\":{\"description\":\"Custom CSS selector used to generate rules for the block's theme.json typography styles.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"object\",\"properties\":{\"root\":{\"type\":\"string\"},\"fontFamily\":{\"type\":\"string\"},\"fontSize\":{\"type\":\"string\"},\"fontStyle\":{\"type\":\"string\"},\"fontWeight\":{\"type\":\"string\"},\"lineHeight\":{\"type\":\"string\"},\"letterSpacing\":{\"type\":\"string\"},\"textDecoration\":{\"type\":\"string\"},\"textTransform\":{\"type\":\"string\"}}}]}}},\"styles\":{\"description\":\"Block styles can be used to provide alternative styles to block. It works by adding a class name to the block\\u2019s wrapper. Using CSS, a theme developer can target the class name for the block style if it is selected.\\n\\nPlugins and Themes can also register custom block style for existing blocks.\\n\\nhttps://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"label\":{\"type\":\"string\"},\"isDefault\":{\"type\":\"boolean\",\"default\":false}},\"required\":[\"name\",\"label\"],\"additionalProperties\":false}},\"example\":{\"description\":\"It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block.\\n\\nSee the example documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional for more details.\",\"type\":\"object\",\"properties\":{\"viewportWidth\":{\"description\":\"The viewportWidth controls the width of the iFrame container in which the block preview will get rendered\",\"type\":\"number\",\"default\":1200},\"attributes\":{\"description\":\"Set the attributes for the block example\",\"type\":\"object\"},\"innerBlocks\":{\"description\":\"Set the inner blocks that should be used within the block example. The blocks should be defined as a nested array like this:\\n\\n[ { \\\"name\\\": \\\"core/heading\\\", \\\"attributes\\\": { \\\"content\\\": \\\"This is an Example\\\" } } ]\\n\\nWhere each block itself is an object that contains the block name, the block attributes, and the blocks inner blocks.\",\"type\":\"array\"}}},\"blockHooks\":{\"description\":\"Block Hooks allow a block to automatically insert itself next to all instances of a given block type.\\n\\nSee the Block Hooks documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#block-hooks-optional for more details.\",\"type\":\"object\",\"patternProperties\":{\"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$\":{\"type\":\"string\",\"enum\":[\"before\",\"after\",\"firstChild\",\"lastChild\"]}},\"additionalProperties\":false},\"editorScript\":{\"description\":\"Block type editor script definition. It will only be enqueued in the context of the editor.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"script\":{\"description\":\"Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"viewScript\":{\"description\":\"Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"viewScriptModule\":{\"description\":\"Block type frontend script module definition. It will be enqueued only when viewing the content on the front of the site.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"editorStyle\":{\"description\":\"Block type editor style definition. It will only be enqueued in the context of the editor.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"style\":{\"description\":\"Block type frontend style definition. It will be enqueued both in the editor and when viewing the content on the front of the site.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"viewStyle\":{\"description\":\"Block type frontend style definition. It will be enqueued only when viewing the content on the front of the site.\",\"oneOf\":[{\"type\":\"string\"},{\"type\":\"array\",\"items\":{\"type\":\"string\"}}]},\"variations\":{\"description\":\"Block Variations is the API that allows a block to have similar versions of it, but all these versions share some common functionality.\",\"oneOf\":[{\"description\":\"The path to a PHP file that returns an array of block variations.\",\"type\":\"string\"},{\"description\":\"An array of block variations.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"description\":\"The unique and machine-readable name.\",\"type\":\"string\"},\"title\":{\"description\":\"A human-readable variation title.\",\"type\":\"string\"},\"description\":{\"description\":\"A detailed variation description.\",\"type\":\"string\"},\"category\":{\"description\":\"A category classification, used in search interfaces to arrange block types by category.\",\"anyOf\":[{\"type\":\"string\"},{\"type\":\"string\",\"enum\":[\"text\",\"media\",\"design\",\"widgets\",\"theme\",\"embed\"]}]},\"icon\":{\"description\":\"An icon helping to visualize the variation. It can have the same shape as the block type.\",\"type\":\"string\"},\"isDefault\":{\"description\":\"Indicates whether the current variation is the default one.\",\"type\":\"boolean\",\"default\":false},\"attributes\":{\"description\":\"Values that override block attributes.\",\"type\":\"object\"},\"innerBlocks\":{\"description\":\"Initial configuration of nested blocks.\",\"type\":\"array\",\"items\":{\"type\":\"array\"}},\"example\":{\"description\":\"Example provides structured data for the block preview. You can set to undefined to disable the preview shown for the block type.\",\"type\":\"object\"},\"scope\":{\"description\":\"The list of scopes where the variation is applicable.\",\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"inserter\",\"block\",\"transform\"]},\"default\":[\"inserter\",\"block\"]},\"keywords\":{\"description\":\"An array of terms (which can be translated) that help users discover the variation while searching.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"isActive\":{\"description\":\"The list of attributes that should be compared. Each attributes will be matched and the variation will be active if all of them are matching.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"required\":[\"name\",\"title\"],\"additionalProperties\":false}}]},\"render\":{\"description\":\"Template file loaded on the server when rendering a block.\",\"type\":\"string\"}},\"required\":[\"name\",\"title\"],\"additionalProperties\":false}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for WordPress blocks\". Here are the required top‑level fields: name, title. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"title":"JSON schema for WordPress blocks","$schema":"http://json-schema.org/draft-07/schema#","definitions":{"//":{"reference":"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-metadata/","attributesReference":"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/","contextReference":"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/","supportsReference":"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/","registerReference":"https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional"}},"type":"object","properties":{"$schema":{"type":"string"},"apiVersion":{"description":"The version of the Block API used by the block. The most recent version is 3 and it was introduced in WordPress 6.3.\n\n See the API versions documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/ for more details.","type":"integer","enum":[1,2,3],"default":1},"name":{"description":"The name for a block is a unique string that identifies a block. Names have to be structured as `namespace/block-name`, where namespace is the name of your plugin or theme.","type":"string","pattern":"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$"},"__experimental":{"description":"The name of the experiment this block is a part of, or boolean true if there is no specific experiment name.","anyOf":[{"type":"string"},{"type":"boolean"}]},"title":{"description":"This is the display title for your block, which can be translated with our translation functions. The block inserter will show this name.","type":"string"},"category":{"description":"Blocks are grouped into categories to help users browse and discover them.\n Core provided categories are: text, media, design, widgets, theme, embed\n\nPlugins and Themes can also register custom block categories.\n\nhttps://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#managing-block-categories","anyOf":[{"type":"string"},{"type":"string","enum":["text","media","design","widgets","theme","embed"]}]},"parent":{"description":"Setting parent lets a block require that it is only available when nested within the specified blocks. For example, you might want to allow an \u2018Add to Cart\u2019 block to only be available within a \u2018Product\u2019 block.","type":"array","items":{"type":"string"}},"ancestor":{"description":"The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a \u2018Comment Content\u2019 block inside a \u2018Column\u2019 block, as long as \u2018Column\u2019 is somewhere within a \u2018Comment Template\u2019 block.","type":"array","items":{"type":"string"}},"allowedBlocks":{"description":"The `allowedBlocks` property specifies that only the listed block types can be the children of this block. For example, a \u2018List\u2019 block allows only \u2018List Item\u2019 blocks as direct children.","type":"array","items":{"type":"string"}},"icon":{"description":"An icon property should be specified to make it easier to identify a block. These can be any of WordPress\u2019 Dashicons (slug serving also as a fallback in non-js contexts).","type":"string"},"description":{"description":"This is a short description for your block, which can be translated with our translation functions. This will be shown in the block inspector.","type":"string"},"keywords":{"description":"Sometimes a block could have aliases that help users discover it while searching. For example, an image block could also want to be discovered by photo. You can do so by providing an array of unlimited terms (which are translated).","type":"array","items":{"type":"string"}},"version":{"description":"The current version number of the block, such as 1.0 or 1.0.3. It\u2019s similar to how plugins are versioned. This field might be used with block assets to control cache invalidation, and when the block author omits it, then the installed version of WordPress is used instead.","type":"string"},"textdomain":{"description":"The gettext text domain of the plugin/block. More information can be found in the Text Domain section of the How to Internationalize your Plugin page.\n\nhttps://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/","type":"string"},"attributes":{"description":"Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface.\n\nSee the attributes documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/ for more details.","type":"object","patternProperties":{"[a-zA-Z]":{"type":"object","properties":{"type":{"description":"The type indicates the type of data that is stored by the attribute. It does not indicate where the data is stored, which is defined by the source field.\n\nA type is required, unless an enum is provided. A type can be used with an enum.\n\nNote that the validity of an object is determined by your source. For an example, see the query details below.","oneOf":[{"type":"string","enum":["null","boolean","object","array","string","rich-text","integer","number"]},{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["null","boolean","object","array","string","integer","number"]}}]},"enum":{"description":"An attribute can be defined as one of a fixed set of values. This is specified by an enum, which contains an array of allowed values:","type":"array","items":{"oneOf":[{"type":"boolean"},{"type":"number"},{"type":"string"}]}},"source":{"description":"Attribute sources are used to define how the attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block.","type":"string","enum":["attribute","text","rich-text","html","raw","query","meta"]},"selector":{"description":"The selector can be an HTML tag, or anything queryable with querySelector, such as a class or id attribute. Examples are given below.\n\nFor example, a selector of img will match an img element, and img.class will match an img element that has a class of class.","type":"string"},"attribute":{"description":"Use an attribute source to extract the value from an attribute in the markup. The attribute is specified by the attribute field, which must be supplied.\n\nExample: Extract the src attribute from an image found in the block\u2019s markup.","type":"string"},"query":{"description":"Use query to extract an array of values from markup. Entries of the array are determined by the selector argument, where each matched element within the block will have an entry structured corresponding to the second argument, an object of attribute sources.","type":"object"},"meta":{"description":"Although attributes may be obtained from a post\u2019s meta, meta attribute sources are considered deprecated; EntityProvider and related hook APIs should be used instead, as shown in the Create Meta Block how-to here:\n\nhttps://developer.wordpress.org/block-editor/how-to-guides/metabox/#step-2-add-meta-block","type":"string"},"role":{"description":"Designates the conceptual type of the attribute.\n\nThe `content` value marks the attribute as user-editable content, and the `local` value marks the attribute as temporary and non-persistable.","type":"string","enum":["content","local"]},"default":{"description":"A block attribute can contain a default value, which will be used if the type and source do not match anything within the block content.\n\nThe value is provided by the default field, and the value should match the expected format of the attribute."}},"anyOf":[{"required":["type"]},{"required":["enum"]}]}},"additionalProperties":false},"providesContext":{"description":"Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block\u2019s own attribute.\n\nSee the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.","type":"object","patternProperties":{"[a-zA-Z]":{"type":"string"}}},"usesContext":{"description":"Array of the names of context values to inherit from an ancestor provider.\n\nSee the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.","type":"array","items":{"type":"string"}},"supports":{"description":"It contains as set of options to control features used in the editor. See the supports documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/ for more details.","type":"object","properties":{"anchor":{"description":"Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link.","type":"boolean","default":false},"align":{"description":"This property adds block controls which allow to change block\u2019s alignment.","oneOf":[{"type":"boolean"},{"type":"array","items":{"type":"string","enum":["wide","full","left","center","right"]}}],"default":false},"alignWide":{"description":"This property allows to enable wide alignment for your theme. To disable this behavior for a single block, set this flag to false.","type":"boolean","default":true},"ariaLabel":{"description":"ARIA-labels let you define an accessible label for elements. This property allows enabling the definition of an aria-label for the block, without exposing a UI field.","type":"boolean","default":false},"className":{"description":"By default, the class .wp-block-your-block-name is added to the root element of your saved markup. This helps having a consistent mechanism for styling blocks that themes and plugins can rely on. If, for whatever reason, a class is not desired on the markup, this functionality can be disabled.","type":"boolean","default":true},"color":{"description":"This value signals that a block supports some of the properties related to color. When it does, the block editor will show UI controls for the user to set their values.\n\nNote that the background and text keys have a default value of true, so if the color property is present they\u2019ll also be considered enabled","type":"object","properties":{"background":{"description":"This property adds UI controls which allow the user to apply a solid background color to a block.\n\nWhen color support is declared, this property is enabled by default (along with text), so simply setting color will enable background color.\n\nTo disable background support while keeping other color supports enabled, set to false.\n\nWhen the block declares support for color.background, its attributes definition is extended to include two new attributes: backgroundColor and style","type":"boolean","default":true},"gradients":{"description":"This property adds UI controls which allow the user to apply a gradient background to a block.\n\nGradient presets are sourced from editor-gradient-presets theme support.\n\nWhen the block declares support for color.gradient, its attributes definition is extended to include two new attributes: gradient and style","type":"boolean","default":false},"link":{"description":"This property adds block controls which allow the user to set link color in a block, link color is disabled by default.\n\nLink color presets are sourced from the editor-color-palette theme support.\n\nWhen the block declares support for color.link, its attributes definition is extended to include the style attribute","type":"boolean","default":false},"text":{"description":"This property adds block controls which allow the user to set text color in a block.\n\nWhen color support is declared, this property is enabled by default (along with background), so simply setting color will enable text color.\n\nText color presets are sourced from the editor-color-palette theme support.\n\nWhen the block declares support for color.text, its attributes definition is extended to include two new attributes: textColor and style","type":"boolean","default":true},"heading":{"description":"This property adds block controls which allow the user to set heading colors in a block. Heading color is disabled by default.\n\nHeading color presets are sourced from the editor-color-palette theme support.\n\nWhen the block declares support for color.heading, its attributes definition is extended to include the style attribute","type":"boolean","default":false},"button":{"description":"This property adds block controls which allow the user to set button colors in a block. Button color is disabled by default.\n\nButton color presets are sourced from the editor-color-palette theme support.\n\nWhen the block declares support for color.button, its attributes definition is extended to include the style attribute","type":"boolean","default":false},"enableContrastChecker":{"description":"Determines whether the contrast checker widget displays in the block editor UI.\n\nThe contrast checker appears only if the block declares support for color. It tests the readability of color combinations and warns if there is a potential issue. The property is enabled by default.\n\nSet to `false` to explicitly disable.","type":"boolean","default":true}}},"customClassName":{"description":"This property adds a field to define a custom className for the block\u2019s wrapper.","type":"boolean","default":true},"dimensions":{"description":"This value signals that a block supports some of the CSS style properties related to dimensions. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific dimensions property, its attributes definition is extended to include the style attribute.","type":"object","properties":{"aspectRatio":{"description":"Allow blocks to define an aspect ratio value.","type":"boolean","default":false},"minHeight":{"description":"Allow blocks to define a minimum height value.","type":"boolean","default":false}}},"filter":{"description":"This value signals that a block supports some of the properties related to filters. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific filter property, its attributes definition is extended to include the style attribute.","type":"object","properties":{"duotone":{"description":"Allow blocks to define a duotone filter.","type":"boolean","default":false}}},"background":{"description":"This value signals that a block supports some of the CSS style properties related to background. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific background property, its attributes definition is extended to include the style attribute.","type":"object","properties":{"backgroundImage":{"description":"Allow blocks to define a background image.","type":"boolean","default":false},"backgroundSize":{"description":"Allow blocks to define values related to the size of a background image, including size, position, and repeat controls","type":"boolean","default":false}}},"html":{"description":"By default, a block\u2019s markup can be edited individually. To disable this behavior, set html to false.","type":"boolean","default":true},"inserter":{"description":"By default, all blocks will appear in the inserter, block transforms menu, Style Book, etc. To hide a block from all parts of the user interface so that it can only be inserted programmatically, set inserter to false.","type":"boolean","default":true},"renaming":{"description":"By default, a block can be renamed by a user from the block 'Options' dropdown or the 'Advanced' panel. To disable this behavior, set renaming to false.","type":"boolean","default":true},"layout":{"description":"This value only applies to blocks that are containers for inner blocks. If set to `true` the layout type will be `flow`. For other layout types it's necessary to set the `type` explicitly inside the `default` object.","oneOf":[{"type":"boolean"},{"type":"object","properties":{"default":{"description":"Allows setting the `type` property to define what layout type is default for the block, and also default values for any properties inherent to that layout type, e.g., for a `flex` layout, a default value can be set for `flexWrap`.","type":"object","properties":{"type":{"description":"The layout type.","type":"string","enum":["constrained","grid","flex"]},"contentSize":{"description":"The content size used on all children.","type":"string"},"wideSize":{"description":"The wide size used on alignwide children.","type":"string"},"justifyContent":{"description":"Content justification value.","type":"string","enum":["right","center","space-between","left","stretch"]},"orientation":{"description":"The orientation of the layout.","type":"string","enum":["horizontal","vertical"]},"flexWrap":{"description":"The flex wrap value.","type":"string","enum":["wrap","nowrap"]},"verticalAlignment":{"description":"The vertical alignment value.","type":"string","enum":["top","center","bottom","space-between","stretch"]},"minimumColumnWidth":{"description":"The minimum column width value.","type":"string"},"columnCount":{"description":"The column count value.","type":"number"}}},"allowSwitching":{"description":"Exposes a switcher control that allows toggling between all existing layout types.","type":"boolean","default":false},"allowEditing":{"description":"Determines display of layout controls in the block sidebar. If set to false, layout controls will be hidden.","type":"boolean","default":true},"allowInheriting":{"description":"For the `flow` layout type only, determines display of the `Inner blocks use content width` toggle.","type":"boolean","default":true},"allowSizingOnChildren":{"description":"For the `flex` layout type only, determines display of sizing controls (Fit/Fill/Fixed) on all child blocks of the flex block.","type":"boolean","default":false},"allowVerticalAlignment":{"description":"For the `flex` layout type only, determines display of vertical alignment controls in the block toolbar.","type":"boolean","default":true},"allowJustification":{"description":"For the `flex` layout type, determines display of justification controls in the block toolbar and block sidebar. For the `constrained` layout type, determines display of justification control in the block sidebar.","type":"boolean","default":true},"allowOrientation":{"description":"For the `flex` layout type only, determines display of the orientation control in the block toolbar.","type":"boolean","default":true},"allowCustomContentAndWideSize":{"description":"For the `constrained` layout type only, determines display of the custom content and wide size controls in the block sidebar.","type":"boolean","default":true}}}],"default":false},"multiple":{"description":"A non-multiple block can be inserted into each post, one time only. For example, the built-in \u2018More\u2019 block cannot be inserted again if it already exists in the post being edited. A non-multiple block\u2019s icon is automatically dimmed (unclickable) to prevent multiple instances.","type":"boolean","default":true},"reusable":{"description":"A block may want to disable the ability of being converted into a reusable block. By default all blocks can be converted to a reusable block. If supports reusable is set to false, the option to convert the block into a reusable block will not appear.","type":"boolean","default":true},"lock":{"description":"A block may want to disable the ability to toggle the lock state. It can be locked/unlocked by a user from the block 'Options' dropdown by default. To disable this behavior, set lock to false.","type":"boolean","default":true},"position":{"description":"This value signals that a block supports some of the CSS style properties related to position. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific position property, its attributes definition is extended to include the style attribute.","type":"object","properties":{"sticky":{"description":"Allow blocks to stick to their immediate parent when scrolling the page.","type":"boolean","default":false}}},"spacing":{"description":"This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific spacing property, its attributes definition is extended to include the style attribute.","type":"object","properties":{"margin":{"oneOf":[{"type":"boolean"},{"type":"array","items":{"type":"string","enum":["top","right","left","bottom"]}},{"type":"array","items":{"type":"string","enum":["vertical","horizontal"]}}]},"padding":{"oneOf":[{"type":"boolean"},{"type":"array","items":{"type":"string","enum":["top","right","left","bottom"]}},{"type":"array","items":{"type":"string","enum":["vertical","horizontal"]}}]}}},"shadow":{"description":"Allow blocks to define a box shadow.","oneOf":[{"description":"Defines whether a box shadow is enabled or not.","type":"boolean"},{"type":"object"}],"default":false},"typography":{"description":"This value signals that a block supports some of the CSS style properties related to typography. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.\n\nWhen the block declares support for a specific typography property, its attributes definition is extended to include the style attribute.","type":"object","properties":{"fontSize":{"description":"This value signals that a block supports the font-size CSS style property. When it does, the block editor will show an UI control for the user to set its value.\n\nThe values shown in this control are the ones declared by the theme via the editor-font-sizes theme support, or the default ones if none is provided.\n\nWhen the block declares support for fontSize, its attributes definition is extended to include two new attributes: fontSize and style","type":"boolean","default":false},"lineHeight":{"description":"This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if the theme declares support.\n\nWhen the block declares support for lineHeight, its attributes definition is extended to include a new attribute style of object type with no default assigned. It stores the custom value set by the user. The block can apply a default style by specifying its own style attribute with a default","type":"boolean","default":false},"textAlign":{"description":"This property adds block toolbar controls which allow to change block's text alignment.","oneOf":[{"type":"boolean"},{"type":"array","items":{"type":"string","enum":["left","center","right"]}}],"default":false}}},"interactivity":{"description":"Indicates if the block is using Interactivity API features.","oneOf":[{"description":"Indicates whether the block is using the Interactivity API directives.","type":"boolean","default":false},{"type":"object","properties":{"clientNavigation":{"description":"Indicates whether a block is compatible with the Interactivity API client-side navigation.\n\nSet it to true only if the block is not interactive or if it is interactive using the Interactivity API. Set it to false if the block is interactive but uses vanilla JS, jQuery or another JS framework/library other than the Interactivity API.","type":"boolean","default":false},"interactive":{"description":"Indicates whether the block is using the Interactivity API directives.","type":"boolean","default":false}}}]},"splitting":{"description":"This property indicates whether the block can split when the Enter key is pressed or when blocks are pasted.","type":"boolean","default":false}},"additionalProperties":true},"selectors":{"description":"Provides custom CSS selectors and mappings for the block. Selectors may be set for the block itself or per-feature e.g. typography. Custom selectors per feature or sub-feature, allow different block styles to be applied to different elements within the block.","type":"object","properties":{"root":{"description":"The primary CSS class to apply to the block. This replaces the `.wp-block-name` class if set.","type":"string"},"border":{"description":"Custom CSS selector used to generate rules for the block's theme.json border styles.","oneOf":[{"type":"string"},{"type":"object","properties":{"root":{"type":"string"},"color":{"type":"string"},"radius":{"type":"string"},"style":{"type":"string"},"width":{"type":"string"}}}]},"color":{"description":"Custom CSS selector used to generate rules for the block's theme.json color styles.","oneOf":[{"type":"string"},{"type":"object","properties":{"root":{"type":"string"},"text":{"type":"string"},"background":{"type":"string"}}}]},"dimensions":{"description":"Custom CSS selector used to generate rules for the block's theme.json dimensions styles.","oneOf":[{"type":"string"},{"type":"object","properties":{"root":{"type":"string"},"aspectRatio":{"type":"string"},"minHeight":{"type":"string"}}}]},"spacing":{"description":"Custom CSS selector used to generate rules for the block's theme.json spacing styles.","oneOf":[{"type":"string"},{"type":"object","properties":{"root":{"type":"string"},"blockGap":{"type":"string"},"padding":{"type":"string"},"margin":{"type":"string"}}}]},"typography":{"description":"Custom CSS selector used to generate rules for the block's theme.json typography styles.","oneOf":[{"type":"string"},{"type":"object","properties":{"root":{"type":"string"},"fontFamily":{"type":"string"},"fontSize":{"type":"string"},"fontStyle":{"type":"string"},"fontWeight":{"type":"string"},"lineHeight":{"type":"string"},"letterSpacing":{"type":"string"},"textDecoration":{"type":"string"},"textTransform":{"type":"string"}}}]}}},"styles":{"description":"Block styles can be used to provide alternative styles to block. It works by adding a class name to the block\u2019s wrapper. Using CSS, a theme developer can target the class name for the block style if it is selected.\n\nPlugins and Themes can also register custom block style for existing blocks.\n\nhttps://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/","type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"isDefault":{"type":"boolean","default":false}},"required":["name","label"],"additionalProperties":false}},"example":{"description":"It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block.\n\nSee the example documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional for more details.","type":"object","properties":{"viewportWidth":{"description":"The viewportWidth controls the width of the iFrame container in which the block preview will get rendered","type":"number","default":1200},"attributes":{"description":"Set the attributes for the block example","type":"object"},"innerBlocks":{"description":"Set the inner blocks that should be used within the block example. The blocks should be defined as a nested array like this:\n\n[ { \"name\": \"core/heading\", \"attributes\": { \"content\": \"This is an Example\" } } ]\n\nWhere each block itself is an object that contains the block name, the block attributes, and the blocks inner blocks.","type":"array"}}},"blockHooks":{"description":"Block Hooks allow a block to automatically insert itself next to all instances of a given block type.\n\nSee the Block Hooks documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#block-hooks-optional for more details.","type":"object","patternProperties":{"^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$":{"type":"string","enum":["before","after","firstChild","lastChild"]}},"additionalProperties":false},"editorScript":{"description":"Block type editor script definition. It will only be enqueued in the context of the editor.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"script":{"description":"Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"viewScript":{"description":"Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"viewScriptModule":{"description":"Block type frontend script module definition. It will be enqueued only when viewing the content on the front of the site.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"editorStyle":{"description":"Block type editor style definition. It will only be enqueued in the context of the editor.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"style":{"description":"Block type frontend style definition. It will be enqueued both in the editor and when viewing the content on the front of the site.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"viewStyle":{"description":"Block type frontend style definition. It will be enqueued only when viewing the content on the front of the site.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"variations":{"description":"Block Variations is the API that allows a block to have similar versions of it, but all these versions share some common functionality.","oneOf":[{"description":"The path to a PHP file that returns an array of block variations.","type":"string"},{"description":"An array of block variations.","type":"array","items":{"type":"object","properties":{"name":{"description":"The unique and machine-readable name.","type":"string"},"title":{"description":"A human-readable variation title.","type":"string"},"description":{"description":"A detailed variation description.","type":"string"},"category":{"description":"A category classification, used in search interfaces to arrange block types by category.","anyOf":[{"type":"string"},{"type":"string","enum":["text","media","design","widgets","theme","embed"]}]},"icon":{"description":"An icon helping to visualize the variation. It can have the same shape as the block type.","type":"string"},"isDefault":{"description":"Indicates whether the current variation is the default one.","type":"boolean","default":false},"attributes":{"description":"Values that override block attributes.","type":"object"},"innerBlocks":{"description":"Initial configuration of nested blocks.","type":"array","items":{"type":"array"}},"example":{"description":"Example provides structured data for the block preview. You can set to undefined to disable the preview shown for the block type.","type":"object"},"scope":{"description":"The list of scopes where the variation is applicable.","type":"array","items":{"type":"string","enum":["inserter","block","transform"]},"default":["inserter","block"]},"keywords":{"description":"An array of terms (which can be translated) that help users discover the variation while searching.","type":"array","items":{"type":"string"}},"isActive":{"description":"The list of attributes that should be compared. Each attributes will be matched and the variation will be active if all of them are matching.","type":"array","items":{"type":"string"}}},"required":["name","title"],"additionalProperties":false}}]},"render":{"description":"Template file loaded on the server when rendering a block.","type":"string"}},"required":["name","title"],"additionalProperties":false}
|
Provide a JSON object that satisfies the schema "JSON schema for WordPress blocks". Here are the required top‑level fields: name, title. Return only the valid JSON object.
|
JSON schema for WordPress blocks
|
schema-store
|
schema_store_95
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-06/schema#\",\"$ref\":\"#/definitions/Torque-Blueprint-Spec2\",\"definitions\":{\"Torque-Blueprint-Spec2\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"spec_version\":{\"type\":\"integer\",\"enum\":[2]},\"description\":{\"type\":\"string\"},\"workflow\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"scope\":{\"type\":\"string\"},\"label-selector\":{\"type\":\"string\"},\"labels-selector\":{\"type\":\"string\"},\"resource-types\":{\"type\":\"string\"},\"triggers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/WorkflowTrigger\"}}},\"title\":\"workflow metadata\"},\"instructions\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"text\":{\"type\":\"string\"},\"source\":{\"$ref\":\"#/definitions/InstructionsSourceObject\"}},\"oneOf\":[{\"required\":[\"text\"]},{\"required\":[\"source\"]}],\"title\":\"instructions\"},\"layout\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"exclude-from-layout\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"title\":\"Exclude From Layout\"},\"source\":{\"$ref\":\"#/definitions/LayoutSourceObject\"}},\"oneOf\":[{\"required\":[\"source\"]}],\"title\":\"Layout\"},\"inputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9-_ ().]{3,45}$\":{\"oneOf\":[{\"$ref\":\"#/definitions/BlueprintInputObject\"},{\"type\":\"null\"}]}},\"title\":\"Inputs\"},\"labels\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"oneOf\":[{\"$ref\":\"#/definitions/EnvironmentLabel\"},{\"type\":\"string\",\"pattern\":\"^{?[a-zA-Z0-9-_.@#\\\\s]+}?$\"}]}]},\"title\":\"Labels\"},\"outputs\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9-_ ().]{3,45}$\":{\"oneOf\":[{\"$ref\":\"#/definitions/BlueprintOutputObject\"},{\"type\":\"null\"}]}},\"title\":\"Outputs\"},\"env_references\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9-_ ().]{3,45}$\":{\"oneOf\":[{\"$ref\":\"#/definitions/BlueprintEnvReferenceObject\"},{\"type\":\"null\"}]}},\"title\":\"Environment References\"},\"resources\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9-_ ().]{3,45}$\":{\"$ref\":\"#/definitions/BlueprintResourceRequirementObject\"}},\"title\":\"Resources\"},\"grains\":{\"type\":\"object\",\"patternProperties\":{\"^[a-zA-Z0-9-_ ]{3,45}$\":{\"oneOf\":[{\"$ref\":\"#/definitions/GrainObject\"},{\"type\":\"null\"}]}},\"title\":\"Grains\"}},\"required\":[\"spec_version\"],\"title\":\"Torque Blueprint Spec 2\"},\"GrainObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"kind\":{\"type\":\"string\",\"enum\":[\"terraform\",\"helm\",\"ansible\",\"blueprint\",\"arm\",\"cloudformation\",\"kubernetes\",\"shell\",\"cloudshell\",\"argocd\",\"opentofu\",\"terragrunt\",\"aws-cdk\"]},\"env-labels\":{\"$ref\":\"#/definitions/GrainLabels\"},\"spec\":{\"$ref\":\"#/definitions/GrainSpecObject\"},\"depends-on\":{\"type\":\"string\",\"pattern\":\"^((.+)(,\\\\s*)?)+[^,]$\"},\"tf-version\":{\"type\":\"string\"}},\"required\":[\"kind\",\"spec\"],\"title\":\"Grain Object\"},\"GrainScripts\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"pre-tf-init\":{\"$ref\":\"#/definitions/ScriptObject\"},\"pre-tf-destroy\":{\"$ref\":\"#/definitions/ScriptObject\"},\"post-tf-plan\":{\"$ref\":\"#/definitions/ScriptObject\"},\"pre-ansible-run\":{\"$ref\":\"#/definitions/ScriptOutputsObject\"},\"post-helm-install\":{\"$ref\":\"#/definitions/ScriptOutputsObject\"},\"post-kubernetes-install\":{\"$ref\":\"#/definitions/ScriptOutputsObject\"},\"pre-aws-cdk-deploy\":{\"$ref\":\"#/definitions/ScriptObject\"},\"post-aws-cdk-deploy\":{\"$ref\":\"#/definitions/ScriptObject\"}}},\"ScriptSource\":{\"type\":\"object\",\"properties\":{\"path\":{\"type\":\"string\"},\"store\":{\"type\":\"string\"}}},\"ScriptObject\":{\"type\":\"object\",\"properties\":{\"source\":{\"$ref\":\"#/definitions/ScriptSource\"},\"arguments\":{\"type\":\"string\"}}},\"Backend\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\"},\"bucket\":{\"type\":\"string\"},\"region\":{\"type\":\"string\"},\"storage-account-name\":{\"type\":\"string\"},\"container-name\":{\"type\":\"string\"},\"base-address\":{\"type\":\"string\"},\"key-prefix\":{\"type\":\"string\"}}},\"TemplateStorage\":{\"type\":\"object\",\"properties\":{\"bucket-name\":{\"type\":\"string\"},\"region\":{\"type\":\"string\"},\"key-prefix\":{\"type\":\"string\"}},\"required\":[\"bucket-name\",\"region\"]},\"ScriptOutputsObject\":{\"type\":\"object\",\"properties\":{\"outputs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"source\":{\"$ref\":\"#/definitions/ScriptSource\"},\"arguments\":{\"type\":\"string\"}}},\"GrainTag\":{\"type\":\"object\",\"properties\":{\"auto-tag\":{\"type\":\"boolean\"},\"disable-tags-for\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"EnvironementVariable\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^[A-Za-z0-9_]+\":{\"type\":[\"string\",\"number\",\"boolean\"]}},\"title\":\"Envrironment Variable\"},\"WorkflowTrigger\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"manual\",\"event\",\"cron\"]},\"event\":{\"type\":\"array\",\"uniqueItems\":true,\"additionalItems\":false,\"items\":{\"type\":\"string\",\"enum\":[\"Drift Detected\",\"Updates Detected\",\"Approval Request Approved\",\"Approval Request Denied\",\"Approval Request Cancelled\",\"Environment Ended\",\"Environment Launched\",\"Environment Active With Error\",\"Environment Ending Failed\",\"Environment Force Ended\",\"Environment Extended\",\"Collaborator Added\",\"Environment Idle\",\"Parameter Updates Detected\",\"drift detected\",\"updates detected\",\"approval request approved\",\"approval request denied\",\"approval request cancelled\",\"environment ended\",\"environment launched\",\"environment active with error\",\"environment ending failed\",\"environment force ended\",\"environment extended\",\"collaborator added\",\"environment idle\",\"parameter updates detected\"]},\"contains\":{\"type\":\"string\"}},\"groups\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"}},\"cron\":{\"type\":\"string\"},\"overridable\":{\"type\":\"boolean\"}},\"title\":\"Workflow Trigger\"},\"AnsibleOnDestroy\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"source\":{\"$ref\":\"#/definitions/GrainSpecSourceObject\"},\"inputs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/GrainInput\"}},\"command-arguments\":{\"type\":\"string\"},\"scripts\":{\"$ref\":\"#/definitions/GrainScripts\"},\"inventory-file\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":true}}}},\"GrainSpecObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"files\":{\"$ref\":\"#/definitions/ShellGrainFiles\"},\"provider-overrides\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":true}},\"auto-approve\":{\"type\":\"boolean\"},\"sources\":{\"$ref\":\"#/definitions/GrainSpecSources\"},\"source\":{\"$ref\":\"#/definitions/GrainSpecSourceObject\"},\"agent\":{\"$ref\":\"#/definitions/GrainSpecHostObject\"},\"host\":{\"$ref\":\"#/definitions/GrainSpecHostObject\"},\"inputs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/GrainInput\"}},\"values-files\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"source\":{\"$ref\":\"#/definitions/ScriptSource\"}}}},\"workspace-directories\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"source\":{\"$ref\":\"#/definitions/ScriptSource\"}}}},\"outputs\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/GrainOutput\"}},\"env_references\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/GrainEnvReference\"}},\"commands\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/GrainCommand\"}},\"command-arguments\":{\"type\":\"string\"},\"scripts\":{\"$ref\":\"#/definitions/GrainScripts\"},\"tags\":{\"$ref\":\"#/definitions/GrainTag\"},\"env-vars\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/EnvironementVariable\"}},\"namespace\":{\"type\":\"string\"},\"target-namespace\":{\"type\":\"string\"},\"authentication\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"backend\":{\"$ref\":\"#/definitions/Backend\"},\"region\":{\"type\":\"string\"},\"version\":{\"type\":\"string\"},\"binary\":{\"type\":\"string\"},\"built-in\":{\"type\":\"boolean\"},\"auto-retry\":{\"type\":\"boolean\"},\"activities\":{\"$ref\":\"#/definitions/ActivitiesObject\"},\"release\":{\"type\":\"string\"},\"inventory-file\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":true}},\"tfvars-files\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"source\":{\"$ref\":\"#/definitions/TfVarsFileSourceObject\"}}}},\"template-storage\":{\"$ref\":\"#/definitions/TemplateStorage\"},\"mode\":{\"type\":\"string\",\"enum\":[\"data\"]},\"application-namespace\":{\"type\":\"string\"},\"application\":{\"type\":\"string\"},\"deployment-engine\":{\"type\":\"string\"},\"on-destroy\":{\"$ref\":\"#/definitions/AnsibleOnDestroy\"}},\"oneOf\":[{\"required\":[]}],\"title\":\"Grain Spec Object\"},\"ShellGrainFiles\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"source\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"branch\":{\"type\":\"string\"},\"commit\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}}}},\"ActivitiesObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"deploy\":{\"type\":\"object\",\"$ref\":\"#/definitions/ActivityObject\"},\"destroy\":{\"type\":\"object\",\"$ref\":\"#/definitions/ActivityObject\"}}},\"ActivityObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"commands\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"$ref\":\"#/definitions/CommandObject\"},{\"type\":\"string\"}]}}}},\"CommandObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"command\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"outputs\":{\"type\":\"array\"}}},\"GrainLabels\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"on-success\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"oneOf\":[{\"$ref\":\"#/definitions/EnvironmentLabel\"},{\"type\":\"string\",\"pattern\":\"^{?[a-zA-Z0-9-_.@#\\\\s]+}?$\"}]}]}},\"on-failure\":{\"type\":\"array\",\"items\":{\"allOf\":[{\"oneOf\":[{\"$ref\":\"#/definitions/EnvironmentLabel\"},{\"type\":\"string\",\"pattern\":\"^{?[a-zA-Z0-9-_.@#\\\\s]+}?$\"}]}]}}}},\"EnvironmentLabel\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^{?[a-zA-Z0-9-_.@#\\\\s]+}?$\":{\"type\":[\"string\",\"number\",\"boolean\",\"null\"]}}},\"PodLabels\":{\"type\":\"object\",\"additionalProperties\":true},\"PodAnnotations\":{\"type\":\"object\",\"additionalProperties\":true},\"NodeSelector\":{\"type\":\"object\",\"additionalProperties\":true},\"GrainInput\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^[\\\\w\\\\-\\\\.]+$\":{\"type\":[\"string\",\"number\",\"boolean\"]}},\"title\":\"Grain Input\"},\"GrainOutput\":{\"type\":\"string\",\"additionalProperties\":true,\"title\":\"Grain Output\"},\"GrainEnvReference\":{\"type\":\"object\",\"additionalProperties\":false,\"patternProperties\":{\"^[\\\\w\\\\-\\\\.]+$\":{\"type\":[\"string\"]}},\"title\":\"Grain Environment Reference\"},\"GrainCommand\":{\"type\":\"string\",\"additionalProperties\":true,\"title\":\"Grain Command\"},\"GrainSpecHostObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\"},\"region\":{\"type\":\"string\"},\"service-account\":{\"type\":\"string\"},\"image\":{\"type\":\"string\"},\"kubernetes\":{\"$ref\":\"#/definitions/KubernetesObject\"},\"runner-namespace\":{\"type\":\"string\"},\"storage-size\":{\"type\":\"integer\"},\"isolated\":{\"type\":\"boolean\"},\"use-storage\":{\"type\":\"boolean\"}},\"title\":\"Spec Host Properties\"},\"KubernetesObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"pod-labels\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/PodLabels\"}},\"pod-annotations\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/PodAnnotations\"}},\"node-selector\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/NodeSelector\"}},\"permissions\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"destination-context-name\":{\"type\":\"string\"},\"secret-name\":{\"type\":\"string\"},\"secret-namespace\":{\"type\":\"string\"}}}}},\"GrainSpecSourceObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"store\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"branch\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"},\"commit\":{\"type\":\"string\"},\"resource-type\":{\"type\":\"string\"}},\"required\":[\"path\"],\"title\":\"PurpleSource\"},\"GrainSpecSources\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/GrainSpecSourceObject\"}},\"TfVarsFileSourceObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"store\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"commit\":{\"type\":\"string\"},\"tag\":{\"type\":\"string\"},\"branch\":{\"type\":\"string\"}},\"required\":[\"path\"],\"title\":\"TfVarsFileSource\"},\"BlueprintInputObject\":{\"title\":\"Blueprint Input Object\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"parameter-name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\",\"enum\":[\"string\",\"execution-host\",\"agent\",\"credentials\",\"parameter\",\"env\",\"input-source\",\"file\"]},\"style\":{\"type\":\"string\",\"enum\":[\"radio\",\"text\"],\"default\":\"text\"},\"description\":{\"type\":\"string\",\"description\":\"In the relevant UI field, enter a description to be displayed to the user.\"},\"default\":{\"type\":[\"integer\",\"string\",\"boolean\"]},\"sensitive\":{\"type\":\"boolean\"},\"pattern\":{\"type\":\"string\"},\"validation-description\":{\"type\":\"string\"},\"allowed-values\":{\"type\":\"array\",\"items\":{\"type\":[\"string\",\"integer\",\"boolean\"]}},\"depends-on\":{\"type\":\"string\",\"pattern\":\"^((.+)(,\\\\s*)?)+[^,]$\"},\"source-name\":{\"type\":\"string\"},\"overrides\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"bucket_name\":{\"type\":\"string\"},\"path_prefix\":{\"type\":\"string\"},\"filter\":{\"type\":\"string\"},\"object_key\":{\"type\":\"string\"},\"json_path\":{\"type\":\"string\"},\"display_json_path\":{\"type\":\"string\"},\"storage_account_name\":{\"type\":\"string\"},\"container_name\":{\"type\":\"string\"},\"blob_name\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"query\":{\"type\":\"string\"}},\"additionalProperties\":false}},\"max-size-MB\":{\"type\":\"number\"},\"max-files\":{\"type\":\"integer\"},\"allowed-formats\":{\"type\":\"array\"}}},\"BlueprintOutputObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"value\":{\"type\":\"string\"},\"kind\":{\"type\":\"string\",\"enum\":[\"regular\",\"link\"]},\"quick\":{\"type\":\"boolean\",\"default\":true}},\"required\":[\"value\"],\"title\":\"Blueptint Output Object\"},\"BlueprintEnvReferenceObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"labels-selector\":{\"type\":\"string\"}},\"title\":\"Blueptint Environment Reference Object\"},\"BlueprintResourceRequirementObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"selector\":{\"$ref\":\"#/definitions/ResourceSelectorObject\"}},\"required\":[\"selector\"],\"title\":\"Blueptint Resource Requirement\"},\"ResourceSelectorObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\"},\"quantity\":{\"type\":[\"integer\",\"string\"]}},\"required\":[\"type\"],\"title\":\"Blueptint Resource Selector\"},\"InstructionsSourceObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"store\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"}},\"required\":[\"path\",\"store\"],\"title\":\"InstructionsSource\"},\"LayoutSourceObject\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"store\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"}},\"required\":[\"path\",\"store\"],\"title\":\"LayoutSource\"}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"blueprint-spec2-schema\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-06/schema#","$ref":"#/definitions/Torque-Blueprint-Spec2","definitions":{"Torque-Blueprint-Spec2":{"type":"object","additionalProperties":false,"properties":{"spec_version":{"type":"integer","enum":[2]},"description":{"type":"string"},"workflow":{"type":"object","additionalProperties":false,"properties":{"scope":{"type":"string"},"label-selector":{"type":"string"},"labels-selector":{"type":"string"},"resource-types":{"type":"string"},"triggers":{"type":"array","items":{"$ref":"#/definitions/WorkflowTrigger"}}},"title":"workflow metadata"},"instructions":{"type":"object","additionalProperties":false,"properties":{"text":{"type":"string"},"source":{"$ref":"#/definitions/InstructionsSourceObject"}},"oneOf":[{"required":["text"]},{"required":["source"]}],"title":"instructions"},"layout":{"type":"object","additionalProperties":false,"properties":{"exclude-from-layout":{"type":"array","items":{"type":"string"},"title":"Exclude From Layout"},"source":{"$ref":"#/definitions/LayoutSourceObject"}},"oneOf":[{"required":["source"]}],"title":"Layout"},"inputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_ ().]{3,45}$":{"oneOf":[{"$ref":"#/definitions/BlueprintInputObject"},{"type":"null"}]}},"title":"Inputs"},"labels":{"type":"array","items":{"allOf":[{"oneOf":[{"$ref":"#/definitions/EnvironmentLabel"},{"type":"string","pattern":"^{?[a-zA-Z0-9-_.@#\\s]+}?$"}]}]},"title":"Labels"},"outputs":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_ ().]{3,45}$":{"oneOf":[{"$ref":"#/definitions/BlueprintOutputObject"},{"type":"null"}]}},"title":"Outputs"},"env_references":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_ ().]{3,45}$":{"oneOf":[{"$ref":"#/definitions/BlueprintEnvReferenceObject"},{"type":"null"}]}},"title":"Environment References"},"resources":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_ ().]{3,45}$":{"$ref":"#/definitions/BlueprintResourceRequirementObject"}},"title":"Resources"},"grains":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_ ]{3,45}$":{"oneOf":[{"$ref":"#/definitions/GrainObject"},{"type":"null"}]}},"title":"Grains"}},"required":["spec_version"],"title":"Torque Blueprint Spec 2"},"GrainObject":{"type":"object","additionalProperties":false,"properties":{"kind":{"type":"string","enum":["terraform","helm","ansible","blueprint","arm","cloudformation","kubernetes","shell","cloudshell","argocd","opentofu","terragrunt","aws-cdk"]},"env-labels":{"$ref":"#/definitions/GrainLabels"},"spec":{"$ref":"#/definitions/GrainSpecObject"},"depends-on":{"type":"string","pattern":"^((.+)(,\\s*)?)+[^,]$"},"tf-version":{"type":"string"}},"required":["kind","spec"],"title":"Grain Object"},"GrainScripts":{"type":"object","additionalProperties":false,"properties":{"pre-tf-init":{"$ref":"#/definitions/ScriptObject"},"pre-tf-destroy":{"$ref":"#/definitions/ScriptObject"},"post-tf-plan":{"$ref":"#/definitions/ScriptObject"},"pre-ansible-run":{"$ref":"#/definitions/ScriptOutputsObject"},"post-helm-install":{"$ref":"#/definitions/ScriptOutputsObject"},"post-kubernetes-install":{"$ref":"#/definitions/ScriptOutputsObject"},"pre-aws-cdk-deploy":{"$ref":"#/definitions/ScriptObject"},"post-aws-cdk-deploy":{"$ref":"#/definitions/ScriptObject"}}},"ScriptSource":{"type":"object","properties":{"path":{"type":"string"},"store":{"type":"string"}}},"ScriptObject":{"type":"object","properties":{"source":{"$ref":"#/definitions/ScriptSource"},"arguments":{"type":"string"}}},"Backend":{"type":"object","properties":{"type":{"type":"string"},"bucket":{"type":"string"},"region":{"type":"string"},"storage-account-name":{"type":"string"},"container-name":{"type":"string"},"base-address":{"type":"string"},"key-prefix":{"type":"string"}}},"TemplateStorage":{"type":"object","properties":{"bucket-name":{"type":"string"},"region":{"type":"string"},"key-prefix":{"type":"string"}},"required":["bucket-name","region"]},"ScriptOutputsObject":{"type":"object","properties":{"outputs":{"type":"array","items":{"type":"string"}},"source":{"$ref":"#/definitions/ScriptSource"},"arguments":{"type":"string"}}},"GrainTag":{"type":"object","properties":{"auto-tag":{"type":"boolean"},"disable-tags-for":{"type":"array","items":{"type":"string"}}}},"EnvironementVariable":{"type":"object","additionalProperties":false,"patternProperties":{"^[A-Za-z0-9_]+":{"type":["string","number","boolean"]}},"title":"Envrironment Variable"},"WorkflowTrigger":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["manual","event","cron"]},"event":{"type":"array","uniqueItems":true,"additionalItems":false,"items":{"type":"string","enum":["Drift Detected","Updates Detected","Approval Request Approved","Approval Request Denied","Approval Request Cancelled","Environment Ended","Environment Launched","Environment Active With Error","Environment Ending Failed","Environment Force Ended","Environment Extended","Collaborator Added","Environment Idle","Parameter Updates Detected","drift detected","updates detected","approval request approved","approval request denied","approval request cancelled","environment ended","environment launched","environment active with error","environment ending failed","environment force ended","environment extended","collaborator added","environment idle","parameter updates detected"]},"contains":{"type":"string"}},"groups":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"cron":{"type":"string"},"overridable":{"type":"boolean"}},"title":"Workflow Trigger"},"AnsibleOnDestroy":{"type":"object","additionalProperties":false,"properties":{"source":{"$ref":"#/definitions/GrainSpecSourceObject"},"inputs":{"type":"array","items":{"$ref":"#/definitions/GrainInput"}},"command-arguments":{"type":"string"},"scripts":{"$ref":"#/definitions/GrainScripts"},"inventory-file":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true}}}},"GrainSpecObject":{"type":"object","additionalProperties":false,"properties":{"files":{"$ref":"#/definitions/ShellGrainFiles"},"provider-overrides":{"type":"array","items":{"type":"object","additionalProperties":true}},"auto-approve":{"type":"boolean"},"sources":{"$ref":"#/definitions/GrainSpecSources"},"source":{"$ref":"#/definitions/GrainSpecSourceObject"},"agent":{"$ref":"#/definitions/GrainSpecHostObject"},"host":{"$ref":"#/definitions/GrainSpecHostObject"},"inputs":{"type":"array","items":{"$ref":"#/definitions/GrainInput"}},"values-files":{"type":"array","items":{"type":"object","properties":{"source":{"$ref":"#/definitions/ScriptSource"}}}},"workspace-directories":{"type":"array","items":{"type":"object","properties":{"source":{"$ref":"#/definitions/ScriptSource"}}}},"outputs":{"type":"array","items":{"$ref":"#/definitions/GrainOutput"}},"env_references":{"type":"array","items":{"$ref":"#/definitions/GrainEnvReference"}},"commands":{"type":"array","items":{"$ref":"#/definitions/GrainCommand"}},"command-arguments":{"type":"string"},"scripts":{"$ref":"#/definitions/GrainScripts"},"tags":{"$ref":"#/definitions/GrainTag"},"env-vars":{"type":"array","items":{"$ref":"#/definitions/EnvironementVariable"}},"namespace":{"type":"string"},"target-namespace":{"type":"string"},"authentication":{"type":"array","items":{"type":"string"}},"backend":{"$ref":"#/definitions/Backend"},"region":{"type":"string"},"version":{"type":"string"},"binary":{"type":"string"},"built-in":{"type":"boolean"},"auto-retry":{"type":"boolean"},"activities":{"$ref":"#/definitions/ActivitiesObject"},"release":{"type":"string"},"inventory-file":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true}},"tfvars-files":{"type":"array","items":{"type":"object","properties":{"source":{"$ref":"#/definitions/TfVarsFileSourceObject"}}}},"template-storage":{"$ref":"#/definitions/TemplateStorage"},"mode":{"type":"string","enum":["data"]},"application-namespace":{"type":"string"},"application":{"type":"string"},"deployment-engine":{"type":"string"},"on-destroy":{"$ref":"#/definitions/AnsibleOnDestroy"}},"oneOf":[{"required":[]}],"title":"Grain Spec Object"},"ShellGrainFiles":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string"},"path":{"type":"string"},"branch":{"type":"string"},"commit":{"type":"string"},"name":{"type":"string"}}}},"ActivitiesObject":{"type":"object","additionalProperties":false,"properties":{"deploy":{"type":"object","$ref":"#/definitions/ActivityObject"},"destroy":{"type":"object","$ref":"#/definitions/ActivityObject"}}},"ActivityObject":{"type":"object","additionalProperties":false,"properties":{"commands":{"type":"array","items":{"anyOf":[{"$ref":"#/definitions/CommandObject"},{"type":"string"}]}}}},"CommandObject":{"type":"object","additionalProperties":false,"properties":{"command":{"type":"string"},"name":{"type":"string"},"outputs":{"type":"array"}}},"GrainLabels":{"type":"object","additionalProperties":false,"properties":{"on-success":{"type":"array","items":{"allOf":[{"oneOf":[{"$ref":"#/definitions/EnvironmentLabel"},{"type":"string","pattern":"^{?[a-zA-Z0-9-_.@#\\s]+}?$"}]}]}},"on-failure":{"type":"array","items":{"allOf":[{"oneOf":[{"$ref":"#/definitions/EnvironmentLabel"},{"type":"string","pattern":"^{?[a-zA-Z0-9-_.@#\\s]+}?$"}]}]}}}},"EnvironmentLabel":{"type":"object","additionalProperties":false,"patternProperties":{"^{?[a-zA-Z0-9-_.@#\\s]+}?$":{"type":["string","number","boolean","null"]}}},"PodLabels":{"type":"object","additionalProperties":true},"PodAnnotations":{"type":"object","additionalProperties":true},"NodeSelector":{"type":"object","additionalProperties":true},"GrainInput":{"type":"object","additionalProperties":false,"patternProperties":{"^[\\w\\-\\.]+$":{"type":["string","number","boolean"]}},"title":"Grain Input"},"GrainOutput":{"type":"string","additionalProperties":true,"title":"Grain Output"},"GrainEnvReference":{"type":"object","additionalProperties":false,"patternProperties":{"^[\\w\\-\\.]+$":{"type":["string"]}},"title":"Grain Environment Reference"},"GrainCommand":{"type":"string","additionalProperties":true,"title":"Grain Command"},"GrainSpecHostObject":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"region":{"type":"string"},"service-account":{"type":"string"},"image":{"type":"string"},"kubernetes":{"$ref":"#/definitions/KubernetesObject"},"runner-namespace":{"type":"string"},"storage-size":{"type":"integer"},"isolated":{"type":"boolean"},"use-storage":{"type":"boolean"}},"title":"Spec Host Properties"},"KubernetesObject":{"type":"object","additionalProperties":false,"properties":{"pod-labels":{"type":"array","items":{"$ref":"#/definitions/PodLabels"}},"pod-annotations":{"type":"array","items":{"$ref":"#/definitions/PodAnnotations"}},"node-selector":{"type":"array","items":{"$ref":"#/definitions/NodeSelector"}},"permissions":{"type":"object","additionalProperties":false,"properties":{"destination-context-name":{"type":"string"},"secret-name":{"type":"string"},"secret-namespace":{"type":"string"}}}}},"GrainSpecSourceObject":{"type":"object","additionalProperties":false,"properties":{"store":{"type":"string"},"path":{"type":"string"},"branch":{"type":"string"},"tag":{"type":"string"},"commit":{"type":"string"},"resource-type":{"type":"string"}},"required":["path"],"title":"PurpleSource"},"GrainSpecSources":{"type":"array","items":{"$ref":"#/definitions/GrainSpecSourceObject"}},"TfVarsFileSourceObject":{"type":"object","additionalProperties":false,"properties":{"store":{"type":"string"},"path":{"type":"string"},"commit":{"type":"string"},"tag":{"type":"string"},"branch":{"type":"string"}},"required":["path"],"title":"TfVarsFileSource"},"BlueprintInputObject":{"title":"Blueprint Input Object","type":"object","additionalProperties":false,"properties":{"parameter-name":{"type":"string"},"type":{"type":"string","enum":["string","execution-host","agent","credentials","parameter","env","input-source","file"]},"style":{"type":"string","enum":["radio","text"],"default":"text"},"description":{"type":"string","description":"In the relevant UI field, enter a description to be displayed to the user."},"default":{"type":["integer","string","boolean"]},"sensitive":{"type":"boolean"},"pattern":{"type":"string"},"validation-description":{"type":"string"},"allowed-values":{"type":"array","items":{"type":["string","integer","boolean"]}},"depends-on":{"type":"string","pattern":"^((.+)(,\\s*)?)+[^,]$"},"source-name":{"type":"string"},"overrides":{"type":"array","items":{"type":"object","properties":{"bucket_name":{"type":"string"},"path_prefix":{"type":"string"},"filter":{"type":"string"},"object_key":{"type":"string"},"json_path":{"type":"string"},"display_json_path":{"type":"string"},"storage_account_name":{"type":"string"},"container_name":{"type":"string"},"blob_name":{"type":"string"},"path":{"type":"string"},"query":{"type":"string"}},"additionalProperties":false}},"max-size-MB":{"type":"number"},"max-files":{"type":"integer"},"allowed-formats":{"type":"array"}}},"BlueprintOutputObject":{"type":"object","additionalProperties":false,"properties":{"value":{"type":"string"},"kind":{"type":"string","enum":["regular","link"]},"quick":{"type":"boolean","default":true}},"required":["value"],"title":"Blueptint Output Object"},"BlueprintEnvReferenceObject":{"type":"object","additionalProperties":false,"properties":{"labels-selector":{"type":"string"}},"title":"Blueptint Environment Reference Object"},"BlueprintResourceRequirementObject":{"type":"object","additionalProperties":false,"properties":{"selector":{"$ref":"#/definitions/ResourceSelectorObject"}},"required":["selector"],"title":"Blueptint Resource Requirement"},"ResourceSelectorObject":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string"},"quantity":{"type":["integer","string"]}},"required":["type"],"title":"Blueptint Resource Selector"},"InstructionsSourceObject":{"type":"object","additionalProperties":false,"properties":{"store":{"type":"string"},"path":{"type":"string"}},"required":["path","store"],"title":"InstructionsSource"},"LayoutSourceObject":{"type":"object","additionalProperties":false,"properties":{"store":{"type":"string"},"path":{"type":"string"}},"required":["path","store"],"title":"LayoutSource"}}}
|
Provide a JSON object that satisfies the schema "blueprint-spec2-schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
blueprint-spec2-schema
|
schema-store
|
schema_store_96
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"http://cyclonedx.org/schema/bom-1.6.schema.json\",\"type\":\"object\",\"title\":\"CycloneDX Bill of Materials Standard\",\"$comment\":\"CycloneDX JSON schema is published under the terms of the Apache License 2.0.\",\"required\":[\"bomFormat\",\"specVersion\"],\"additionalProperties\":false,\"properties\":{\"$schema\":{\"type\":\"string\"},\"bomFormat\":{\"type\":\"string\",\"title\":\"BOM Format\",\"description\":\"Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention, nor does JSON schema support namespaces. This value must be \\\"CycloneDX\\\".\",\"enum\":[\"CycloneDX\"]},\"specVersion\":{\"type\":\"string\",\"title\":\"CycloneDX Specification Version\",\"description\":\"The version of the CycloneDX specification the BOM conforms to.\",\"examples\":[\"1.6\"]},\"serialNumber\":{\"type\":\"string\",\"title\":\"BOM Serial Number\",\"description\":\"Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to [RFC 4122](https://www.ietf.org/rfc/rfc4122.html). Use of serial numbers is recommended.\",\"examples\":[\"urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79\"],\"pattern\":\"^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$\"},\"version\":{\"type\":\"integer\",\"title\":\"BOM Version\",\"description\":\"Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.\",\"minimum\":1,\"default\":1,\"examples\":[1]},\"metadata\":{\"$ref\":\"#/definitions/metadata\",\"title\":\"BOM Metadata\",\"description\":\"Provides additional information about a BOM.\"},\"components\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/component\"},\"uniqueItems\":true,\"title\":\"Components\",\"description\":\"A list of software and hardware components.\"},\"services\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/service\"},\"uniqueItems\":true,\"title\":\"Services\",\"description\":\"A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services.\"},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"},\"dependencies\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dependency\"},\"uniqueItems\":true,\"title\":\"Dependencies\",\"description\":\"Provides the ability to document dependency relationships including provided & implemented components.\"},\"compositions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/compositions\"},\"uniqueItems\":true,\"title\":\"Compositions\",\"description\":\"Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described.\"},\"vulnerabilities\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/vulnerability\"},\"uniqueItems\":true,\"title\":\"Vulnerabilities\",\"description\":\"Vulnerabilities identified in components or services.\"},\"annotations\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/annotations\"},\"uniqueItems\":true,\"title\":\"Annotations\",\"description\":\"Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed.\"},\"formulation\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/formula\"},\"uniqueItems\":true,\"title\":\"Formulation\",\"description\":\"Describes how a component or service was manufactured or deployed. This is achieved through the use of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the observed formulas describing the steps which transpired in the manufacturing process.\"},\"declarations\":{\"type\":\"object\",\"title\":\"Declarations\",\"description\":\"The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.\",\"additionalProperties\":false,\"properties\":{\"assessors\":{\"type\":\"array\",\"title\":\"Assessors\",\"description\":\"The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment.\",\"items\":{\"type\":\"object\",\"title\":\"Assessor\",\"description\":\"The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment.\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\"},\"thirdParty\":{\"type\":\"boolean\",\"title\":\"Third Party\",\"description\":\"The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor.\"},\"organization\":{\"$ref\":\"#/definitions/organizationalEntity\",\"title\":\"Organization\",\"description\":\"The entity issuing the assessment.\"}}}},\"attestations\":{\"type\":\"array\",\"title\":\"Attestations\",\"description\":\"The list of attestations asserted by an assessor that maps requirements to claims.\",\"items\":{\"type\":\"object\",\"title\":\"Attestation\",\"additionalProperties\":false,\"properties\":{\"summary\":{\"type\":\"string\",\"title\":\"Summary\",\"description\":\"The short description explaining the main points of the attestation.\"},\"assessor\":{\"$ref\":\"#/definitions/refLinkType\",\"title\":\"Assessor\",\"description\":\"The `bom-ref` to the assessor asserting the attestation.\"},\"map\":{\"type\":\"array\",\"title\":\"Map\",\"description\":\"The grouping of requirements to claims and the attestors declared conformance and confidence thereof.\",\"items\":{\"type\":\"object\",\"title\":\"Map\",\"additionalProperties\":false,\"properties\":{\"requirement\":{\"$ref\":\"#/definitions/refLinkType\",\"title\":\"Requirement\",\"description\":\"The `bom-ref` to the requirement being attested to.\"},\"claims\":{\"type\":\"array\",\"title\":\"Claims\",\"description\":\"The list of `bom-ref` to the claims being attested to.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}},\"counterClaims\":{\"type\":\"array\",\"title\":\"Counter Claims\",\"description\":\"The list of `bom-ref` to the counter claims being attested to.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}},\"conformance\":{\"type\":\"object\",\"title\":\"Conformance\",\"description\":\"The conformance of the claim meeting a requirement.\",\"additionalProperties\":false,\"properties\":{\"score\":{\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"title\":\"Score\",\"description\":\"The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance.\"},\"rationale\":{\"type\":\"string\",\"title\":\"Rationale\",\"description\":\"The rationale for the conformance score.\"},\"mitigationStrategies\":{\"type\":\"array\",\"title\":\"Mitigation Strategies\",\"description\":\"The list of `bom-ref` to the evidence provided describing the mitigation strategies.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}}}},\"confidence\":{\"type\":\"object\",\"title\":\"Confidence\",\"description\":\"The confidence of the claim meeting the requirement.\",\"additionalProperties\":false,\"properties\":{\"score\":{\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"title\":\"Score\",\"description\":\"The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence.\"},\"rationale\":{\"type\":\"string\",\"title\":\"Rationale\",\"description\":\"The rationale for the confidence score.\"}}}}}},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}}},\"claims\":{\"type\":\"array\",\"title\":\"Claims\",\"description\":\"The list of claims.\",\"items\":{\"type\":\"object\",\"title\":\"Claim\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\"},\"target\":{\"$ref\":\"#/definitions/refLinkType\",\"title\":\"Target\",\"description\":\"The `bom-ref` to a target representing a specific system, application, API, module, team, person, process, business unit, company, etc... that this claim is being applied to.\"},\"predicate\":{\"type\":\"string\",\"title\":\"Predicate\",\"description\":\"The specific statement or assertion about the target.\"},\"mitigationStrategies\":{\"type\":\"array\",\"title\":\"Mitigation Strategies\",\"description\":\"The list of `bom-ref` to the evidence provided describing the mitigation strategies. Each mitigation strategy should include an explanation of how any weaknesses in the evidence will be mitigated.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}},\"reasoning\":{\"type\":\"string\",\"title\":\"Reasoning\",\"description\":\"The written explanation of why the evidence provided substantiates the claim.\"},\"evidence\":{\"type\":\"array\",\"title\":\"Evidence\",\"description\":\"The list of `bom-ref` to evidence that supports this claim.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}},\"counterEvidence\":{\"type\":\"array\",\"title\":\"Counter Evidence\",\"description\":\"The list of `bom-ref` to counterEvidence that supports this claim.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}}},\"evidence\":{\"type\":\"array\",\"title\":\"Evidence\",\"description\":\"The list of evidence\",\"items\":{\"type\":\"object\",\"title\":\"Evidence\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\"},\"propertyName\":{\"type\":\"string\",\"title\":\"Property Name\",\"description\":\"The reference to the property name as defined in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy/).\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"The written description of what this evidence is and how it was created.\"},\"data\":{\"type\":\"array\",\"title\":\"Data\",\"description\":\"The output or analysis that supports claims.\",\"items\":{\"type\":\"object\",\"title\":\"Data\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"Data Name\",\"description\":\"The name of the data.\",\"type\":\"string\"},\"contents\":{\"type\":\"object\",\"title\":\"Data Contents\",\"description\":\"The contents or references to the contents of the data being described.\",\"additionalProperties\":false,\"properties\":{\"attachment\":{\"title\":\"Data Attachment\",\"description\":\"An optional way to include textual or encoded data.\",\"$ref\":\"#/definitions/attachment\"},\"url\":{\"type\":\"string\",\"title\":\"Data URL\",\"description\":\"The URL to where the data can be retrieved.\",\"format\":\"iri-reference\"}}},\"classification\":{\"$ref\":\"#/definitions/dataClassification\"},\"sensitiveData\":{\"type\":\"array\",\"title\":\"Sensitive Data\",\"description\":\"A description of any sensitive data included.\",\"items\":{\"type\":\"string\"}},\"governance\":{\"title\":\"Data Governance\",\"$ref\":\"#/definitions/dataGovernance\"}}}},\"created\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created\",\"description\":\"The date and time (timestamp) when the evidence was created.\"},\"expires\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Expires\",\"description\":\"The optional date and time (timestamp) when the evidence is no longer valid.\"},\"author\":{\"$ref\":\"#/definitions/organizationalContact\",\"title\":\"Author\",\"description\":\"The author of the evidence.\"},\"reviewer\":{\"$ref\":\"#/definitions/organizationalContact\",\"title\":\"Reviewer\",\"description\":\"The reviewer of the evidence.\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}}},\"targets\":{\"type\":\"object\",\"title\":\"Targets\",\"description\":\"The list of targets which claims are made against.\",\"additionalProperties\":false,\"properties\":{\"organizations\":{\"type\":\"array\",\"title\":\"Organizations\",\"description\":\"The list of organizations which claims are made against.\",\"items\":{\"$ref\":\"#/definitions/organizationalEntity\"}},\"components\":{\"type\":\"array\",\"title\":\"Components\",\"description\":\"The list of components which claims are made against.\",\"items\":{\"$ref\":\"#/definitions/component\"}},\"services\":{\"type\":\"array\",\"title\":\"Services\",\"description\":\"The list of services which claims are made against.\",\"items\":{\"$ref\":\"#/definitions/service\"}}}},\"affirmation\":{\"type\":\"object\",\"title\":\"Affirmation\",\"description\":\"A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment. It includes a list of authorized signatories who assert the validity of the document on behalf of the organization.\",\"additionalProperties\":false,\"properties\":{\"statement\":{\"type\":\"string\",\"title\":\"Statement\",\"description\":\"The brief statement affirmed by an individual regarding all declarations.\\n*- Notes This could be an affirmation of acceptance by a third-party auditor or receiving individual of a file.\",\"examples\":[\"I certify, to the best of my knowledge, that all information is correct.\"]},\"signatories\":{\"type\":\"array\",\"title\":\"Signatories\",\"description\":\"The list of signatories authorized on behalf of an organization to assert validity of this document.\",\"items\":{\"type\":\"object\",\"title\":\"Signatory\",\"additionalProperties\":false,\"oneOf\":[{\"required\":[\"signature\"]},{\"required\":[\"externalReference\",\"organization\"]}],\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The signatory's name.\"},\"role\":{\"type\":\"string\",\"title\":\"Role\",\"description\":\"The signatory's role within an organization.\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"},\"organization\":{\"$ref\":\"#/definitions/organizationalEntity\",\"title\":\"Organization\",\"description\":\"The signatory's organization.\"},\"externalReference\":{\"$ref\":\"#/definitions/externalReference\",\"title\":\"External Reference\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"}}}},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"definitions\":{\"type\":\"object\",\"title\":\"Definitions\",\"description\":\"A collection of reusable objects that are defined and may be used elsewhere in the BOM.\",\"additionalProperties\":false,\"properties\":{\"standards\":{\"type\":\"array\",\"title\":\"Standards\",\"description\":\"The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.\",\"items\":{\"$ref\":\"#/definitions/standard\"}}}},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}},\"definitions\":{\"refType\":{\"description\":\"Identifier for referable and therefore interlinkable elements.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"type\":\"string\",\"minLength\":1,\"$comment\":\"TODO (breaking change): add a format constraint that prevents the value from staring with 'urn:cdx:'\"},\"refLinkType\":{\"description\":\"Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\\nIn contrast to `bomLinkElementType`.\",\"$ref\":\"#/definitions/refType\"},\"bomLinkDocumentType\":{\"title\":\"BOM-Link Document\",\"description\":\"Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/\",\"type\":\"string\",\"format\":\"iri-reference\",\"pattern\":\"^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$\",\"$comment\":\"part of the pattern is based on `bom.serialNumber`'s pattern\"},\"bomLinkElementType\":{\"title\":\"BOM-Link Element\",\"description\":\"Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/\",\"type\":\"string\",\"format\":\"iri-reference\",\"pattern\":\"^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$\",\"$comment\":\"part of the pattern is based on `bom.serialNumber`'s pattern\"},\"bomLink\":{\"title\":\"BOM-Link\",\"anyOf\":[{\"title\":\"BOM-Link Document\",\"$ref\":\"#/definitions/bomLinkDocumentType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"metadata\":{\"type\":\"object\",\"title\":\"BOM Metadata\",\"additionalProperties\":false,\"properties\":{\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Timestamp\",\"description\":\"The date and time (timestamp) when the BOM was created.\"},\"lifecycles\":{\"type\":\"array\",\"title\":\"Lifecycles\",\"description\":\"Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.\",\"items\":{\"type\":\"object\",\"title\":\"Lifecycle\",\"description\":\"The product lifecycle(s) that this BOM represents.\",\"oneOf\":[{\"title\":\"Pre-Defined Phase\",\"required\":[\"phase\"],\"additionalProperties\":false,\"properties\":{\"phase\":{\"type\":\"string\",\"title\":\"Phase\",\"description\":\"A pre-defined phase in the product lifecycle.\",\"enum\":[\"design\",\"pre-build\",\"build\",\"post-build\",\"operations\",\"discovery\",\"decommission\"],\"meta:enum\":{\"design\":\"BOM produced early in the development lifecycle containing an inventory of components and services that are proposed or planned to be used. The inventory may need to be procured, retrieved, or resourced prior to use.\",\"pre-build\":\"BOM consisting of information obtained prior to a build process and may contain source files and development artifacts and manifests. The inventory may need to be resolved and retrieved prior to use.\",\"build\":\"BOM consisting of information obtained during a build process where component inventory is available for use. The precise versions of resolved components are usually available at this time as well as the provenance of where the components were retrieved from.\",\"post-build\":\"BOM consisting of information obtained after a build process has completed and the resulting components(s) are available for further analysis. Built components may exist as the result of a CI/CD process, may have been installed or deployed to a system or device, and may need to be retrieved or extracted from the system or device.\",\"operations\":\"BOM produced that represents inventory that is running and operational. This may include staging or production environments and will generally encompass multiple SBOMs describing the applications and operating system, along with HBOMs describing the hardware that makes up the system. Operations Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations, and additional dependencies.\",\"discovery\":\"BOM consisting of information observed through network discovery providing point-in-time enumeration of embedded, on-premise, and cloud-native services such as server applications, connected devices, microservices, and serverless functions.\",\"decommission\":\"BOM containing inventory that will be, or has been retired from operations.\"}}}},{\"title\":\"Custom Phase\",\"required\":[\"name\"],\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of the lifecycle phase\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"The description of the lifecycle phase\"}}}]}},\"tools\":{\"title\":\"Tools\",\"description\":\"The tool(s) used in the creation, enrichment, and validation of the BOM.\",\"oneOf\":[{\"type\":\"object\",\"title\":\"Tools\",\"description\":\"The tool(s) used in the creation, enrichment, and validation of the BOM.\",\"additionalProperties\":false,\"properties\":{\"components\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/component\"},\"uniqueItems\":true,\"title\":\"Components\",\"description\":\"A list of software and hardware components used as tools.\"},\"services\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/service\"},\"uniqueItems\":true,\"title\":\"Services\",\"description\":\"A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services.\"}}},{\"type\":\"array\",\"title\":\"Tools (legacy)\",\"description\":\"[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM.\",\"items\":{\"$ref\":\"#/definitions/tool\"}}]},\"manufacturer\":{\"title\":\"BOM Manufacturer\",\"description\":\"The organization that created the BOM.\\nManufacturer is common in BOMs created through automated processes. BOMs created through manual means may have `@.authors` instead.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"authors\":{\"type\":\"array\",\"title\":\"BOM Authors\",\"description\":\"The person(s) who created the BOM.\\nAuthors are common in BOMs created through manual processes. BOMs created through automated means may have `@.manufacturer` instead.\",\"items\":{\"$ref\":\"#/definitions/organizationalContact\"}},\"component\":{\"title\":\"Component\",\"description\":\"The component that the BOM describes.\",\"$ref\":\"#/definitions/component\"},\"manufacture\":{\"deprecated\":true,\"title\":\"Component Manufacture (legacy)\",\"description\":\"[Deprecated] This will be removed in a future version. Use the `@.component.manufacturer` instead.\\nThe organization that manufactured the component that the BOM describes.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"supplier\":{\"title\":\"Supplier\",\"description\":\" The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"licenses\":{\"title\":\"BOM License(s)\",\"description\":\"The license information for the BOM document.\\nThis may be different from the license(s) of the component(s) that the BOM describes.\",\"$ref\":\"#/definitions/licenseChoice\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"tool\":{\"type\":\"object\",\"title\":\"Tool\",\"description\":\"[Deprecated] This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used\",\"additionalProperties\":false,\"properties\":{\"vendor\":{\"type\":\"string\",\"title\":\"Tool Vendor\",\"description\":\"The name of the vendor who created the tool\"},\"name\":{\"type\":\"string\",\"title\":\"Tool Name\",\"description\":\"The name of the tool\"},\"version\":{\"$ref\":\"#/definitions/version\",\"title\":\"Tool Version\",\"description\":\"The version of the tool\"},\"hashes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/hash\"},\"title\":\"Hashes\",\"description\":\"The hashes of the tool (if applicable).\"},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"}}},\"organizationalEntity\":{\"type\":\"object\",\"title\":\"Organizational Entity\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"name\":{\"type\":\"string\",\"title\":\"Organization Name\",\"description\":\"The name of the organization\",\"examples\":[\"Example Inc.\"]},\"address\":{\"$ref\":\"#/definitions/postalAddress\",\"title\":\"Organization Address\",\"description\":\"The physical address (location) of the organization\"},\"url\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"iri-reference\"},\"title\":\"Organization URL(s)\",\"description\":\"The URL of the organization. Multiple URLs are allowed.\",\"examples\":[\"https://example.com\"]},\"contact\":{\"type\":\"array\",\"title\":\"Organizational Contact\",\"description\":\"A contact at the organization. Multiple contacts are allowed.\",\"items\":{\"$ref\":\"#/definitions/organizationalContact\"}}}},\"organizationalContact\":{\"type\":\"object\",\"title\":\"Organizational Contact\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of a contact\",\"examples\":[\"Contact name\"]},\"email\":{\"type\":\"string\",\"format\":\"idn-email\",\"title\":\"Email Address\",\"description\":\"The email address of the contact.\",\"examples\":[\"[email protected]\"]},\"phone\":{\"type\":\"string\",\"title\":\"Phone\",\"description\":\"The phone number of the contact.\",\"examples\":[\"800-555-1212\"]}}},\"component\":{\"type\":\"object\",\"title\":\"Component\",\"required\":[\"type\",\"name\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"application\",\"framework\",\"library\",\"container\",\"platform\",\"operating-system\",\"device\",\"device-driver\",\"firmware\",\"file\",\"machine-learning-model\",\"data\",\"cryptographic-asset\"],\"meta:enum\":{\"application\":\"A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.\",\"framework\":\"A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.\",\"library\":\"A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing)) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended.\",\"container\":\"A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization).\",\"platform\":\"A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms.\",\"operating-system\":\"A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system).\",\"device\":\"A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).\",\"device-driver\":\"A special type of software that operates or controls a particular type of device. Refer to [https://en.wikipedia.org/wiki/Device_driver](https://en.wikipedia.org/wiki/Device_driver).\",\"firmware\":\"A special type of software that provides low-level control over a device's hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware).\",\"file\":\"A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.\",\"machine-learning-model\":\"A model based on training data that can make predictions or decisions without being explicitly programmed to do so.\",\"data\":\"A collection of discrete values that convey information.\",\"cryptographic-asset\":\"A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets.\"},\"title\":\"Component Type\",\"description\":\"Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.\",\"examples\":[\"library\"]},\"mime-type\":{\"type\":\"string\",\"title\":\"Mime-Type\",\"description\":\"The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented, such as an image, font, or executable. Some library or framework components may also have an associated mime-type.\",\"examples\":[\"image/jpeg\"],\"pattern\":\"^[-+a-z0-9.]+/[-+a-z0-9.]+$\"},\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"supplier\":{\"title\":\"Component Supplier\",\"description\":\" The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"manufacturer\":{\"title\":\"Component Manufacturer\",\"description\":\"The organization that created the component.\\nManufacturer is common in components created through automated processes. Components created through manual means may have `@.authors` instead.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"authors\":{\"type\":\"array\",\"title\":\"Component Authors\",\"description\":\"The person(s) who created the component.\\nAuthors are common in components created through manual processes. Components created through automated means may have `@.manufacturer` instead.\",\"items\":{\"$ref\":\"#/definitions/organizationalContact\"}},\"author\":{\"deprecated\":true,\"type\":\"string\",\"title\":\"Component Author (legacy)\",\"description\":\"[Deprecated] This will be removed in a future version. Use `@.authors` or `@.manufacturer` instead.\\nThe person(s) or organization(s) that authored the component\",\"examples\":[\"Acme Inc\"]},\"publisher\":{\"type\":\"string\",\"title\":\"Component Publisher\",\"description\":\"The person(s) or organization(s) that published the component\",\"examples\":[\"Acme Inc\"]},\"group\":{\"type\":\"string\",\"title\":\"Component Group\",\"description\":\"The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.\",\"examples\":[\"com.acme\"]},\"name\":{\"type\":\"string\",\"title\":\"Component Name\",\"description\":\"The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery\",\"examples\":[\"tomcat-catalina\"]},\"version\":{\"$ref\":\"#/definitions/version\",\"title\":\"Component Version\",\"description\":\"The component version. The version should ideally comply with semantic versioning but is not enforced.\"},\"description\":{\"type\":\"string\",\"title\":\"Component Description\",\"description\":\"Specifies a description for the component\"},\"scope\":{\"type\":\"string\",\"enum\":[\"required\",\"optional\",\"excluded\"],\"meta:enum\":{\"required\":\"The component is required for runtime\",\"optional\":\"The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'.\",\"excluded\":\"Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime.\"},\"title\":\"Component Scope\",\"description\":\"Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.\",\"default\":\"required\"},\"hashes\":{\"type\":\"array\",\"title\":\"Component Hashes\",\"description\":\"The hashes of the component.\",\"items\":{\"$ref\":\"#/definitions/hash\"}},\"licenses\":{\"$ref\":\"#/definitions/licenseChoice\",\"title\":\"Component License(s)\"},\"copyright\":{\"type\":\"string\",\"title\":\"Component Copyright\",\"description\":\"A copyright notice informing users of the underlying claims to copyright ownership in a published work.\",\"examples\":[\"Acme Inc\"]},\"cpe\":{\"type\":\"string\",\"title\":\"Common Platform Enumeration (CPE)\",\"description\":\"Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.\",\"examples\":[\"cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*\"]},\"purl\":{\"type\":\"string\",\"title\":\"Package URL (purl)\",\"description\":\"Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.\",\"examples\":[\"pkg:maven/com.acme/[email protected]?packaging=jar\"]},\"omniborId\":{\"type\":\"array\",\"title\":\"OmniBOR Artifact Identifier (gitoid)\",\"description\":\"Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: [https://www.iana.org/assignments/uri-schemes/prov/gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.\",\"items\":{\"type\":\"string\"},\"examples\":[\"gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3\",\"gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08\"]},\"swhid\":{\"type\":\"array\",\"title\":\"Software Heritage Identifier\",\"description\":\"Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html](https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.\",\"items\":{\"type\":\"string\"},\"examples\":[\"swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2\"]},\"swid\":{\"$ref\":\"#/definitions/swid\",\"title\":\"SWID Tag\",\"description\":\"Asserts the identity of the component using [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.\"},\"modified\":{\"type\":\"boolean\",\"title\":\"Component Modified From Original\",\"description\":\"[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original.\"},\"pedigree\":{\"type\":\"object\",\"title\":\"Component Pedigree\",\"description\":\"Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.\",\"additionalProperties\":false,\"properties\":{\"ancestors\":{\"type\":\"array\",\"title\":\"Ancestors\",\"description\":\"Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.\",\"items\":{\"$ref\":\"#/definitions/component\"}},\"descendants\":{\"type\":\"array\",\"title\":\"Descendants\",\"description\":\"Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.\",\"items\":{\"$ref\":\"#/definitions/component\"}},\"variants\":{\"type\":\"array\",\"title\":\"Variants\",\"description\":\"Variants describe relations where the relationship between the components is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.\",\"items\":{\"$ref\":\"#/definitions/component\"}},\"commits\":{\"type\":\"array\",\"title\":\"Commits\",\"description\":\"A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.\",\"items\":{\"$ref\":\"#/definitions/commit\"}},\"patches\":{\"type\":\"array\",\"title\":\"Patches\",\"description\":\">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits.\",\"items\":{\"$ref\":\"#/definitions/patch\"}},\"notes\":{\"type\":\"string\",\"title\":\"Notes\",\"description\":\"Notes, observations, and other non-structured commentary describing the components pedigree.\"}}},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"},\"components\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/component\"},\"uniqueItems\":true,\"title\":\"Components\",\"description\":\"A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains.\"},\"evidence\":{\"$ref\":\"#/definitions/componentEvidence\",\"title\":\"Evidence\",\"description\":\"Provides the ability to document evidence collected through various forms of extraction or analysis.\"},\"releaseNotes\":{\"$ref\":\"#/definitions/releaseNotes\",\"title\":\"Release notes\",\"description\":\"Specifies optional release notes.\"},\"modelCard\":{\"$ref\":\"#/definitions/modelCard\",\"title\":\"AI/ML Model Card\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/componentData\"},\"title\":\"Data\",\"description\":\"This object SHOULD be specified for any component of type `data` and must not be specified for other component types.\"},\"cryptoProperties\":{\"$ref\":\"#/definitions/cryptoProperties\",\"title\":\"Cryptographic Properties\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}},\"tags\":{\"$ref\":\"#/definitions/tags\",\"title\":\"Tags\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"swid\":{\"type\":\"object\",\"title\":\"SWID Tag\",\"description\":\"Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.\",\"required\":[\"tagId\",\"name\"],\"additionalProperties\":false,\"properties\":{\"tagId\":{\"type\":\"string\",\"title\":\"Tag ID\",\"description\":\"Maps to the tagId of a SoftwareIdentity.\"},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"Maps to the name of a SoftwareIdentity.\"},\"version\":{\"type\":\"string\",\"title\":\"Version\",\"default\":\"0.0\",\"description\":\"Maps to the version of a SoftwareIdentity.\"},\"tagVersion\":{\"type\":\"integer\",\"title\":\"Tag Version\",\"default\":0,\"description\":\"Maps to the tagVersion of a SoftwareIdentity.\"},\"patch\":{\"type\":\"boolean\",\"title\":\"Patch\",\"default\":false,\"description\":\"Maps to the patch of a SoftwareIdentity.\"},\"text\":{\"title\":\"Attachment text\",\"description\":\"Specifies the metadata and content of the SWID tag.\",\"$ref\":\"#/definitions/attachment\"},\"url\":{\"type\":\"string\",\"title\":\"URL\",\"description\":\"The URL to the SWID file.\",\"format\":\"iri-reference\"}}},\"attachment\":{\"type\":\"object\",\"title\":\"Attachment\",\"description\":\"Specifies the metadata and content for an attachment.\",\"required\":[\"content\"],\"additionalProperties\":false,\"properties\":{\"contentType\":{\"type\":\"string\",\"title\":\"Content-Type\",\"description\":\"Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plan text documents.\\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).\",\"default\":\"text/plain\",\"examples\":[\"text/plain\",\"application/json\",\"image/png\"]},\"encoding\":{\"type\":\"string\",\"title\":\"Encoding\",\"description\":\"Specifies the optional encoding the text is represented in.\",\"enum\":[\"base64\"],\"meta:enum\":{\"base64\":\"Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string.\"}},\"content\":{\"type\":\"string\",\"title\":\"Attachment Text\",\"description\":\"The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text.\"}}},\"hash\":{\"type\":\"object\",\"title\":\"Hash\",\"required\":[\"alg\",\"content\"],\"additionalProperties\":false,\"properties\":{\"alg\":{\"$ref\":\"#/definitions/hash-alg\"},\"content\":{\"$ref\":\"#/definitions/hash-content\"}}},\"hash-alg\":{\"type\":\"string\",\"title\":\"Hash Algorithm\",\"description\":\"The algorithm that generated the hash value.\",\"enum\":[\"MD5\",\"SHA-1\",\"SHA-256\",\"SHA-384\",\"SHA-512\",\"SHA3-256\",\"SHA3-384\",\"SHA3-512\",\"BLAKE2b-256\",\"BLAKE2b-384\",\"BLAKE2b-512\",\"BLAKE3\"]},\"hash-content\":{\"type\":\"string\",\"title\":\"Hash Value\",\"description\":\"The value of the hash.\",\"examples\":[\"3942447fac867ae5cdb3229b658f4d48\"],\"pattern\":\"^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$\"},\"license\":{\"type\":\"object\",\"title\":\"License\",\"description\":\"Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.\",\"oneOf\":[{\"required\":[\"id\"]},{\"required\":[\"name\"]}],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"id\":{\"$ref\":\"spdx.schema.json\",\"title\":\"License ID (SPDX)\",\"description\":\"A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.\",\"examples\":[\"Apache-2.0\"]},\"name\":{\"type\":\"string\",\"title\":\"License Name\",\"description\":\"The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.\",\"examples\":[\"Acme Software License\"]},\"acknowledgement\":{\"$ref\":\"#/definitions/licenseAcknowledgementEnumeration\"},\"text\":{\"title\":\"License text\",\"description\":\"An optional way to include the textual content of a license.\",\"$ref\":\"#/definitions/attachment\"},\"url\":{\"type\":\"string\",\"title\":\"License URL\",\"description\":\"The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness\",\"examples\":[\"https://www.apache.org/licenses/LICENSE-2.0.txt\"],\"format\":\"iri-reference\"},\"licensing\":{\"type\":\"object\",\"title\":\"Licensing information\",\"description\":\"Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata\",\"additionalProperties\":false,\"properties\":{\"altIds\":{\"type\":\"array\",\"title\":\"Alternate License Identifiers\",\"description\":\"License identifiers that may be used to manage licenses and their lifecycle\",\"items\":{\"type\":\"string\"}},\"licensor\":{\"title\":\"Licensor\",\"description\":\"The individual or organization that grants a license to another individual or organization\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"organization\":{\"title\":\"Licensor (Organization)\",\"description\":\"The organization that granted the license\",\"$ref\":\"#/definitions/organizationalEntity\"},\"individual\":{\"title\":\"Licensor (Individual)\",\"description\":\"The individual, not associated with an organization, that granted the license\",\"$ref\":\"#/definitions/organizationalContact\"}},\"oneOf\":[{\"required\":[\"organization\"]},{\"required\":[\"individual\"]}]},\"licensee\":{\"title\":\"Licensee\",\"description\":\"The individual or organization for which a license was granted to\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"organization\":{\"title\":\"Licensee (Organization)\",\"description\":\"The organization that was granted the license\",\"$ref\":\"#/definitions/organizationalEntity\"},\"individual\":{\"title\":\"Licensee (Individual)\",\"description\":\"The individual, not associated with an organization, that was granted the license\",\"$ref\":\"#/definitions/organizationalContact\"}},\"oneOf\":[{\"required\":[\"organization\"]},{\"required\":[\"individual\"]}]},\"purchaser\":{\"title\":\"Purchaser\",\"description\":\"The individual or organization that purchased the license\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"organization\":{\"title\":\"Purchaser (Organization)\",\"description\":\"The organization that purchased the license\",\"$ref\":\"#/definitions/organizationalEntity\"},\"individual\":{\"title\":\"Purchaser (Individual)\",\"description\":\"The individual, not associated with an organization, that purchased the license\",\"$ref\":\"#/definitions/organizationalContact\"}},\"oneOf\":[{\"required\":[\"organization\"]},{\"required\":[\"individual\"]}]},\"purchaseOrder\":{\"type\":\"string\",\"title\":\"Purchase Order\",\"description\":\"The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase\"},\"licenseTypes\":{\"type\":\"array\",\"title\":\"License Type\",\"description\":\"The type of license(s) that was granted to the licensee.\",\"items\":{\"type\":\"string\",\"enum\":[\"academic\",\"appliance\",\"client-access\",\"concurrent-user\",\"core-points\",\"custom-metric\",\"device\",\"evaluation\",\"named-user\",\"node-locked\",\"oem\",\"perpetual\",\"processor-points\",\"subscription\",\"user\",\"other\"],\"meta:enum\":{\"academic\":\"A license that grants use of software solely for the purpose of education or research.\",\"appliance\":\"A license covering use of software embedded in a specific piece of hardware.\",\"client-access\":\"A Client Access License (CAL) allows client computers to access services provided by server software.\",\"concurrent-user\":\"A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users.\",\"core-points\":\"A license where the core of a computer's processor is assigned a specific number of points.\",\"custom-metric\":\"A license for which consumption is measured by non-standard metrics.\",\"device\":\"A license that covers a defined number of installations on computers and other types of devices.\",\"evaluation\":\"A license that grants permission to install and use software for trial purposes.\",\"named-user\":\"A license that grants access to the software to one or more pre-defined users.\",\"node-locked\":\"A license that grants access to the software on one or more pre-defined computers or devices.\",\"oem\":\"An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware.\",\"perpetual\":\"A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely.\",\"processor-points\":\"A license where each installation consumes points per processor.\",\"subscription\":\"A license where the licensee pays a fee to use the software or service.\",\"user\":\"A license that grants access to the software or service by a specified number of users.\",\"other\":\"Another license type.\"}}},\"lastRenewal\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Last Renewal\",\"description\":\"The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed.\"},\"expiration\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Expiration\",\"description\":\"The timestamp indicating when the current license expires (if applicable).\"}}},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"licenseAcknowledgementEnumeration\":{\"title\":\"License Acknowledgement\",\"description\":\"Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in `@.evidence.licenses`. Observed licenses form the evidence necessary to substantiate a concluded license.\",\"type\":\"string\",\"enum\":[\"declared\",\"concluded\"],\"meta:enum\":{\"declared\":\"Declared licenses represent the initial intentions of authors regarding the licensing terms of their code.\",\"concluded\":\"Concluded licenses are verified and confirmed.\"}},\"licenseChoice\":{\"title\":\"License Choice\",\"description\":\"EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)\",\"type\":\"array\",\"oneOf\":[{\"title\":\"Multiple licenses\",\"description\":\"A list of SPDX licenses and/or named licenses.\",\"type\":\"array\",\"items\":{\"type\":\"object\",\"title\":\"License\",\"required\":[\"license\"],\"additionalProperties\":false,\"properties\":{\"license\":{\"$ref\":\"#/definitions/license\"}}}},{\"title\":\"SPDX License Expression\",\"description\":\"A tuple of exactly one SPDX License Expression.\",\"type\":\"array\",\"additionalItems\":false,\"minItems\":1,\"maxItems\":1,\"items\":[{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"expression\"],\"properties\":{\"expression\":{\"type\":\"string\",\"title\":\"SPDX License Expression\",\"description\":\"A valid SPDX license expression.\\nRefer to https://spdx.org/specifications for syntax requirements\",\"examples\":[\"Apache-2.0 AND (MIT OR GPL-2.0-only)\",\"GPL-3.0-only WITH Classpath-exception-2.0\"]},\"acknowledgement\":{\"$ref\":\"#/definitions/licenseAcknowledgementEnumeration\"},\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"}}}]}]},\"commit\":{\"type\":\"object\",\"title\":\"Commit\",\"description\":\"Specifies an individual commit\",\"additionalProperties\":false,\"properties\":{\"uid\":{\"type\":\"string\",\"title\":\"UID\",\"description\":\"A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes.\"},\"url\":{\"type\":\"string\",\"title\":\"URL\",\"description\":\"The URL to the commit. This URL will typically point to a commit in a version control system.\",\"format\":\"iri-reference\"},\"author\":{\"title\":\"Author\",\"description\":\"The author who created the changes in the commit\",\"$ref\":\"#/definitions/identifiableAction\"},\"committer\":{\"title\":\"Committer\",\"description\":\"The person who committed or pushed the commit\",\"$ref\":\"#/definitions/identifiableAction\"},\"message\":{\"type\":\"string\",\"title\":\"Message\",\"description\":\"The text description of the contents of the commit\"}}},\"patch\":{\"type\":\"object\",\"title\":\"Patch\",\"description\":\"Specifies an individual patch\",\"required\":[\"type\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"unofficial\",\"monkey\",\"backport\",\"cherry-pick\"],\"meta:enum\":{\"unofficial\":\"A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch).\",\"monkey\":\"A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch).\",\"backport\":\"A patch which takes code from a newer version of the software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting).\",\"cherry-pick\":\"A patch created by selectively applying commits from other versions or branches of the same software.\"},\"title\":\"Patch Type\",\"description\":\"Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality.\"},\"diff\":{\"title\":\"Diff\",\"description\":\"The patch file (or diff) that shows changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)\",\"$ref\":\"#/definitions/diff\"},\"resolves\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/issue\"},\"title\":\"Resolves\",\"description\":\"A collection of issues the patch resolves\"}}},\"diff\":{\"type\":\"object\",\"title\":\"Diff\",\"description\":\"The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff\",\"additionalProperties\":false,\"properties\":{\"text\":{\"title\":\"Diff text\",\"description\":\"Specifies the optional text of the diff\",\"$ref\":\"#/definitions/attachment\"},\"url\":{\"type\":\"string\",\"title\":\"URL\",\"description\":\"Specifies the URL to the diff\",\"format\":\"iri-reference\"}}},\"issue\":{\"type\":\"object\",\"title\":\"Issue\",\"description\":\"An individual issue that has been resolved.\",\"required\":[\"type\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"defect\",\"enhancement\",\"security\"],\"meta:enum\":{\"defect\":\"A fault, flaw, or bug in software.\",\"enhancement\":\"A new feature or behavior in software.\",\"security\":\"A special type of defect which impacts security.\"},\"title\":\"Issue Type\",\"description\":\"Specifies the type of issue\"},\"id\":{\"type\":\"string\",\"title\":\"Issue ID\",\"description\":\"The identifier of the issue assigned by the source of the issue\"},\"name\":{\"type\":\"string\",\"title\":\"Issue Name\",\"description\":\"The name of the issue\"},\"description\":{\"type\":\"string\",\"title\":\"Issue Description\",\"description\":\"A description of the issue\"},\"source\":{\"type\":\"object\",\"title\":\"Source\",\"description\":\"The source of the issue where it is documented\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of the source.\",\"examples\":[\"National Vulnerability Database\",\"NVD\",\"Apache\"]},\"url\":{\"type\":\"string\",\"title\":\"URL\",\"description\":\"The url of the issue documentation as provided by the source\",\"format\":\"iri-reference\"}}},\"references\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"iri-reference\"},\"title\":\"References\",\"description\":\"A collection of URL's for reference. Multiple URLs are allowed.\",\"examples\":[\"https://example.com\"]}}},\"identifiableAction\":{\"type\":\"object\",\"title\":\"Identifiable Action\",\"description\":\"Specifies an individual commit\",\"additionalProperties\":false,\"properties\":{\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Timestamp\",\"description\":\"The timestamp in which the action occurred\"},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of the individual who performed the action\"},\"email\":{\"type\":\"string\",\"format\":\"idn-email\",\"title\":\"E-mail\",\"description\":\"The email address of the individual who performed the action\"}}},\"externalReference\":{\"type\":\"object\",\"title\":\"External Reference\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\",\"required\":[\"url\",\"type\"],\"additionalProperties\":false,\"properties\":{\"url\":{\"anyOf\":[{\"title\":\"URL\",\"type\":\"string\",\"format\":\"iri-reference\"},{\"title\":\"BOM-Link\",\"$ref\":\"#/definitions/bomLink\"}],\"title\":\"URL\",\"description\":\"The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https ([RFC-7230](https://www.ietf.org/rfc/rfc7230.txt)), mailto ([RFC-2368](https://www.ietf.org/rfc/rfc2368.txt)), tel ([RFC-3966](https://www.ietf.org/rfc/rfc3966.txt)), and dns ([RFC-4501](https://www.ietf.org/rfc/rfc4501.txt)). External references may also include formally registered URNs such as [CycloneDX BOM-Link](https://cyclonedx.org/capabilities/bomlink/) to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs.\"},\"comment\":{\"type\":\"string\",\"title\":\"Comment\",\"description\":\"An optional comment describing the external reference\"},\"type\":{\"type\":\"string\",\"title\":\"Type\",\"description\":\"Specifies the type of external reference.\",\"enum\":[\"vcs\",\"issue-tracker\",\"website\",\"advisories\",\"bom\",\"mailing-list\",\"social\",\"chat\",\"documentation\",\"support\",\"source-distribution\",\"distribution\",\"distribution-intake\",\"license\",\"build-meta\",\"build-system\",\"release-notes\",\"security-contact\",\"model-card\",\"log\",\"configuration\",\"evidence\",\"formulation\",\"attestation\",\"threat-model\",\"adversary-model\",\"risk-assessment\",\"vulnerability-assertion\",\"exploitability-statement\",\"pentest-report\",\"static-analysis-report\",\"dynamic-analysis-report\",\"runtime-analysis-report\",\"component-analysis-report\",\"maturity-report\",\"certification-report\",\"codified-infrastructure\",\"quality-metrics\",\"poam\",\"electronic-signature\",\"digital-signature\",\"rfc-9116\",\"other\"],\"meta:enum\":{\"vcs\":\"Version Control System\",\"issue-tracker\":\"Issue or defect tracking system, or an Application Lifecycle Management (ALM) system\",\"website\":\"Website\",\"advisories\":\"Security advisories\",\"bom\":\"Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc)\",\"mailing-list\":\"Mailing list or discussion group\",\"social\":\"Social media account\",\"chat\":\"Real-time chat platform\",\"documentation\":\"Documentation, guides, or how-to instructions\",\"support\":\"Community or commercial support\",\"source-distribution\":\"The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type.\",\"distribution\":\"Direct or repository download location\",\"distribution-intake\":\"The location where a component was published to. This is often the same as \\\"distribution\\\" but may also include specialized publishing processes that act as an intermediary.\",\"license\":\"The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness.\",\"build-meta\":\"Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)\",\"build-system\":\"Reference to an automated build system\",\"release-notes\":\"Reference to release notes\",\"security-contact\":\"Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT.\",\"model-card\":\"A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency.\",\"log\":\"A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.\",\"configuration\":\"Parameters or settings that may be used by other components or services.\",\"evidence\":\"Information used to substantiate a claim.\",\"formulation\":\"Describes how a component or service was manufactured or deployed.\",\"attestation\":\"Human or machine-readable statements containing facts, evidence, or testimony.\",\"threat-model\":\"An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format.\",\"adversary-model\":\"The defined assumptions, goals, and capabilities of an adversary.\",\"risk-assessment\":\"Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.\",\"vulnerability-assertion\":\"A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.\",\"exploitability-statement\":\"A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.\",\"pentest-report\":\"Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test.\",\"static-analysis-report\":\"SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code.\",\"dynamic-analysis-report\":\"Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations.\",\"runtime-analysis-report\":\"Report generated by analyzing the call stack of a running application.\",\"component-analysis-report\":\"Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis.\",\"maturity-report\":\"Report containing a formal assessment of an organization, business unit, or team against a maturity model.\",\"certification-report\":\"Industry, regulatory, or other certification from an accredited (if applicable) certification body.\",\"codified-infrastructure\":\"Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC).\",\"quality-metrics\":\"Report or system in which quality metrics can be obtained.\",\"poam\":\"Plans of Action and Milestones (POA&M) complement an \\\"attestation\\\" external reference. POA&M is defined by NIST as a \\\"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\\\".\",\"electronic-signature\":\"An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.\",\"digital-signature\":\"A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.\",\"rfc-9116\":\"Document that complies with [RFC 9116](https://www.ietf.org/rfc/rfc9116.html) (A File Format to Aid in Security Vulnerability Disclosure)\",\"other\":\"Use this if no other types accurately describe the purpose of the external reference.\"}},\"hashes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/hash\"},\"title\":\"Hashes\",\"description\":\"The hashes of the external reference (if applicable).\"}}},\"dependency\":{\"type\":\"object\",\"title\":\"Dependency\",\"description\":\"Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies must be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.\",\"required\":[\"ref\"],\"additionalProperties\":false,\"properties\":{\"ref\":{\"$ref\":\"#/definitions/refLinkType\",\"title\":\"Reference\",\"description\":\"References a component or service by its bom-ref attribute\"},\"dependsOn\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/refLinkType\"},\"title\":\"Depends On\",\"description\":\"The bom-ref identifiers of the components or services that are dependencies of this dependency object.\"},\"provides\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/refLinkType\"},\"title\":\"Provides\",\"description\":\"The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object.\\nFor example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use.\"}}},\"service\":{\"type\":\"object\",\"title\":\"Service\",\"required\":[\"name\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"provider\":{\"title\":\"Provider\",\"description\":\"The organization that provides the service.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"group\":{\"type\":\"string\",\"title\":\"Service Group\",\"description\":\"The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.\",\"examples\":[\"com.acme\"]},\"name\":{\"type\":\"string\",\"title\":\"Service Name\",\"description\":\"The name of the service. This will often be a shortened, single name of the service.\",\"examples\":[\"ticker-service\"]},\"version\":{\"$ref\":\"#/definitions/version\",\"title\":\"Service Version\",\"description\":\"The service version.\"},\"description\":{\"type\":\"string\",\"title\":\"Service Description\",\"description\":\"Specifies a description for the service\"},\"endpoints\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"iri-reference\"},\"title\":\"Endpoints\",\"description\":\"The endpoint URIs of the service. Multiple endpoints are allowed.\",\"examples\":[\"https://example.com/api/v1/ticker\"]},\"authenticated\":{\"type\":\"boolean\",\"title\":\"Authentication Required\",\"description\":\"A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.\"},\"x-trust-boundary\":{\"type\":\"boolean\",\"title\":\"Crosses Trust Boundary\",\"description\":\"A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.\"},\"trustZone\":{\"type\":\"string\",\"title\":\"Trust Zone\",\"description\":\"The name of the trust zone the service resides in.\"},\"data\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/serviceData\"},\"title\":\"Data\",\"description\":\"Specifies information about the data including the directional flow of data and the data classification.\"},\"licenses\":{\"$ref\":\"#/definitions/licenseChoice\",\"title\":\"Service License(s)\"},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"},\"services\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/service\"},\"uniqueItems\":true,\"title\":\"Services\",\"description\":\"A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies.\"},\"releaseNotes\":{\"$ref\":\"#/definitions/releaseNotes\",\"title\":\"Release notes\",\"description\":\"Specifies optional release notes.\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}},\"tags\":{\"$ref\":\"#/definitions/tags\",\"title\":\"Tags\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"serviceData\":{\"type\":\"object\",\"title\":\"Hash Objects\",\"required\":[\"flow\",\"classification\"],\"additionalProperties\":false,\"properties\":{\"flow\":{\"$ref\":\"#/definitions/dataFlowDirection\",\"title\":\"Directional Flow\",\"description\":\"Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways and unknown states that the direction is not known.\"},\"classification\":{\"$ref\":\"#/definitions/dataClassification\"},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"Name for the defined data\",\"examples\":[\"Credit card reporting\"]},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"Short description of the data content and usage\",\"examples\":[\"Credit card information being exchanged in between the web app and the database\"]},\"governance\":{\"title\":\"Data Governance\",\"$ref\":\"#/definitions/dataGovernance\"},\"source\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"title\":\"URL\",\"type\":\"string\",\"format\":\"iri-reference\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"title\":\"Source\",\"description\":\"The URI, URL, or BOM-Link of the components or services the data came in from\"},\"destination\":{\"type\":\"array\",\"items\":{\"anyOf\":[{\"title\":\"URL\",\"type\":\"string\",\"format\":\"iri-reference\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"title\":\"Destination\",\"description\":\"The URI, URL, or BOM-Link of the components or services the data is sent to\"}}},\"dataFlowDirection\":{\"type\":\"string\",\"enum\":[\"inbound\",\"outbound\",\"bi-directional\",\"unknown\"],\"meta:enum\":{\"inbound\":\"Data that enters a service.\",\"outbound\":\"Data that exits a service.\",\"bi-directional\":\"Data flows in and out of the service.\",\"unknown\":\"The directional flow of data is not known.\"},\"title\":\"Data flow direction\",\"description\":\"Specifies the flow direction of the data. Direction is relative to the service.\"},\"copyright\":{\"type\":\"object\",\"title\":\"Copyright\",\"description\":\"A copyright notice informing users of the underlying claims to copyright ownership in a published work.\",\"required\":[\"text\"],\"additionalProperties\":false,\"properties\":{\"text\":{\"type\":\"string\",\"title\":\"Copyright Text\",\"description\":\"The textual content of the copyright.\"}}},\"componentEvidence\":{\"type\":\"object\",\"title\":\"Evidence\",\"description\":\"Provides the ability to document evidence collected through various forms of extraction or analysis.\",\"additionalProperties\":false,\"properties\":{\"identity\":{\"title\":\"Identity Evidence\",\"description\":\"Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.\",\"oneOf\":[{\"type\":\"array\",\"title\":\"Array of Identity Objects\",\"items\":{\"$ref\":\"#/definitions/componentIdentityEvidence\"}},{\"title\":\"A Single Identity Object\",\"description\":\"[Deprecated]\",\"$ref\":\"#/definitions/componentIdentityEvidence\",\"deprecated\":true}]},\"occurrences\":{\"type\":\"array\",\"title\":\"Occurrences\",\"description\":\"Evidence of individual instances of a component spread across multiple locations.\",\"items\":{\"type\":\"object\",\"required\":[\"location\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"location\":{\"type\":\"string\",\"title\":\"Location\",\"description\":\"The location or path to where the component was found.\"},\"line\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Line Number\",\"description\":\"The line number where the component was found.\"},\"offset\":{\"type\":\"integer\",\"minimum\":0,\"title\":\"Offset\",\"description\":\"The offset where the component was found.\"},\"symbol\":{\"type\":\"string\",\"title\":\"Symbol\",\"description\":\"The symbol name that was found associated with the component.\"},\"additionalContext\":{\"type\":\"string\",\"title\":\"Additional Context\",\"description\":\"Any additional context of the detected component (e.g. a code snippet).\"}}}},\"callstack\":{\"type\":\"object\",\"title\":\"Call Stack\",\"description\":\"Evidence of the components use through the callstack.\",\"additionalProperties\":false,\"properties\":{\"frames\":{\"type\":\"array\",\"title\":\"Frames\",\"description\":\"Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.\",\"items\":{\"type\":\"object\",\"required\":[\"module\"],\"additionalProperties\":false,\"properties\":{\"package\":{\"title\":\"Package\",\"description\":\"A package organizes modules into namespaces, providing a unique namespace for each type it contains.\",\"type\":\"string\"},\"module\":{\"title\":\"Module\",\"description\":\"A module or class that encloses functions/methods and other code.\",\"type\":\"string\"},\"function\":{\"title\":\"Function\",\"description\":\"A block of code designed to perform a particular task.\",\"type\":\"string\"},\"parameters\":{\"title\":\"Parameters\",\"description\":\"Optional arguments that are passed to the module or function.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"line\":{\"title\":\"Line\",\"description\":\"The line number the code that is called resides on.\",\"type\":\"integer\"},\"column\":{\"title\":\"Column\",\"description\":\"The column the code that is called resides.\",\"type\":\"integer\"},\"fullFilename\":{\"title\":\"Full Filename\",\"description\":\"The full path and filename of the module.\",\"type\":\"string\"}}}}}},\"licenses\":{\"$ref\":\"#/definitions/licenseChoice\",\"title\":\"License Evidence\"},\"copyright\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/copyright\"},\"title\":\"Copyright Evidence\",\"description\":\"Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection.\"}}},\"compositions\":{\"type\":\"object\",\"title\":\"Compositions\",\"required\":[\"aggregate\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"aggregate\":{\"$ref\":\"#/definitions/aggregateType\",\"title\":\"Aggregate\",\"description\":\"Specifies an aggregate type that describes how complete a relationship is.\"},\"assemblies\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"anyOf\":[{\"title\":\"Ref\",\"$ref\":\"#/definitions/refLinkType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"title\":\"BOM references\",\"description\":\"The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only.\"},\"dependencies\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"},\"title\":\"BOM references\",\"description\":\"The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only.\"},\"vulnerabilities\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"string\"},\"title\":\"BOM references\",\"description\":\"The bom-ref identifiers of the vulnerabilities being described.\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"aggregateType\":{\"type\":\"string\",\"default\":\"not_specified\",\"enum\":[\"complete\",\"incomplete\",\"incomplete_first_party_only\",\"incomplete_first_party_proprietary_only\",\"incomplete_first_party_opensource_only\",\"incomplete_third_party_only\",\"incomplete_third_party_proprietary_only\",\"incomplete_third_party_opensource_only\",\"unknown\",\"not_specified\"],\"meta:enum\":{\"complete\":\"The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.\",\"incomplete\":\"The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.\",\"incomplete_first_party_only\":\"The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.\",\"incomplete_first_party_proprietary_only\":\"The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.\",\"incomplete_first_party_opensource_only\":\"The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are opensource.\",\"incomplete_third_party_only\":\"The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.\",\"incomplete_third_party_proprietary_only\":\"The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.\",\"incomplete_third_party_opensource_only\":\"The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.\",\"unknown\":\"The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.\",\"not_specified\":\"The relationship completeness is not specified.\"}},\"property\":{\"type\":\"object\",\"title\":\"Lightweight name-value pair\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of the property. Duplicate names are allowed, each potentially having a different value.\"},\"value\":{\"type\":\"string\",\"title\":\"Value\",\"description\":\"The value of the property.\"}},\"additionalProperties\":false},\"localeType\":{\"type\":\"string\",\"pattern\":\"^([a-z]{2})(-[A-Z]{2})?$\",\"title\":\"Locale\",\"description\":\"Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code must be lower case. If the country code is specified, the country code must be upper case. The language code and country code must be separated by a minus sign. Examples: en, en-US, fr, fr-CA\"},\"releaseType\":{\"type\":\"string\",\"examples\":[\"major\",\"minor\",\"patch\",\"pre-release\",\"internal\"],\"description\":\"The software versioning type. It is recommended that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\\n\\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it.\"},\"note\":{\"type\":\"object\",\"title\":\"Note\",\"description\":\"A note containing the locale and content.\",\"required\":[\"text\"],\"additionalProperties\":false,\"properties\":{\"locale\":{\"$ref\":\"#/definitions/localeType\",\"title\":\"Locale\",\"description\":\"The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: \\\"en\\\", \\\"en-US\\\", \\\"fr\\\" and \\\"fr-CA\\\"\"},\"text\":{\"title\":\"Release note content\",\"description\":\"Specifies the full content of the release note.\",\"$ref\":\"#/definitions/attachment\"}}},\"releaseNotes\":{\"type\":\"object\",\"title\":\"Release notes\",\"required\":[\"type\"],\"additionalProperties\":false,\"properties\":{\"type\":{\"$ref\":\"#/definitions/releaseType\",\"title\":\"Type\",\"description\":\"The software versioning type the release note describes.\"},\"title\":{\"type\":\"string\",\"title\":\"Title\",\"description\":\"The title of the release.\"},\"featuredImage\":{\"type\":\"string\",\"format\":\"iri-reference\",\"title\":\"Featured image\",\"description\":\"The URL to an image that may be prominently displayed with the release note.\"},\"socialImage\":{\"type\":\"string\",\"format\":\"iri-reference\",\"title\":\"Social image\",\"description\":\"The URL to an image that may be used in messaging on social media platforms.\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"A short description of the release.\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Timestamp\",\"description\":\"The date and time (timestamp) when the release note was created.\"},\"aliases\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"title\":\"Aliases\",\"description\":\"One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).\"},\"tags\":{\"$ref\":\"#/definitions/tags\",\"title\":\"Tags\"},\"resolves\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/issue\"},\"title\":\"Resolves\",\"description\":\"A collection of issues that have been resolved.\"},\"notes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/note\"},\"title\":\"Notes\",\"description\":\"Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages.\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"advisory\":{\"type\":\"object\",\"title\":\"Advisory\",\"description\":\"Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.\",\"required\":[\"url\"],\"additionalProperties\":false,\"properties\":{\"title\":{\"type\":\"string\",\"title\":\"Title\",\"description\":\"An optional name of the advisory.\"},\"url\":{\"type\":\"string\",\"title\":\"URL\",\"format\":\"iri-reference\",\"description\":\"Location where the advisory can be obtained.\"}}},\"cwe\":{\"type\":\"integer\",\"minimum\":1,\"title\":\"CWE\",\"description\":\"Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html)\"},\"severity\":{\"type\":\"string\",\"title\":\"Severity\",\"description\":\"Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.\",\"enum\":[\"critical\",\"high\",\"medium\",\"low\",\"info\",\"none\",\"unknown\"],\"meta:enum\":{\"critical\":\"Critical severity\",\"high\":\"High severity\",\"medium\":\"Medium severity\",\"low\":\"Low severity\",\"info\":\"Informational warning.\",\"none\":\"None\",\"unknown\":\"The severity is not known\"}},\"scoreMethod\":{\"type\":\"string\",\"title\":\"Method\",\"description\":\"Specifies the severity or risk scoring methodology or standard used.\",\"enum\":[\"CVSSv2\",\"CVSSv3\",\"CVSSv31\",\"CVSSv4\",\"OWASP\",\"SSVC\",\"other\"],\"meta:enum\":{\"CVSSv2\":\"Common Vulnerability Scoring System v2.0\",\"CVSSv3\":\"Common Vulnerability Scoring System v3.0\",\"CVSSv31\":\"Common Vulnerability Scoring System v3.1\",\"CVSSv4\":\"Common Vulnerability Scoring System v4.0\",\"OWASP\":\"OWASP Risk Rating Methodology\",\"SSVC\":\"Stakeholder Specific Vulnerability Categorization\",\"other\":\"Another severity or risk scoring methodology\"}},\"impactAnalysisState\":{\"type\":\"string\",\"title\":\"Impact Analysis State\",\"description\":\"Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.\",\"enum\":[\"resolved\",\"resolved_with_pedigree\",\"exploitable\",\"in_triage\",\"false_positive\",\"not_affected\"],\"meta:enum\":{\"resolved\":\"The vulnerability has been remediated.\",\"resolved_with_pedigree\":\"The vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s).\",\"exploitable\":\"The vulnerability may be directly or indirectly exploitable.\",\"in_triage\":\"The vulnerability is being investigated.\",\"false_positive\":\"The vulnerability is not specific to the component or service and was falsely identified or associated.\",\"not_affected\":\"The component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases.\"}},\"impactAnalysisJustification\":{\"type\":\"string\",\"title\":\"Impact Analysis Justification\",\"description\":\"The rationale of why the impact analysis state was asserted.\",\"enum\":[\"code_not_present\",\"code_not_reachable\",\"requires_configuration\",\"requires_dependency\",\"requires_environment\",\"protected_by_compiler\",\"protected_at_runtime\",\"protected_at_perimeter\",\"protected_by_mitigating_control\"],\"meta:enum\":{\"code_not_present\":\"The code has been removed or tree-shaked.\",\"code_not_reachable\":\"The vulnerable code is not invoked at runtime.\",\"requires_configuration\":\"Exploitability requires a configurable option to be set/unset.\",\"requires_dependency\":\"Exploitability requires a dependency that is not present.\",\"requires_environment\":\"Exploitability requires a certain environment which is not present.\",\"protected_by_compiler\":\"Exploitability requires a compiler flag to be set/unset.\",\"protected_at_runtime\":\"Exploits are prevented at runtime.\",\"protected_at_perimeter\":\"Attacks are blocked at physical, logical, or network perimeter.\",\"protected_by_mitigating_control\":\"Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability.\"}},\"rating\":{\"type\":\"object\",\"title\":\"Rating\",\"description\":\"Defines the severity or risk ratings of a vulnerability.\",\"additionalProperties\":false,\"properties\":{\"source\":{\"$ref\":\"#/definitions/vulnerabilitySource\",\"description\":\"The source that calculated the severity or risk rating of the vulnerability.\"},\"score\":{\"type\":\"number\",\"title\":\"Score\",\"description\":\"The numerical score of the rating.\"},\"severity\":{\"$ref\":\"#/definitions/severity\",\"description\":\"Textual representation of the severity that corresponds to the numerical score of the rating.\"},\"method\":{\"$ref\":\"#/definitions/scoreMethod\"},\"vector\":{\"type\":\"string\",\"title\":\"Vector\",\"description\":\"Textual representation of the metric values used to score the vulnerability\"},\"justification\":{\"type\":\"string\",\"title\":\"Justification\",\"description\":\"An optional reason for rating the vulnerability as it was\"}}},\"vulnerabilitySource\":{\"type\":\"object\",\"title\":\"Source\",\"description\":\"The source of vulnerability information. This is often the organization that published the vulnerability.\",\"additionalProperties\":false,\"properties\":{\"url\":{\"type\":\"string\",\"title\":\"URL\",\"description\":\"The url of the vulnerability documentation as provided by the source.\",\"examples\":[\"https://nvd.nist.gov/vuln/detail/CVE-2021-39182\"]},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of the source.\",\"examples\":[\"NVD\",\"National Vulnerability Database\",\"OSS Index\",\"VulnDB\",\"GitHub Advisories\"]}}},\"vulnerability\":{\"type\":\"object\",\"title\":\"Vulnerability\",\"description\":\"Defines a weakness in a component or service that could be exploited or triggered by a threat source.\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"id\":{\"type\":\"string\",\"title\":\"ID\",\"description\":\"The identifier that uniquely identifies the vulnerability.\",\"examples\":[\"CVE-2021-39182\",\"GHSA-35m5-8cvj-8783\",\"SNYK-PYTHON-ENROCRYPT-1912876\"]},\"source\":{\"$ref\":\"#/definitions/vulnerabilitySource\",\"description\":\"The source that published the vulnerability.\"},\"references\":{\"type\":\"array\",\"title\":\"References\",\"description\":\"Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.\",\"items\":{\"type\":\"object\",\"required\":[\"id\",\"source\"],\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"title\":\"ID\",\"description\":\"An identifier that uniquely identifies the vulnerability.\",\"examples\":[\"CVE-2021-39182\",\"GHSA-35m5-8cvj-8783\",\"SNYK-PYTHON-ENROCRYPT-1912876\"]},\"source\":{\"$ref\":\"#/definitions/vulnerabilitySource\",\"description\":\"The source that published the vulnerability.\"}}}},\"ratings\":{\"type\":\"array\",\"title\":\"Ratings\",\"description\":\"List of vulnerability ratings\",\"items\":{\"$ref\":\"#/definitions/rating\"}},\"cwes\":{\"type\":\"array\",\"title\":\"CWEs\",\"description\":\"List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability.\",\"examples\":[399],\"items\":{\"$ref\":\"#/definitions/cwe\"}},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"A description of the vulnerability as provided by the source.\"},\"detail\":{\"type\":\"string\",\"title\":\"Details\",\"description\":\"If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause.\"},\"recommendation\":{\"type\":\"string\",\"title\":\"Recommendation\",\"description\":\"Recommendations of how the vulnerability can be remediated or mitigated.\"},\"workaround\":{\"type\":\"string\",\"title\":\"Workarounds\",\"description\":\"A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments.\"},\"proofOfConcept\":{\"type\":\"object\",\"title\":\"Proof of Concept\",\"description\":\"Evidence used to reproduce the vulnerability.\",\"properties\":{\"reproductionSteps\":{\"type\":\"string\",\"title\":\"Steps to Reproduce\",\"description\":\"Precise steps to reproduce the vulnerability.\"},\"environment\":{\"type\":\"string\",\"title\":\"Environment\",\"description\":\"A description of the environment in which reproduction was possible.\"},\"supportingMaterial\":{\"type\":\"array\",\"title\":\"Supporting Material\",\"description\":\"Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.\",\"items\":{\"$ref\":\"#/definitions/attachment\"}}}},\"advisories\":{\"type\":\"array\",\"title\":\"Advisories\",\"description\":\"Published advisories of the vulnerability if provided.\",\"items\":{\"$ref\":\"#/definitions/advisory\"}},\"created\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Created\",\"description\":\"The date and time (timestamp) when the vulnerability record was created in the vulnerability database.\"},\"published\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Published\",\"description\":\"The date and time (timestamp) when the vulnerability record was first published.\"},\"updated\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Updated\",\"description\":\"The date and time (timestamp) when the vulnerability record was last updated.\"},\"rejected\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Rejected\",\"description\":\"The date and time (timestamp) when the vulnerability record was rejected (if applicable).\"},\"credits\":{\"type\":\"object\",\"title\":\"Credits\",\"description\":\"Individuals or organizations credited with the discovery of the vulnerability.\",\"additionalProperties\":false,\"properties\":{\"organizations\":{\"type\":\"array\",\"title\":\"Organizations\",\"description\":\"The organizations credited with vulnerability discovery.\",\"items\":{\"$ref\":\"#/definitions/organizationalEntity\"}},\"individuals\":{\"type\":\"array\",\"title\":\"Individuals\",\"description\":\"The individuals, not associated with organizations, that are credited with vulnerability discovery.\",\"items\":{\"$ref\":\"#/definitions/organizationalContact\"}}}},\"tools\":{\"title\":\"Tools\",\"description\":\"The tool(s) used to identify, confirm, or score the vulnerability.\",\"oneOf\":[{\"type\":\"object\",\"title\":\"Tools\",\"description\":\"The tool(s) used to identify, confirm, or score the vulnerability.\",\"additionalProperties\":false,\"properties\":{\"components\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/component\"},\"uniqueItems\":true,\"title\":\"Components\",\"description\":\"A list of software and hardware components used as tools.\"},\"services\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/service\"},\"uniqueItems\":true,\"title\":\"Services\",\"description\":\"A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services.\"}}},{\"type\":\"array\",\"title\":\"Tools (legacy)\",\"description\":\"[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability.\",\"items\":{\"$ref\":\"#/definitions/tool\"}}]},\"analysis\":{\"type\":\"object\",\"title\":\"Impact Analysis\",\"description\":\"An assessment of the impact and exploitability of the vulnerability.\",\"additionalProperties\":false,\"properties\":{\"state\":{\"$ref\":\"#/definitions/impactAnalysisState\"},\"justification\":{\"$ref\":\"#/definitions/impactAnalysisJustification\"},\"response\":{\"type\":\"array\",\"title\":\"Response\",\"description\":\"A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.\",\"items\":{\"type\":\"string\",\"enum\":[\"can_not_fix\",\"will_not_fix\",\"update\",\"rollback\",\"workaround_available\"],\"meta:enum\":{\"can_not_fix\":\"Can not fix\",\"will_not_fix\":\"Will not fix\",\"update\":\"Update to a different revision or release\",\"rollback\":\"Revert to a previous revision or release\",\"workaround_available\":\"There is a workaround available\"}}},\"detail\":{\"type\":\"string\",\"title\":\"Detail\",\"description\":\"Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability.\"},\"firstIssued\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"First Issued\",\"description\":\"The date and time (timestamp) when the analysis was first issued.\"},\"lastUpdated\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Last Updated\",\"description\":\"The date and time (timestamp) when the analysis was last updated.\"}}},\"affects\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"type\":\"object\",\"required\":[\"ref\"],\"additionalProperties\":false,\"properties\":{\"ref\":{\"anyOf\":[{\"title\":\"Ref\",\"$ref\":\"#/definitions/refLinkType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}],\"title\":\"Reference\",\"description\":\"References a component or service by the objects bom-ref\"},\"versions\":{\"type\":\"array\",\"title\":\"Versions\",\"description\":\"Zero or more individual versions or range of versions.\",\"items\":{\"type\":\"object\",\"oneOf\":[{\"required\":[\"version\"]},{\"required\":[\"range\"]}],\"additionalProperties\":false,\"properties\":{\"version\":{\"title\":\"Version\",\"description\":\"A single version of a component or service.\",\"$ref\":\"#/definitions/version\"},\"range\":{\"title\":\"Version Range\",\"description\":\"A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst\",\"$ref\":\"#/definitions/versionRange\"},\"status\":{\"title\":\"Status\",\"description\":\"The vulnerability status for the version or range of versions.\",\"$ref\":\"#/definitions/affectedStatus\",\"default\":\"affected\"}}}}}},\"title\":\"Affects\",\"description\":\"The components or services that are affected by the vulnerability.\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"affectedStatus\":{\"description\":\"The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.\",\"type\":\"string\",\"enum\":[\"affected\",\"unaffected\",\"unknown\"],\"meta:enum\":{\"affected\":\"The version is affected by the vulnerability.\",\"unaffected\":\"The version is not affected by the vulnerability.\",\"unknown\":\"It is unknown (or unspecified) whether the given version is affected.\"}},\"version\":{\"description\":\"A single disjunctive version identifier, for a component or service.\",\"type\":\"string\",\"maxLength\":1024,\"examples\":[\"9.0.14\",\"v1.33.7\",\"7.0.0-M1\",\"2.0pre1\",\"1.0.0-beta1\",\"0.8.15\"]},\"versionRange\":{\"description\":\"A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst\",\"type\":\"string\",\"minLength\":1,\"maxLength\":4096,\"examples\":[\"vers:cargo/9.0.14\",\"vers:npm/1.2.3|>=2.0.0|<5.0.0\",\"vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1\",\"vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1\",\"vers:gem/>=2.2.0|!= 2.2.1|<2.3.0\"]},\"range\":{\"deprecated\":true,\"description\":\"Deprecated definition. use definition `versionRange` instead.\",\"$ref\":\"#/definitions/versionRange\"},\"annotations\":{\"type\":\"object\",\"title\":\"Annotations\",\"description\":\"A comment, note, explanation, or similar textual content which provides additional context to the object(s) being annotated.\",\"required\":[\"subjects\",\"annotator\",\"timestamp\",\"text\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"subjects\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"anyOf\":[{\"title\":\"Ref\",\"$ref\":\"#/definitions/refLinkType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"title\":\"Subjects\",\"description\":\"The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs.\"},\"annotator\":{\"type\":\"object\",\"title\":\"Annotator\",\"description\":\"The organization, person, component, or service which created the textual content of the annotation.\",\"oneOf\":[{\"required\":[\"organization\"]},{\"required\":[\"individual\"]},{\"required\":[\"component\"]},{\"required\":[\"service\"]}],\"additionalProperties\":false,\"properties\":{\"organization\":{\"description\":\"The organization that created the annotation\",\"$ref\":\"#/definitions/organizationalEntity\"},\"individual\":{\"description\":\"The person that created the annotation\",\"$ref\":\"#/definitions/organizationalContact\"},\"component\":{\"description\":\"The tool or component that created the annotation\",\"$ref\":\"#/definitions/component\"},\"service\":{\"description\":\"The service that created the annotation\",\"$ref\":\"#/definitions/service\"}}},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Timestamp\",\"description\":\"The date and time (timestamp) when the annotation was created.\"},\"text\":{\"type\":\"string\",\"title\":\"Text\",\"description\":\"The textual content of the annotation.\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"modelCard\":{\"$comment\":\"Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.\",\"type\":\"object\",\"title\":\"Model Card\",\"description\":\"A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"modelParameters\":{\"type\":\"object\",\"title\":\"Model Parameters\",\"description\":\"Hyper-parameters for construction of the model.\",\"additionalProperties\":false,\"properties\":{\"approach\":{\"type\":\"object\",\"title\":\"Approach\",\"description\":\"The overall approach to learning used by the model for problem solving.\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"Learning Type\",\"description\":\"Learning types describing the learning problem or hybrid learning problem.\",\"enum\":[\"supervised\",\"unsupervised\",\"reinforcement-learning\",\"semi-supervised\",\"self-supervised\"],\"meta:enum\":{\"supervised\":\"Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples.\",\"unsupervised\":\"Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data.\",\"reinforcement-learning\":\"Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error.\",\"semi-supervised\":\"Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques.\",\"self-supervised\":\"Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data.\"}}}},\"task\":{\"type\":\"string\",\"title\":\"Task\",\"description\":\"Directly influences the input and/or output. Examples include classification, regression, clustering, etc.\"},\"architectureFamily\":{\"type\":\"string\",\"title\":\"Architecture Family\",\"description\":\"The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc.\"},\"modelArchitecture\":{\"type\":\"string\",\"title\":\"Model Architecture\",\"description\":\"The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc.\"},\"datasets\":{\"type\":\"array\",\"title\":\"Datasets\",\"description\":\"The datasets used to train and evaluate the model.\",\"items\":{\"oneOf\":[{\"title\":\"Inline Data Information\",\"$ref\":\"#/definitions/componentData\"},{\"type\":\"object\",\"title\":\"Data Reference\",\"additionalProperties\":false,\"properties\":{\"ref\":{\"anyOf\":[{\"title\":\"Ref\",\"$ref\":\"#/definitions/refLinkType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}],\"title\":\"Reference\",\"type\":\"string\",\"description\":\"References a data component by the components bom-ref attribute\"}}}]}},\"inputs\":{\"type\":\"array\",\"title\":\"Inputs\",\"description\":\"The input format(s) of the model\",\"items\":{\"$ref\":\"#/definitions/inputOutputMLParameters\"}},\"outputs\":{\"type\":\"array\",\"title\":\"Outputs\",\"description\":\"The output format(s) from the model\",\"items\":{\"$ref\":\"#/definitions/inputOutputMLParameters\"}}}},\"quantitativeAnalysis\":{\"type\":\"object\",\"title\":\"Quantitative Analysis\",\"description\":\"A quantitative analysis of the model\",\"additionalProperties\":false,\"properties\":{\"performanceMetrics\":{\"type\":\"array\",\"title\":\"Performance Metrics\",\"description\":\"The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.\",\"items\":{\"$ref\":\"#/definitions/performanceMetric\"}},\"graphics\":{\"$ref\":\"#/definitions/graphicsCollection\"}}},\"considerations\":{\"type\":\"object\",\"title\":\"Considerations\",\"description\":\"What considerations should be taken into account regarding the model's construction, training, and application?\",\"additionalProperties\":false,\"properties\":{\"users\":{\"type\":\"array\",\"title\":\"Users\",\"description\":\"Who are the intended users of the model?\",\"items\":{\"type\":\"string\"}},\"useCases\":{\"type\":\"array\",\"title\":\"Use Cases\",\"description\":\"What are the intended use cases of the model?\",\"items\":{\"type\":\"string\"}},\"technicalLimitations\":{\"type\":\"array\",\"title\":\"Technical Limitations\",\"description\":\"What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?\",\"items\":{\"type\":\"string\"}},\"performanceTradeoffs\":{\"type\":\"array\",\"title\":\"Performance Tradeoffs\",\"description\":\"What are the known tradeoffs in accuracy/performance of the model?\",\"items\":{\"type\":\"string\"}},\"ethicalConsiderations\":{\"type\":\"array\",\"title\":\"Ethical Considerations\",\"description\":\"What are the ethical risks involved in the application of this model?\",\"items\":{\"$ref\":\"#/definitions/risk\"}},\"environmentalConsiderations\":{\"$ref\":\"#/definitions/environmentalConsiderations\",\"title\":\"Environmental Considerations\",\"description\":\"What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?\"},\"fairnessAssessments\":{\"type\":\"array\",\"title\":\"Fairness Assessments\",\"description\":\"How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?\",\"items\":{\"$ref\":\"#/definitions/fairnessAssessment\"}}}},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"inputOutputMLParameters\":{\"type\":\"object\",\"title\":\"Input and Output Parameters\",\"additionalProperties\":false,\"properties\":{\"format\":{\"title\":\"Input/Output Format\",\"description\":\"The data format for input/output to the model.\",\"type\":\"string\",\"examples\":[\"string\",\"image\",\"time-series\"]}}},\"componentData\":{\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\"],\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\"},\"type\":{\"type\":\"string\",\"title\":\"Type of Data\",\"description\":\"The general theme or subject matter of the data being specified.\",\"enum\":[\"source-code\",\"configuration\",\"dataset\",\"definition\",\"other\"],\"meta:enum\":{\"source-code\":\"Any type of code, code snippet, or data-as-code.\",\"configuration\":\"Parameters or settings that may be used by other components.\",\"dataset\":\"A collection of data.\",\"definition\":\"Data that can be used to create new instances of what the definition defines.\",\"other\":\"Any other type of data that does not fit into existing definitions.\"}},\"name\":{\"title\":\"Dataset Name\",\"description\":\"The name of the dataset.\",\"type\":\"string\"},\"contents\":{\"type\":\"object\",\"title\":\"Data Contents\",\"description\":\"The contents or references to the contents of the data being described.\",\"additionalProperties\":false,\"properties\":{\"attachment\":{\"title\":\"Data Attachment\",\"description\":\"An optional way to include textual or encoded data.\",\"$ref\":\"#/definitions/attachment\"},\"url\":{\"type\":\"string\",\"title\":\"Data URL\",\"description\":\"The URL to where the data can be retrieved.\",\"format\":\"iri-reference\"},\"properties\":{\"type\":\"array\",\"title\":\"Configuration Properties\",\"description\":\"Provides the ability to document name-value parameters used for configuration.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"classification\":{\"$ref\":\"#/definitions/dataClassification\"},\"sensitiveData\":{\"type\":\"array\",\"title\":\"Sensitive Data\",\"description\":\"A description of any sensitive data in a dataset.\",\"items\":{\"type\":\"string\"}},\"graphics\":{\"$ref\":\"#/definitions/graphicsCollection\"},\"description\":{\"title\":\"Dataset Description\",\"description\":\"A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.\",\"type\":\"string\"},\"governance\":{\"title\":\"Data Governance\",\"$ref\":\"#/definitions/dataGovernance\"}}},\"dataGovernance\":{\"type\":\"object\",\"title\":\"Data Governance\",\"description\":\"Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.\",\"additionalProperties\":false,\"properties\":{\"custodians\":{\"type\":\"array\",\"title\":\"Data Custodians\",\"description\":\"Data custodians are responsible for the safe custody, transport, and storage of data.\",\"items\":{\"$ref\":\"#/definitions/dataGovernanceResponsibleParty\"}},\"stewards\":{\"type\":\"array\",\"title\":\"Data Stewards\",\"description\":\"Data stewards are responsible for data content, context, and associated business rules.\",\"items\":{\"$ref\":\"#/definitions/dataGovernanceResponsibleParty\"}},\"owners\":{\"type\":\"array\",\"title\":\"Data Owners\",\"description\":\"Data owners are concerned with risk and appropriate access to data.\",\"items\":{\"$ref\":\"#/definitions/dataGovernanceResponsibleParty\"}}}},\"dataGovernanceResponsibleParty\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"organization\":{\"title\":\"Organization\",\"description\":\"The organization that is responsible for specific data governance role(s).\",\"$ref\":\"#/definitions/organizationalEntity\"},\"contact\":{\"title\":\"Individual\",\"description\":\"The individual that is responsible for specific data governance role(s).\",\"$ref\":\"#/definitions/organizationalContact\"}},\"oneOf\":[{\"required\":[\"organization\"]},{\"required\":[\"contact\"]}]},\"graphicsCollection\":{\"type\":\"object\",\"title\":\"Graphics Collection\",\"description\":\"A collection of graphics that represent various measurements.\",\"additionalProperties\":false,\"properties\":{\"description\":{\"title\":\"Description\",\"description\":\"A description of this collection of graphics.\",\"type\":\"string\"},\"collection\":{\"title\":\"Collection\",\"description\":\"A collection of graphics.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/graphic\"}}}},\"graphic\":{\"type\":\"object\",\"title\":\"Graphic\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"The name of the graphic.\",\"type\":\"string\"},\"image\":{\"title\":\"Graphic Image\",\"description\":\"The graphic (vector or raster). Base64 encoding must be specified for binary images.\",\"$ref\":\"#/definitions/attachment\"}}},\"performanceMetric\":{\"type\":\"object\",\"title\":\"Performance Metric\",\"additionalProperties\":false,\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"The type of performance metric.\",\"type\":\"string\"},\"value\":{\"title\":\"Value\",\"description\":\"The value of the performance metric.\",\"type\":\"string\"},\"slice\":{\"title\":\"Slice\",\"description\":\"The name of the slice this metric was computed on. By default, assume this metric is not sliced.\",\"type\":\"string\"},\"confidenceInterval\":{\"title\":\"Confidence Interval\",\"description\":\"The confidence interval of the metric.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"lowerBound\":{\"title\":\"Lower Bound\",\"description\":\"The lower bound of the confidence interval.\",\"type\":\"string\"},\"upperBound\":{\"title\":\"Upper Bound\",\"description\":\"The upper bound of the confidence interval.\",\"type\":\"string\"}}}}},\"risk\":{\"type\":\"object\",\"title\":\"Risk\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"The name of the risk.\",\"type\":\"string\"},\"mitigationStrategy\":{\"title\":\"Mitigation Strategy\",\"description\":\"Strategy used to address this risk.\",\"type\":\"string\"}}},\"fairnessAssessment\":{\"type\":\"object\",\"title\":\"Fairness Assessment\",\"description\":\"Information about the benefits and harms of the model to an identified at risk group.\",\"additionalProperties\":false,\"properties\":{\"groupAtRisk\":{\"type\":\"string\",\"title\":\"Group at Risk\",\"description\":\"The groups or individuals at risk of being systematically disadvantaged by the model.\"},\"benefits\":{\"type\":\"string\",\"title\":\"Benefits\",\"description\":\"Expected benefits to the identified groups.\"},\"harms\":{\"type\":\"string\",\"title\":\"Harms\",\"description\":\"Expected harms to the identified groups.\"},\"mitigationStrategy\":{\"type\":\"string\",\"title\":\"Mitigation Strategy\",\"description\":\"With respect to the benefits and harms outlined, please describe any mitigation strategy implemented.\"}}},\"dataClassification\":{\"type\":\"string\",\"title\":\"Data Classification\",\"description\":\"Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.\"},\"environmentalConsiderations\":{\"type\":\"object\",\"title\":\"Environmental Considerations\",\"description\":\"Describes various environmental impact metrics.\",\"additionalProperties\":false,\"properties\":{\"energyConsumptions\":{\"title\":\"Energy Consumptions\",\"description\":\"Describes energy consumption information incurred for one or more component lifecycle activities.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/energyConsumption\"}},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"energyConsumption\":{\"title\":\"Energy consumption\",\"description\":\"Describes energy consumption information incurred for the specified lifecycle activity.\",\"type\":\"object\",\"required\":[\"activity\",\"energyProviders\",\"activityEnergyCost\"],\"additionalProperties\":false,\"properties\":{\"activity\":{\"type\":\"string\",\"title\":\"Activity\",\"description\":\"The type of activity that is part of a machine learning model development or operational lifecycle.\",\"enum\":[\"design\",\"data-collection\",\"data-preparation\",\"training\",\"fine-tuning\",\"validation\",\"deployment\",\"inference\",\"other\"],\"meta:enum\":{\"design\":\"A model design including problem framing, goal definition and algorithm selection.\",\"data-collection\":\"Model data acquisition including search, selection and transfer.\",\"data-preparation\":\"Model data preparation including data cleaning, labeling and conversion.\",\"training\":\"Model building, training and generalized tuning.\",\"fine-tuning\":\"Refining a trained model to produce desired outputs for a given problem space.\",\"validation\":\"Model validation including model output evaluation and testing.\",\"deployment\":\"Explicit model deployment to a target hosting infrastructure.\",\"inference\":\"Generating an output response from a hosted model from a set of inputs.\",\"other\":\"A lifecycle activity type whose description does not match currently defined values.\"}},\"energyProviders\":{\"title\":\"Energy Providers\",\"description\":\"The provider(s) of the energy consumed by the associated model development lifecycle activity.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/energyProvider\"}},\"activityEnergyCost\":{\"title\":\"Activity Energy Cost\",\"description\":\"The total energy cost associated with the model lifecycle activity.\",\"$ref\":\"#/definitions/energyMeasure\"},\"co2CostEquivalent\":{\"title\":\"CO2 Equivalent Cost\",\"description\":\"The CO2 cost (debit) equivalent to the total energy cost.\",\"$ref\":\"#/definitions/co2Measure\"},\"co2CostOffset\":{\"title\":\"CO2 Cost Offset\",\"description\":\"The CO2 offset (credit) for the CO2 equivalent cost.\",\"$ref\":\"#/definitions/co2Measure\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"energyMeasure\":{\"type\":\"object\",\"title\":\"Energy Measure\",\"description\":\"A measure of energy.\",\"required\":[\"value\",\"unit\"],\"additionalProperties\":false,\"properties\":{\"value\":{\"type\":\"number\",\"title\":\"Value\",\"description\":\"Quantity of energy.\"},\"unit\":{\"type\":\"string\",\"enum\":[\"kWh\"],\"title\":\"Unit\",\"description\":\"Unit of energy.\",\"meta:enum\":{\"kWh\":\"Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h).\"}}}},\"co2Measure\":{\"type\":\"object\",\"title\":\"CO2 Measure\",\"description\":\"A measure of carbon dioxide (CO2).\",\"required\":[\"value\",\"unit\"],\"additionalProperties\":false,\"properties\":{\"value\":{\"type\":\"number\",\"title\":\"Value\",\"description\":\"Quantity of carbon dioxide (CO2).\"},\"unit\":{\"type\":\"string\",\"enum\":[\"tCO2eq\"],\"title\":\"Unit\",\"description\":\"Unit of carbon dioxide (CO2).\",\"meta:enum\":{\"tCO2eq\":\"Tonnes (t) of carbon dioxide (CO2) equivalent (eq).\"}}}},\"energyProvider\":{\"type\":\"object\",\"title\":\"Energy Provider\",\"description\":\"Describes the physical provider of energy used for model development or operations.\",\"required\":[\"organization\",\"energySource\",\"energyProvided\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"A description of the energy provider.\"},\"organization\":{\"type\":\"object\",\"title\":\"Organization\",\"description\":\"The organization that provides energy.\",\"$ref\":\"#/definitions/organizationalEntity\"},\"energySource\":{\"type\":\"string\",\"enum\":[\"coal\",\"oil\",\"natural-gas\",\"nuclear\",\"wind\",\"solar\",\"geothermal\",\"hydropower\",\"biofuel\",\"unknown\",\"other\"],\"meta:enum\":{\"coal\":\"Energy produced by types of coal.\",\"oil\":\"Petroleum products (primarily crude oil and its derivative fuel oils).\",\"natural-gas\":\"Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc.\",\"nuclear\":\"Energy produced from the cores of atoms (i.e., through nuclear fission or fusion).\",\"wind\":\"Energy produced from moving air.\",\"solar\":\"Energy produced from the sun (i.e., solar radiation).\",\"geothermal\":\"Energy produced from heat within the earth.\",\"hydropower\":\"Energy produced from flowing water.\",\"biofuel\":\"Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals).\",\"unknown\":\"The energy source is unknown.\",\"other\":\"An energy source that is not listed.\"},\"title\":\"Energy Source\",\"description\":\"The energy source for the energy provider.\"},\"energyProvided\":{\"$ref\":\"#/definitions/energyMeasure\",\"title\":\"Energy Provided\",\"description\":\"The energy provided by the energy source for an associated activity.\"},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"}}},\"postalAddress\":{\"type\":\"object\",\"title\":\"Postal address\",\"description\":\"An address used to identify a contactable location.\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"country\":{\"type\":\"string\",\"title\":\"Country\",\"description\":\"The country name or the two-letter ISO 3166-1 country code.\"},\"region\":{\"type\":\"string\",\"title\":\"Region\",\"description\":\"The region or state in the country.\",\"examples\":[\"Texas\"]},\"locality\":{\"type\":\"string\",\"title\":\"Locality\",\"description\":\"The locality or city within the country.\",\"examples\":[\"Austin\"]},\"postOfficeBoxNumber\":{\"type\":\"string\",\"title\":\"Post Office Box Number\",\"description\":\"The post office box number.\",\"examples\":[\"901\"]},\"postalCode\":{\"type\":\"string\",\"title\":\"Postal Code\",\"description\":\"The postal code.\",\"examples\":[\"78758\"]},\"streetAddress\":{\"type\":\"string\",\"title\":\"Street Address\",\"description\":\"The street address.\",\"examples\":[\"100 Main Street\"]}}},\"formula\":{\"title\":\"Formula\",\"description\":\"Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"components\":{\"title\":\"Components\",\"description\":\"Transient components that are used in tasks that constitute one or more of this formula's workflows\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/component\"},\"uniqueItems\":true},\"services\":{\"title\":\"Services\",\"description\":\"Transient services that are used in tasks that constitute one or more of this formula's workflows\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/service\"},\"uniqueItems\":true},\"workflows\":{\"title\":\"Workflows\",\"description\":\"List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered.\",\"$comment\":\"Different workflows can be designed to work together to perform end-to-end CI/CD builds and deployments.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/workflow\"},\"uniqueItems\":true},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"workflow\":{\"title\":\"Workflow\",\"description\":\"A specialized orchestration task.\",\"$comment\":\"Workflow are as task themselves and can trigger other workflow tasks. These relationships can be modeled in the taskDependencies graph.\",\"type\":\"object\",\"required\":[\"bom-ref\",\"uid\",\"taskTypes\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"uid\":{\"title\":\"Unique Identifier (UID)\",\"description\":\"The unique identifier for the resource instance within its deployment context.\",\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the resource instance.\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"description\":\"A description of the resource instance.\",\"type\":\"string\"},\"resourceReferences\":{\"title\":\"Resource references\",\"description\":\"References to component or service resources that are used to realize the resource instance.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/resourceReferenceChoice\"}},\"tasks\":{\"title\":\"Tasks\",\"description\":\"The tasks that comprise the workflow.\",\"$comment\":\"Note that tasks can appear more than once as different instances (by name or UID).\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/task\"}},\"taskDependencies\":{\"title\":\"Task dependency graph\",\"description\":\"The graph of dependencies between tasks within the workflow.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/dependency\"}},\"taskTypes\":{\"title\":\"Task types\",\"description\":\"Indicates the types of activities performed by the set of workflow tasks.\",\"$comment\":\"Currently, these types reflect common CI/CD actions.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/taskType\"}},\"trigger\":{\"title\":\"Trigger\",\"description\":\"The trigger that initiated the task.\",\"$ref\":\"#/definitions/trigger\"},\"steps\":{\"title\":\"Steps\",\"description\":\"The sequence of steps for the task.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/step\"},\"uniqueItems\":true},\"inputs\":{\"title\":\"Inputs\",\"description\":\"Represents resources and data brought into a task at runtime by executor or task commands\",\"examples\":[\"a `configuration` file which was declared as a local `component` or `externalReference`\"],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/inputType\"},\"uniqueItems\":true},\"outputs\":{\"title\":\"Outputs\",\"description\":\"Represents resources and data output from a task at runtime by executor or task commands\",\"examples\":[\"a log file or metrics data produced by the task\"],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/outputType\"},\"uniqueItems\":true},\"timeStart\":{\"title\":\"Time start\",\"description\":\"The date and time (timestamp) when the task started.\",\"type\":\"string\",\"format\":\"date-time\"},\"timeEnd\":{\"title\":\"Time end\",\"description\":\"The date and time (timestamp) when the task ended.\",\"type\":\"string\",\"format\":\"date-time\"},\"workspaces\":{\"title\":\"Workspaces\",\"description\":\"A set of named filesystem or data resource shareable by workflow tasks.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/workspace\"}},\"runtimeTopology\":{\"title\":\"Runtime topology\",\"description\":\"A graph of the component runtime topology for workflow's instance.\",\"$comment\":\"A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/dependency\"}},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"task\":{\"title\":\"Task\",\"description\":\"Describes the inputs, sequence of steps and resources used to accomplish a task and its output.\",\"$comment\":\"Tasks are building blocks for constructing assemble CI/CD workflows or pipelines.\",\"type\":\"object\",\"required\":[\"bom-ref\",\"uid\",\"taskTypes\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"uid\":{\"title\":\"Unique Identifier (UID)\",\"description\":\"The unique identifier for the resource instance within its deployment context.\",\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the resource instance.\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"description\":\"A description of the resource instance.\",\"type\":\"string\"},\"resourceReferences\":{\"title\":\"Resource references\",\"description\":\"References to component or service resources that are used to realize the resource instance.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/resourceReferenceChoice\"}},\"taskTypes\":{\"title\":\"Task types\",\"description\":\"Indicates the types of activities performed by the set of workflow tasks.\",\"$comment\":\"Currently, these types reflect common CI/CD actions.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/taskType\"}},\"trigger\":{\"title\":\"Trigger\",\"description\":\"The trigger that initiated the task.\",\"$ref\":\"#/definitions/trigger\"},\"steps\":{\"title\":\"Steps\",\"description\":\"The sequence of steps for the task.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/step\"},\"uniqueItems\":true},\"inputs\":{\"title\":\"Inputs\",\"description\":\"Represents resources and data brought into a task at runtime by executor or task commands\",\"examples\":[\"a `configuration` file which was declared as a local `component` or `externalReference`\"],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/inputType\"},\"uniqueItems\":true},\"outputs\":{\"title\":\"Outputs\",\"description\":\"Represents resources and data output from a task at runtime by executor or task commands\",\"examples\":[\"a log file or metrics data produced by the task\"],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/outputType\"},\"uniqueItems\":true},\"timeStart\":{\"title\":\"Time start\",\"description\":\"The date and time (timestamp) when the task started.\",\"type\":\"string\",\"format\":\"date-time\"},\"timeEnd\":{\"title\":\"Time end\",\"description\":\"The date and time (timestamp) when the task ended.\",\"type\":\"string\",\"format\":\"date-time\"},\"workspaces\":{\"title\":\"Workspaces\",\"description\":\"A set of named filesystem or data resource shareable by workflow tasks.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/workspace\"},\"uniqueItems\":true},\"runtimeTopology\":{\"title\":\"Runtime topology\",\"description\":\"A graph of the component runtime topology for task's instance.\",\"$comment\":\"A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/dependency\"},\"uniqueItems\":true},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"step\":{\"type\":\"object\",\"description\":\"Executes specific commands or tools in order to accomplish its owning task as part of a sequence.\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"A name for the step.\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"description\":\"A description of the step.\",\"type\":\"string\"},\"commands\":{\"title\":\"Commands\",\"description\":\"Ordered list of commands or directives for the step\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/command\"}},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"command\":{\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"executed\":{\"title\":\"Executed\",\"description\":\"A text representation of the executed command.\",\"type\":\"string\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"workspace\":{\"title\":\"Workspace\",\"description\":\"A named filesystem or data resource shareable by workflow tasks.\",\"type\":\"object\",\"required\":[\"bom-ref\",\"uid\"],\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"uid\":{\"title\":\"Unique Identifier (UID)\",\"description\":\"The unique identifier for the resource instance within its deployment context.\",\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the resource instance.\",\"type\":\"string\"},\"aliases\":{\"title\":\"Aliases\",\"description\":\"The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps.\",\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"description\":{\"title\":\"Description\",\"description\":\"A description of the resource instance.\",\"type\":\"string\"},\"resourceReferences\":{\"title\":\"Resource references\",\"description\":\"References to component or service resources that are used to realize the resource instance.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/resourceReferenceChoice\"}},\"accessMode\":{\"title\":\"Access mode\",\"description\":\"Describes the read-write access control for the workspace relative to the owning resource instance.\",\"type\":\"string\",\"enum\":[\"read-only\",\"read-write\",\"read-write-once\",\"write-once\",\"write-only\"]},\"mountPath\":{\"title\":\"Mount path\",\"description\":\"A path to a location on disk where the workspace will be available to the associated task's steps.\",\"type\":\"string\"},\"managedDataType\":{\"title\":\"Managed data type\",\"description\":\"The name of a domain-specific data type the workspace represents.\",\"$comment\":\"This property is for CI/CD frameworks that are able to provide access to structured, managed data at a more granular level than a filesystem.\",\"examples\":[\"ConfigMap\",\"Secret\"],\"type\":\"string\"},\"volumeRequest\":{\"title\":\"Volume request\",\"description\":\"Identifies the reference to the request for a specific volume type and parameters.\",\"examples\":[\"a kubernetes Persistent Volume Claim (PVC) name\"],\"type\":\"string\"},\"volume\":{\"title\":\"Volume\",\"description\":\"Information about the actual volume instance allocated to the workspace.\",\"$comment\":\"The actual volume allocated may be different than the request.\",\"examples\":[\"see https://kubernetes.io/docs/concepts/storage/persistent-volumes/\"],\"$ref\":\"#/definitions/volume\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"volume\":{\"title\":\"Volume\",\"description\":\"An identifiable, logical unit of data storage tied to a physical device.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"uid\":{\"title\":\"Unique Identifier (UID)\",\"description\":\"The unique identifier for the volume instance within its deployment context.\",\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the volume instance\",\"type\":\"string\"},\"mode\":{\"title\":\"Mode\",\"description\":\"The mode for the volume instance.\",\"type\":\"string\",\"enum\":[\"filesystem\",\"block\"],\"default\":\"filesystem\"},\"path\":{\"title\":\"Path\",\"description\":\"The underlying path created from the actual volume.\",\"type\":\"string\"},\"sizeAllocated\":{\"title\":\"Size allocated\",\"description\":\"The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form.\",\"examples\":[\"10GB\",\"2Ti\",\"1Pi\"],\"type\":\"string\"},\"persistent\":{\"title\":\"Persistent\",\"description\":\"Indicates if the volume persists beyond the life of the resource it is associated with.\",\"type\":\"boolean\"},\"remote\":{\"title\":\"Remote\",\"description\":\"Indicates if the volume is remotely (i.e., network) attached.\",\"type\":\"boolean\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"trigger\":{\"title\":\"Trigger\",\"description\":\"Represents a resource that can conditionally activate (or fire) tasks based upon associated events and their data.\",\"type\":\"object\",\"additionalProperties\":false,\"required\":[\"type\",\"bom-ref\",\"uid\"],\"properties\":{\"bom-ref\":{\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref must be unique within the BOM.\\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.\",\"$ref\":\"#/definitions/refType\"},\"uid\":{\"title\":\"Unique Identifier (UID)\",\"description\":\"The unique identifier for the resource instance within its deployment context.\",\"type\":\"string\"},\"name\":{\"title\":\"Name\",\"description\":\"The name of the resource instance.\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"description\":\"A description of the resource instance.\",\"type\":\"string\"},\"resourceReferences\":{\"title\":\"Resource references\",\"description\":\"References to component or service resources that are used to realize the resource instance.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/resourceReferenceChoice\"}},\"type\":{\"title\":\"Type\",\"description\":\"The source type of event which caused the trigger to fire.\",\"type\":\"string\",\"enum\":[\"manual\",\"api\",\"webhook\",\"scheduled\"]},\"event\":{\"title\":\"Event\",\"description\":\"The event data that caused the associated trigger to activate.\",\"$ref\":\"#/definitions/event\"},\"conditions\":{\"type\":\"array\",\"title\":\"Conditions\",\"description\":\"A list of conditions used to determine if a trigger should be activated.\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/condition\"}},\"timeActivated\":{\"title\":\"Time activated\",\"description\":\"The date and time (timestamp) when the trigger was activated.\",\"type\":\"string\",\"format\":\"date-time\"},\"inputs\":{\"title\":\"Inputs\",\"description\":\"Represents resources and data brought into a task at runtime by executor or task commands\",\"examples\":[\"a `configuration` file which was declared as a local `component` or `externalReference`\"],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/inputType\"},\"uniqueItems\":true},\"outputs\":{\"title\":\"Outputs\",\"description\":\"Represents resources and data output from a task at runtime by executor or task commands\",\"examples\":[\"a log file or metrics data produced by the task\"],\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/outputType\"},\"uniqueItems\":true},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"event\":{\"title\":\"Event\",\"description\":\"Represents something that happened that may trigger a response.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"uid\":{\"title\":\"Unique Identifier (UID)\",\"description\":\"The unique identifier of the event.\",\"type\":\"string\"},\"description\":{\"title\":\"Description\",\"description\":\"A description of the event.\",\"type\":\"string\"},\"timeReceived\":{\"title\":\"Time Received\",\"description\":\"The date and time (timestamp) when the event was received.\",\"type\":\"string\",\"format\":\"date-time\"},\"data\":{\"title\":\"Data\",\"description\":\"Encoding of the raw event data.\",\"$ref\":\"#/definitions/attachment\"},\"source\":{\"title\":\"Source\",\"description\":\"References the component or service that was the source of the event\",\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"target\":{\"title\":\"Target\",\"description\":\"References the component or service that was the target of the event\",\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"inputType\":{\"title\":\"Input type\",\"description\":\"Type that represents various input data types and formats.\",\"type\":\"object\",\"oneOf\":[{\"required\":[\"resource\"]},{\"required\":[\"parameters\"]},{\"required\":[\"environmentVars\"]},{\"required\":[\"data\"]}],\"additionalProperties\":false,\"properties\":{\"source\":{\"title\":\"Source\",\"description\":\"A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`)\",\"examples\":[\"source code repository\",\"database\"],\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"target\":{\"title\":\"Target\",\"description\":\"A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)\",\"examples\":[\"workspace\",\"directory\"],\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"resource\":{\"title\":\"Resource\",\"description\":\"A reference to an independent resource provided as an input to a task by the workflow runtime.\",\"examples\":[\"a reference to a configuration file in a repository (i.e., a bom-ref)\",\"a reference to a scanning service used in a task (i.e., a bom-ref)\"],\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"parameters\":{\"title\":\"Parameters\",\"description\":\"Inputs that have the form of parameters with names and values.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"$ref\":\"#/definitions/parameter\"}},\"environmentVars\":{\"title\":\"Environment variables\",\"description\":\"Inputs that have the form of parameters with names and values.\",\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"oneOf\":[{\"$ref\":\"#/definitions/property\"},{\"type\":\"string\"}]}},\"data\":{\"title\":\"Data\",\"description\":\"Inputs that have the form of data.\",\"$ref\":\"#/definitions/attachment\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"outputType\":{\"type\":\"object\",\"oneOf\":[{\"required\":[\"resource\"]},{\"required\":[\"environmentVars\"]},{\"required\":[\"data\"]}],\"additionalProperties\":false,\"properties\":{\"type\":{\"title\":\"Type\",\"description\":\"Describes the type of data output.\",\"type\":\"string\",\"enum\":[\"artifact\",\"attestation\",\"log\",\"evidence\",\"metrics\",\"other\"]},\"source\":{\"title\":\"Source\",\"description\":\"Component or service that generated or provided the output from the task (e.g., a build tool)\",\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"target\":{\"title\":\"Target\",\"description\":\"Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`)\",\"examples\":[\"a log file described as an `externalReference` within its target domain.\"],\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"resource\":{\"title\":\"Resource\",\"description\":\"A reference to an independent resource generated as output by the task.\",\"examples\":[\"configuration file\",\"source code\",\"scanning service\"],\"$ref\":\"#/definitions/resourceReferenceChoice\"},\"data\":{\"title\":\"Data\",\"description\":\"Outputs that have the form of data.\",\"$ref\":\"#/definitions/attachment\"},\"environmentVars\":{\"title\":\"Environment variables\",\"description\":\"Outputs that have the form of environment variables.\",\"type\":\"array\",\"items\":{\"oneOf\":[{\"$ref\":\"#/definitions/property\"},{\"type\":\"string\"}]},\"uniqueItems\":true},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"resourceReferenceChoice\":{\"title\":\"Resource reference choice\",\"description\":\"A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.\",\"$comment\":\"Enables reference to a resource that participates in a workflow; using either internal (bom-ref) or external (externalReference) types.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"ref\":{\"title\":\"BOM Reference\",\"description\":\"References an object by its bom-ref attribute\",\"anyOf\":[{\"title\":\"Ref\",\"$ref\":\"#/definitions/refLinkType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"externalReference\":{\"title\":\"External reference\",\"description\":\"Reference to an externally accessible resource.\",\"$ref\":\"#/definitions/externalReference\"}},\"oneOf\":[{\"required\":[\"ref\"]},{\"required\":[\"externalReference\"]}]},\"condition\":{\"title\":\"Condition\",\"description\":\"A condition that was used to determine a trigger should be activated.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"description\":{\"title\":\"Description\",\"description\":\"Describes the set of conditions which cause the trigger to activate.\",\"type\":\"string\"},\"expression\":{\"title\":\"Expression\",\"description\":\"The logical expression that was evaluated that determined the trigger should be fired.\",\"type\":\"string\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}}}},\"taskType\":{\"type\":\"string\",\"enum\":[\"copy\",\"clone\",\"lint\",\"scan\",\"merge\",\"build\",\"test\",\"deliver\",\"deploy\",\"release\",\"clean\",\"other\"],\"meta:enum\":{\"copy\":\"A task that copies software or data used to accomplish other tasks in the workflow.\",\"clone\":\"A task that clones a software repository into the workflow in order to retrieve its source code or data for use in a build step.\",\"lint\":\"A task that checks source code for programmatic and stylistic errors.\",\"scan\":\"A task that performs a scan against source code, or built or deployed components and services. Scans are typically run to gather or test for security vulnerabilities or policy compliance.\",\"merge\":\"A task that merges changes or fixes into source code prior to a build step in the workflow.\",\"build\":\"A task that builds the source code, dependencies and/or data into an artifact that can be deployed to and executed on target systems.\",\"test\":\"A task that verifies the functionality of a component or service.\",\"deliver\":\"A task that delivers a built artifact to one or more target repositories or storage systems.\",\"deploy\":\"A task that deploys a built artifact for execution on one or more target systems.\",\"release\":\"A task that releases a built, versioned artifact to a target repository or distribution system.\",\"clean\":\"A task that cleans unnecessary tools, build artifacts and/or data from workflow storage.\",\"other\":\"A workflow task that does not match current task type definitions.\"}},\"parameter\":{\"title\":\"Parameter\",\"description\":\"A representation of a functional parameter.\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"name\":{\"title\":\"Name\",\"description\":\"The name of the parameter.\",\"type\":\"string\"},\"value\":{\"title\":\"Value\",\"description\":\"The value of the parameter.\",\"type\":\"string\"},\"dataType\":{\"title\":\"Data type\",\"description\":\"The data type of the parameter.\",\"type\":\"string\"}}},\"componentIdentityEvidence\":{\"type\":\"object\",\"title\":\"Identity Evidence\",\"description\":\"Evidence that substantiates the identity of a component.\",\"required\":[\"field\"],\"additionalProperties\":false,\"properties\":{\"field\":{\"type\":\"string\",\"enum\":[\"group\",\"name\",\"version\",\"purl\",\"cpe\",\"omniborId\",\"swhid\",\"swid\",\"hash\"],\"title\":\"Field\",\"description\":\"The identity field of the component which the evidence describes.\"},\"confidence\":{\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"title\":\"Confidence\",\"description\":\"The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.\"},\"concludedValue\":{\"type\":\"string\",\"title\":\"Concluded Value\",\"description\":\"The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).\"},\"methods\":{\"type\":\"array\",\"title\":\"Methods\",\"description\":\"The methods used to extract and/or analyze the evidence.\",\"items\":{\"type\":\"object\",\"required\":[\"technique\",\"confidence\"],\"additionalProperties\":false,\"properties\":{\"technique\":{\"title\":\"Technique\",\"description\":\"The technique used in this method of analysis.\",\"type\":\"string\",\"enum\":[\"source-code-analysis\",\"binary-analysis\",\"manifest-analysis\",\"ast-fingerprint\",\"hash-comparison\",\"instrumentation\",\"dynamic-analysis\",\"filename\",\"attestation\",\"other\"]},\"confidence\":{\"type\":\"number\",\"minimum\":0,\"maximum\":1,\"title\":\"Confidence\",\"description\":\"The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence.\"},\"value\":{\"type\":\"string\",\"title\":\"Value\",\"description\":\"The value or contents of the evidence.\"}}}},\"tools\":{\"type\":\"array\",\"uniqueItems\":true,\"items\":{\"anyOf\":[{\"title\":\"Ref\",\"$ref\":\"#/definitions/refLinkType\"},{\"title\":\"BOM-Link Element\",\"$ref\":\"#/definitions/bomLinkElementType\"}]},\"title\":\"BOM References\",\"description\":\"The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.\"}}},\"standard\":{\"type\":\"object\",\"title\":\"Standard\",\"description\":\"A standard may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\"},\"name\":{\"type\":\"string\",\"title\":\"Name\",\"description\":\"The name of the standard. This will often be a shortened, single name of the standard.\"},\"version\":{\"type\":\"string\",\"title\":\"Version\",\"description\":\"The version of the standard.\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"The description of the standard.\"},\"owner\":{\"type\":\"string\",\"title\":\"Owner\",\"description\":\"The owner of the standard, often the entity responsible for its release.\"},\"requirements\":{\"type\":\"array\",\"title\":\"Requirements\",\"description\":\"The list of requirements comprising the standard.\",\"items\":{\"type\":\"object\",\"title\":\"Requirement\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\"},\"identifier\":{\"type\":\"string\",\"title\":\"Identifier\",\"description\":\"The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref.\"},\"title\":{\"type\":\"string\",\"title\":\"Title\",\"description\":\"The title of the requirement.\"},\"text\":{\"type\":\"string\",\"title\":\"Text\",\"description\":\"The textual content of the requirement.\"},\"descriptions\":{\"type\":\"array\",\"title\":\"Descriptions\",\"description\":\"The supplemental text that provides additional guidance or context to the requirement, but is not directly part of the requirement.\",\"items\":{\"type\":\"string\"}},\"openCre\":{\"type\":\"array\",\"title\":\"OWASP OpenCRE Identifier(s)\",\"description\":\"The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders.\",\"items\":{\"type\":\"string\",\"pattern\":\"^CRE:[0-9]+-[0-9]+$\",\"examples\":[\"CRE:764-507\"]}},\"parent\":{\"$ref\":\"#/definitions/refLinkType\",\"title\":\"Parent BOM Reference\",\"description\":\"The optional `bom-ref` to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements must not define a parent. Only child requirements should define parents.\"},\"properties\":{\"type\":\"array\",\"title\":\"Properties\",\"description\":\"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.\",\"items\":{\"$ref\":\"#/definitions/property\"}},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"}}}},\"levels\":{\"type\":\"array\",\"title\":\"Levels\",\"description\":\"The list of levels associated with the standard. Some standards have different levels of compliance.\",\"items\":{\"type\":\"object\",\"title\":\"Level\",\"additionalProperties\":false,\"properties\":{\"bom-ref\":{\"$ref\":\"#/definitions/refType\",\"title\":\"BOM Reference\",\"description\":\"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\"},\"identifier\":{\"type\":\"string\",\"title\":\"Identifier\",\"description\":\"The identifier used in the standard to identify a specific level.\"},\"title\":{\"type\":\"string\",\"title\":\"Title\",\"description\":\"The title of the level.\"},\"description\":{\"type\":\"string\",\"title\":\"Description\",\"description\":\"The description of the level.\"},\"requirements\":{\"type\":\"array\",\"title\":\"Requirements\",\"description\":\"The list of requirement `bom-ref`s that comprise the level.\",\"items\":{\"$ref\":\"#/definitions/refLinkType\"}}}}},\"externalReferences\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/externalReference\"},\"title\":\"External References\",\"description\":\"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.\"},\"signature\":{\"$ref\":\"#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"}}},\"signature\":{\"$ref\":\"jsf-0.82.schema.json#/definitions/signature\",\"title\":\"Signature\",\"description\":\"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html).\"},\"cryptoProperties\":{\"type\":\"object\",\"title\":\"Cryptographic Properties\",\"description\":\"Cryptographic assets have properties that uniquely define them and that make them actionable for further reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES) or the specific variant or instantiation (e.g. AES-128-GCM). This is because the security level and the algorithm primitive (authenticated encryption) are only defined by the definition of the algorithm variant. The presence of a weak cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.\",\"additionalProperties\":false,\"required\":[\"assetType\"],\"properties\":{\"assetType\":{\"type\":\"string\",\"title\":\"Asset Type\",\"description\":\"Cryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in specialized cryptographic libraries. They may, however, also be 'hardcoded' in software components. Certificates and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be modelled.\",\"enum\":[\"algorithm\",\"certificate\",\"protocol\",\"related-crypto-material\"],\"meta:enum\":{\"algorithm\":\"Mathematical function commonly used for data encryption, authentication, and digital signatures.\",\"certificate\":\"An electronic document that is used to provide the identity or validate a public key.\",\"protocol\":\"A set of rules and guidelines that govern the behavior and communication with each other.\",\"related-crypto-material\":\"Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens.\"}},\"algorithmProperties\":{\"type\":\"object\",\"title\":\"Algorithm Properties\",\"description\":\"Additional properties specific to a cryptographic algorithm.\",\"additionalProperties\":false,\"properties\":{\"primitive\":{\"type\":\"string\",\"title\":\"primitive\",\"description\":\"Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).\",\"enum\":[\"drbg\",\"mac\",\"block-cipher\",\"stream-cipher\",\"signature\",\"hash\",\"pke\",\"xof\",\"kdf\",\"key-agree\",\"kem\",\"ae\",\"combiner\",\"other\",\"unknown\"],\"meta:enum\":{\"drbg\":\"Deterministic Random Bit Generator (DRBG) is a type of pseudorandom number generator designed to produce a sequence of bits from an initial seed value. DRBGs are commonly used in cryptographic applications where reproducibility of random values is important.\",\"mac\":\"In cryptography, a Message Authentication Code (MAC) is information used for authenticating and integrity-checking a message.\",\"block-cipher\":\"A block cipher is a symmetric key algorithm that operates on fixed-size blocks of data. It encrypts or decrypts the data in block units, providing confidentiality. Block ciphers are widely used in various cryptographic modes and protocols for secure data transmission.\",\"stream-cipher\":\"A stream cipher is a symmetric key cipher where plaintext digits are combined with a pseudorandom cipher digit stream (keystream).\",\"signature\":\"In cryptography, a signature is a digital representation of a message or data that proves its origin, identity, and integrity. Digital signatures are generated using cryptographic algorithms and are widely used for authentication and verification in secure communication.\",\"hash\":\"A hash function is a mathematical algorithm that takes an input (or 'message') and produces a fixed-size string of characters, which is typically a hash value. Hash functions are commonly used in various cryptographic applications, including data integrity verification and password hashing.\",\"pke\":\"Public Key Encryption (PKE) is a type of encryption that uses a pair of public and private keys for secure communication. The public key is used for encryption, while the private key is used for decryption. PKE is a fundamental component of public-key cryptography.\",\"xof\":\"An XOF is an extendable output function that can take arbitrary input and creates a stream of output, up to a limit determined by the size of the internal state of the hash function that underlies the XOF.\",\"kdf\":\"A Key Derivation Function (KDF) derives key material from another source of entropy while preserving the entropy of the input.\",\"key-agree\":\"In cryptography, a key-agreement is a protocol whereby two or more parties agree on a cryptographic key in such a way that both influence the outcome.\",\"kem\":\"A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for transporting random keying material to a recipient using the recipient's public key.\",\"ae\":\"Authenticated Encryption (AE) is a cryptographic process that provides both confidentiality and data integrity. It ensures that the encrypted data has not been tampered with and comes from a legitimate source. AE is commonly used in secure communication protocols.\",\"combiner\":\"A combiner aggregates many candidates for a cryptographic primitive and generates a new candidate for the same primitive.\",\"other\":\"Another primitive type.\",\"unknown\":\"The primitive is not known.\"}},\"parameterSetIdentifier\":{\"type\":\"string\",\"title\":\"Parameter Set Identifier\",\"description\":\"An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205).\"},\"curve\":{\"type\":\"string\",\"title\":\"Elliptic Curve\",\"description\":\"The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends using curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source of which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves).\"},\"executionEnvironment\":{\"type\":\"string\",\"title\":\"Execution Environment\",\"description\":\"The target and execution environment in which the algorithm is implemented in.\",\"enum\":[\"software-plain-ram\",\"software-encrypted-ram\",\"software-tee\",\"hardware\",\"other\",\"unknown\"],\"meta:enum\":{\"software-plain-ram\":\"A software implementation running in plain unencrypted RAM.\",\"software-encrypted-ram\":\"A software implementation running in encrypted RAM.\",\"software-tee\":\"A software implementation running in a trusted execution environment.\",\"hardware\":\"A hardware implementation.\",\"other\":\"Another implementation environment.\",\"unknown\":\"The execution environment is not known.\"}},\"implementationPlatform\":{\"type\":\"string\",\"title\":\"Implementation platform\",\"description\":\"The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.\",\"enum\":[\"generic\",\"x86_32\",\"x86_64\",\"armv7-a\",\"armv7-m\",\"armv8-a\",\"armv8-m\",\"armv9-a\",\"armv9-m\",\"s390x\",\"ppc64\",\"ppc64le\",\"other\",\"unknown\"]},\"certificationLevel\":{\"type\":\"array\",\"title\":\"Certification Level\",\"description\":\"The certification that the implementation of the cryptographic algorithm has received, if any. Certifications include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).\",\"items\":{\"type\":\"string\",\"enum\":[\"none\",\"fips140-1-l1\",\"fips140-1-l2\",\"fips140-1-l3\",\"fips140-1-l4\",\"fips140-2-l1\",\"fips140-2-l2\",\"fips140-2-l3\",\"fips140-2-l4\",\"fips140-3-l1\",\"fips140-3-l2\",\"fips140-3-l3\",\"fips140-3-l4\",\"cc-eal1\",\"cc-eal1+\",\"cc-eal2\",\"cc-eal2+\",\"cc-eal3\",\"cc-eal3+\",\"cc-eal4\",\"cc-eal4+\",\"cc-eal5\",\"cc-eal5+\",\"cc-eal6\",\"cc-eal6+\",\"cc-eal7\",\"cc-eal7+\",\"other\",\"unknown\"],\"meta:enum\":{\"none\":\"No certification obtained\",\"fips140-1-l1\":\"FIPS 140-1 Level 1\",\"fips140-1-l2\":\"FIPS 140-1 Level 2\",\"fips140-1-l3\":\"FIPS 140-1 Level 3\",\"fips140-1-l4\":\"FIPS 140-1 Level 4\",\"fips140-2-l1\":\"FIPS 140-2 Level 1\",\"fips140-2-l2\":\"FIPS 140-2 Level 2\",\"fips140-2-l3\":\"FIPS 140-2 Level 3\",\"fips140-2-l4\":\"FIPS 140-2 Level 4\",\"fips140-3-l1\":\"FIPS 140-3 Level 1\",\"fips140-3-l2\":\"FIPS 140-3 Level 2\",\"fips140-3-l3\":\"FIPS 140-3 Level 3\",\"fips140-3-l4\":\"FIPS 140-3 Level 4\",\"cc-eal1\":\"Common Criteria - Evaluation Assurance Level 1\",\"cc-eal1+\":\"Common Criteria - Evaluation Assurance Level 1 (Augmented)\",\"cc-eal2\":\"Common Criteria - Evaluation Assurance Level 2\",\"cc-eal2+\":\"Common Criteria - Evaluation Assurance Level 2 (Augmented)\",\"cc-eal3\":\"Common Criteria - Evaluation Assurance Level 3\",\"cc-eal3+\":\"Common Criteria - Evaluation Assurance Level 3 (Augmented)\",\"cc-eal4\":\"Common Criteria - Evaluation Assurance Level 4\",\"cc-eal4+\":\"Common Criteria - Evaluation Assurance Level 4 (Augmented)\",\"cc-eal5\":\"Common Criteria - Evaluation Assurance Level 5\",\"cc-eal5+\":\"Common Criteria - Evaluation Assurance Level 5 (Augmented)\",\"cc-eal6\":\"Common Criteria - Evaluation Assurance Level 6\",\"cc-eal6+\":\"Common Criteria - Evaluation Assurance Level 6 (Augmented)\",\"cc-eal7\":\"Common Criteria - Evaluation Assurance Level 7\",\"cc-eal7+\":\"Common Criteria - Evaluation Assurance Level 7 (Augmented)\",\"other\":\"Another certification\",\"unknown\":\"The certification level is not known\"}}},\"mode\":{\"type\":\"string\",\"title\":\"Mode\",\"description\":\"The mode of operation in which the cryptographic algorithm (block cipher) is used.\",\"enum\":[\"cbc\",\"ecb\",\"ccm\",\"gcm\",\"cfb\",\"ofb\",\"ctr\",\"other\",\"unknown\"],\"meta:enum\":{\"cbc\":\"Cipher block chaining\",\"ecb\":\"Electronic codebook\",\"ccm\":\"Counter with cipher block chaining message authentication code\",\"gcm\":\"Galois/counter\",\"cfb\":\"Cipher feedback\",\"ofb\":\"Output feedback\",\"ctr\":\"Counter\",\"other\":\"Another mode of operation\",\"unknown\":\"The mode of operation is not known\"}},\"padding\":{\"type\":\"string\",\"title\":\"Padding\",\"description\":\"The padding scheme that is used for the cryptographic algorithm.\",\"enum\":[\"pkcs5\",\"pkcs7\",\"pkcs1v15\",\"oaep\",\"raw\",\"other\",\"unknown\"],\"meta:enum\":{\"pkcs5\":\"Public Key Cryptography Standard: Password-Based Cryptography\",\"pkcs7\":\"Public Key Cryptography Standard: Cryptographic Message Syntax\",\"pkcs1v15\":\"Public Key Cryptography Standard: RSA Cryptography v1.5\",\"oaep\":\"Optimal asymmetric encryption padding\",\"raw\":\"Raw\",\"other\":\"Another padding scheme\",\"unknown\":\"The padding scheme is not known\"}},\"cryptoFunctions\":{\"type\":\"array\",\"title\":\"Cryptographic functions\",\"description\":\"The cryptographic functions implemented by the cryptographic algorithm.\",\"items\":{\"type\":\"string\",\"enum\":[\"generate\",\"keygen\",\"encrypt\",\"decrypt\",\"digest\",\"tag\",\"keyderive\",\"sign\",\"verify\",\"encapsulate\",\"decapsulate\",\"other\",\"unknown\"]}},\"classicalSecurityLevel\":{\"type\":\"integer\",\"title\":\"classical security level\",\"description\":\"The classical security level that a cryptographic algorithm provides (in bits).\",\"minimum\":0},\"nistQuantumSecurityLevel\":{\"type\":\"integer\",\"title\":\"NIST security strength category\",\"description\":\"The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). A value of 0 indicates that none of the categories are met.\",\"minimum\":0,\"maximum\":6}}},\"certificateProperties\":{\"type\":\"object\",\"title\":\"Certificate Properties\",\"description\":\"Properties for cryptographic assets of asset type 'certificate'\",\"additionalProperties\":false,\"properties\":{\"subjectName\":{\"type\":\"string\",\"title\":\"Subject Name\",\"description\":\"The subject name for the certificate\"},\"issuerName\":{\"type\":\"string\",\"title\":\"Issuer Name\",\"description\":\"The issuer name for the certificate\"},\"notValidBefore\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Not Valid Before\",\"description\":\"The date and time according to ISO-8601 standard from which the certificate is valid\"},\"notValidAfter\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Not Valid After\",\"description\":\"The date and time according to ISO-8601 standard from which the certificate is not valid anymore\"},\"signatureAlgorithmRef\":{\"$ref\":\"#/definitions/refType\",\"title\":\"Algorithm Reference\",\"description\":\"The bom-ref to signature algorithm used by the certificate\"},\"subjectPublicKeyRef\":{\"$ref\":\"#/definitions/refType\",\"title\":\"Key reference\",\"description\":\"The bom-ref to the public key of the subject\"},\"certificateFormat\":{\"type\":\"string\",\"title\":\"Certificate Format\",\"description\":\"The format of the certificate\",\"examples\":[\"X.509\",\"PEM\",\"DER\",\"CVC\"]},\"certificateExtension\":{\"type\":\"string\",\"title\":\"Certificate File Extension\",\"description\":\"The file extension of the certificate\",\"examples\":[\"crt\",\"pem\",\"cer\",\"der\",\"p12\"]}}},\"relatedCryptoMaterialProperties\":{\"type\":\"object\",\"title\":\"Related Cryptographic Material Properties\",\"description\":\"Properties for cryptographic assets of asset type: `related-crypto-material`\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"relatedCryptoMaterialType\",\"description\":\"The type for the related cryptographic material\",\"enum\":[\"private-key\",\"public-key\",\"secret-key\",\"key\",\"ciphertext\",\"signature\",\"digest\",\"initialization-vector\",\"nonce\",\"seed\",\"salt\",\"shared-secret\",\"tag\",\"additional-data\",\"password\",\"credential\",\"token\",\"other\",\"unknown\"],\"meta:enum\":{\"private-key\":\"The confidential key of a key pair used in asymmetric cryptography.\",\"public-key\":\"The non-confidential key of a key pair used in asymmetric cryptography.\",\"secret-key\":\"A key used to encrypt and decrypt messages in symmetric cryptography.\",\"key\":\"A piece of information, usually an octet string, which, when processed through a cryptographic algorithm, processes cryptographic data.\",\"ciphertext\":\"The result of encryption performed on plaintext using an algorithm (or cipher).\",\"signature\":\"A cryptographic value that is calculated from the data and a key known only by the signer.\",\"digest\":\"The output of the hash function.\",\"initialization-vector\":\"A fixed-size random or pseudo-random value used as an input parameter for cryptographic algorithms.\",\"nonce\":\"A random or pseudo-random number that can only be used once in a cryptographic communication.\",\"seed\":\"The input to a pseudo-random number generator. Different seeds generate different pseudo-random sequences.\",\"salt\":\"A value used in a cryptographic process, usually to ensure that the results of computations for one instance cannot be reused by an attacker.\",\"shared-secret\":\"A piece of data known only to the parties involved, in a secure communication.\",\"tag\":\"A message authentication code (MAC), sometimes known as an authentication tag, is a short piece of information used for authenticating and integrity-checking a message.\",\"additional-data\":\"An unspecified collection of data with relevance to cryptographic activity.\",\"password\":\"A secret word, phrase, or sequence of characters used during authentication or authorization.\",\"credential\":\"Establishes the identity of a party to communication, usually in the form of cryptographic keys or passwords.\",\"token\":\"An object encapsulating a security identity.\",\"other\":\"Another type of cryptographic asset.\",\"unknown\":\"The type of cryptographic asset is not known.\"}},\"id\":{\"type\":\"string\",\"title\":\"ID\",\"description\":\"The optional unique identifier for the related cryptographic material.\"},\"state\":{\"type\":\"string\",\"title\":\"State\",\"description\":\"The key state as defined by NIST SP 800-57.\",\"enum\":[\"pre-activation\",\"active\",\"suspended\",\"deactivated\",\"compromised\",\"destroyed\"]},\"algorithmRef\":{\"$ref\":\"#/definitions/refType\",\"title\":\"Algorithm Reference\",\"description\":\"The bom-ref to the algorithm used to generate the related cryptographic material.\"},\"creationDate\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Creation Date\",\"description\":\"The date and time (timestamp) when the related cryptographic material was created.\"},\"activationDate\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Activation Date\",\"description\":\"The date and time (timestamp) when the related cryptographic material was activated.\"},\"updateDate\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Update Date\",\"description\":\"The date and time (timestamp) when the related cryptographic material was updated.\"},\"expirationDate\":{\"type\":\"string\",\"format\":\"date-time\",\"title\":\"Expiration Date\",\"description\":\"The date and time (timestamp) when the related cryptographic material expires.\"},\"value\":{\"type\":\"string\",\"title\":\"Value\",\"description\":\"The associated value of the cryptographic material.\"},\"size\":{\"type\":\"integer\",\"title\":\"Size\",\"description\":\"The size of the cryptographic asset (in bits).\"},\"format\":{\"type\":\"string\",\"title\":\"Format\",\"description\":\"The format of the related cryptographic material (e.g. P8, PEM, DER).\"},\"securedBy\":{\"$ref\":\"#/definitions/securedBy\",\"title\":\"Secured By\",\"description\":\"The mechanism by which the cryptographic asset is secured by.\"}}},\"protocolProperties\":{\"type\":\"object\",\"title\":\"Protocol Properties\",\"description\":\"Properties specific to cryptographic assets of type: `protocol`.\",\"additionalProperties\":false,\"properties\":{\"type\":{\"type\":\"string\",\"title\":\"Type\",\"description\":\"The concrete protocol type.\",\"enum\":[\"tls\",\"ssh\",\"ipsec\",\"ike\",\"sstp\",\"wpa\",\"other\",\"unknown\"],\"meta:enum\":{\"tls\":\"Transport Layer Security\",\"ssh\":\"Secure Shell\",\"ipsec\":\"Internet Protocol Security\",\"ike\":\"Internet Key Exchange\",\"sstp\":\"Secure Socket Tunneling Protocol\",\"wpa\":\"Wi-Fi Protected Access\",\"other\":\"Another protocol type\",\"unknown\":\"The protocol type is not known\"}},\"version\":{\"type\":\"string\",\"title\":\"Protocol Version\",\"description\":\"The version of the protocol.\",\"examples\":[\"1.0\",\"1.2\",\"1.99\"]},\"cipherSuites\":{\"type\":\"array\",\"title\":\"Cipher Suites\",\"description\":\"A list of cipher suites related to the protocol.\",\"items\":{\"$ref\":\"#/definitions/cipherSuite\",\"title\":\"Cipher Suite\"}},\"ikev2TransformTypes\":{\"type\":\"object\",\"title\":\"IKEv2 Transform Types\",\"description\":\"The IKEv2 transform types supported (types 1-4), defined in [RFC 7296 section 3.3.2](https://www.ietf.org/rfc/rfc7296.html#section-3.3.2), and additional properties.\",\"additionalProperties\":false,\"properties\":{\"encr\":{\"$ref\":\"#/definitions/cryptoRefArray\",\"title\":\"Encryption Algorithm (ENCR)\",\"description\":\"Transform Type 1: encryption algorithms\"},\"prf\":{\"$ref\":\"#/definitions/cryptoRefArray\",\"title\":\"Pseudorandom Function (PRF)\",\"description\":\"Transform Type 2: pseudorandom functions\"},\"integ\":{\"$ref\":\"#/definitions/cryptoRefArray\",\"title\":\"Integrity Algorithm (INTEG)\",\"description\":\"Transform Type 3: integrity algorithms\"},\"ke\":{\"$ref\":\"#/definitions/cryptoRefArray\",\"title\":\"Key Exchange Method (KE)\",\"description\":\"Transform Type 4: Key Exchange Method (KE) per [RFC 9370](https://www.ietf.org/rfc/rfc9370.html), formerly called Diffie-Hellman Group (D-H).\"},\"esn\":{\"type\":\"boolean\",\"title\":\"Extended Sequence Numbers (ESN)\",\"description\":\"Specifies if an Extended Sequence Number (ESN) is used.\"},\"auth\":{\"$ref\":\"#/definitions/cryptoRefArray\",\"title\":\"IKEv2 Authentication method\",\"description\":\"IKEv2 Authentication method\"}}},\"cryptoRefArray\":{\"$ref\":\"#/definitions/cryptoRefArray\",\"title\":\"Cryptographic References\",\"description\":\"A list of protocol-related cryptographic assets\"}}},\"oid\":{\"type\":\"string\",\"title\":\"OID\",\"description\":\"The object identifier (OID) of the cryptographic asset.\"}}},\"cipherSuite\":{\"type\":\"object\",\"title\":\"Cipher Suite\",\"description\":\"Object representing a cipher suite\",\"additionalProperties\":false,\"properties\":{\"name\":{\"type\":\"string\",\"title\":\"Common Name\",\"description\":\"A common name for the cipher suite.\",\"examples\":[\"TLS_DHE_RSA_WITH_AES_128_CCM\"]},\"algorithms\":{\"type\":\"array\",\"title\":\"Related Algorithms\",\"description\":\"A list of algorithms related to the cipher suite.\",\"items\":{\"$ref\":\"#/definitions/refType\",\"title\":\"Algorithm reference\",\"description\":\"The bom-ref to algorithm cryptographic asset.\"}},\"identifiers\":{\"type\":\"array\",\"title\":\"Cipher Suite Identifiers\",\"description\":\"A list of common identifiers for the cipher suite.\",\"items\":{\"type\":\"string\",\"title\":\"identifier\",\"description\":\"Cipher suite identifier\",\"examples\":[\"0xC0\",\"0x9E\"]}}}},\"cryptoRefArray\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/refType\"}},\"securedBy\":{\"type\":\"object\",\"title\":\"Secured By\",\"description\":\"Specifies the mechanism by which the cryptographic asset is secured by\",\"additionalProperties\":false,\"properties\":{\"mechanism\":{\"type\":\"string\",\"title\":\"Mechanism\",\"description\":\"Specifies the mechanism by which the cryptographic asset is secured by.\",\"examples\":[\"HSM\",\"TPM\",\"SGX\",\"Software\",\"None\"]},\"algorithmRef\":{\"$ref\":\"#/definitions/refType\",\"title\":\"Algorithm Reference\",\"description\":\"The bom-ref to the algorithm.\"}}},\"tags\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"title\":\"Tags\",\"description\":\"Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.\",\"examples\":[\"json-parser\",\"object-persistence\",\"text-to-image\",\"translation\",\"object-detection\"]}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"CycloneDX Bill of Materials Standard\". Here are the required top‑level fields: bomFormat, specVersion. Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"http://cyclonedx.org/schema/bom-1.6.schema.json","type":"object","title":"CycloneDX Bill of Materials Standard","$comment":"CycloneDX JSON schema is published under the terms of the Apache License 2.0.","required":["bomFormat","specVersion"],"additionalProperties":false,"properties":{"$schema":{"type":"string"},"bomFormat":{"type":"string","title":"BOM Format","description":"Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOMs do not have a filename convention, nor does JSON schema support namespaces. This value must be \"CycloneDX\".","enum":["CycloneDX"]},"specVersion":{"type":"string","title":"CycloneDX Specification Version","description":"The version of the CycloneDX specification the BOM conforms to.","examples":["1.6"]},"serialNumber":{"type":"string","title":"BOM Serial Number","description":"Every BOM generated SHOULD have a unique serial number, even if the contents of the BOM have not changed over time. If specified, the serial number must conform to [RFC 4122](https://www.ietf.org/rfc/rfc4122.html). Use of serial numbers is recommended.","examples":["urn:uuid:3e671687-395b-41f5-a30f-a58921a69b79"],"pattern":"^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"version":{"type":"integer","title":"BOM Version","description":"Whenever an existing BOM is modified, either manually or through automated processes, the version of the BOM SHOULD be incremented by 1. When a system is presented with multiple BOMs with identical serial numbers, the system SHOULD use the most recent version of the BOM. The default version is '1'.","minimum":1,"default":1,"examples":[1]},"metadata":{"$ref":"#/definitions/metadata","title":"BOM Metadata","description":"Provides additional information about a BOM."},"components":{"type":"array","items":{"$ref":"#/definitions/component"},"uniqueItems":true,"title":"Components","description":"A list of software and hardware components."},"services":{"type":"array","items":{"$ref":"#/definitions/service"},"uniqueItems":true,"title":"Services","description":"A list of services. This may include microservices, function-as-a-service, and other types of network or intra-process services."},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."},"dependencies":{"type":"array","items":{"$ref":"#/definitions/dependency"},"uniqueItems":true,"title":"Dependencies","description":"Provides the ability to document dependency relationships including provided & implemented components."},"compositions":{"type":"array","items":{"$ref":"#/definitions/compositions"},"uniqueItems":true,"title":"Compositions","description":"Compositions describe constituent parts (including components, services, and dependency relationships) and their completeness. The completeness of vulnerabilities expressed in a BOM may also be described."},"vulnerabilities":{"type":"array","items":{"$ref":"#/definitions/vulnerability"},"uniqueItems":true,"title":"Vulnerabilities","description":"Vulnerabilities identified in components or services."},"annotations":{"type":"array","items":{"$ref":"#/definitions/annotations"},"uniqueItems":true,"title":"Annotations","description":"Comments made by people, organizations, or tools about any object with a bom-ref, such as components, services, vulnerabilities, or the BOM itself. Unlike inventory information, annotations may contain opinions or commentary from various stakeholders. Annotations may be inline (with inventory) or externalized via BOM-Link and may optionally be signed."},"formulation":{"type":"array","items":{"$ref":"#/definitions/formula"},"uniqueItems":true,"title":"Formulation","description":"Describes how a component or service was manufactured or deployed. This is achieved through the use of formulas, workflows, tasks, and steps, which declare the precise steps to reproduce along with the observed formulas describing the steps which transpired in the manufacturing process."},"declarations":{"type":"object","title":"Declarations","description":"The list of declarations which describe the conformance to standards. Each declaration may include attestations, claims, and evidence.","additionalProperties":false,"properties":{"assessors":{"type":"array","title":"Assessors","description":"The list of assessors evaluating claims and determining conformance to requirements and confidence in that assessment.","items":{"type":"object","title":"Assessor","description":"The assessor who evaluates claims and determines conformance to requirements and confidence in that assessment.","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."},"thirdParty":{"type":"boolean","title":"Third Party","description":"The boolean indicating if the assessor is outside the organization generating claims. A value of false indicates a self assessor."},"organization":{"$ref":"#/definitions/organizationalEntity","title":"Organization","description":"The entity issuing the assessment."}}}},"attestations":{"type":"array","title":"Attestations","description":"The list of attestations asserted by an assessor that maps requirements to claims.","items":{"type":"object","title":"Attestation","additionalProperties":false,"properties":{"summary":{"type":"string","title":"Summary","description":"The short description explaining the main points of the attestation."},"assessor":{"$ref":"#/definitions/refLinkType","title":"Assessor","description":"The `bom-ref` to the assessor asserting the attestation."},"map":{"type":"array","title":"Map","description":"The grouping of requirements to claims and the attestors declared conformance and confidence thereof.","items":{"type":"object","title":"Map","additionalProperties":false,"properties":{"requirement":{"$ref":"#/definitions/refLinkType","title":"Requirement","description":"The `bom-ref` to the requirement being attested to."},"claims":{"type":"array","title":"Claims","description":"The list of `bom-ref` to the claims being attested to.","items":{"$ref":"#/definitions/refLinkType"}},"counterClaims":{"type":"array","title":"Counter Claims","description":"The list of `bom-ref` to the counter claims being attested to.","items":{"$ref":"#/definitions/refLinkType"}},"conformance":{"type":"object","title":"Conformance","description":"The conformance of the claim meeting a requirement.","additionalProperties":false,"properties":{"score":{"type":"number","minimum":0,"maximum":1,"title":"Score","description":"The conformance of the claim between and inclusive of 0 and 1, where 1 is 100% conformance."},"rationale":{"type":"string","title":"Rationale","description":"The rationale for the conformance score."},"mitigationStrategies":{"type":"array","title":"Mitigation Strategies","description":"The list of `bom-ref` to the evidence provided describing the mitigation strategies.","items":{"$ref":"#/definitions/refLinkType"}}}},"confidence":{"type":"object","title":"Confidence","description":"The confidence of the claim meeting the requirement.","additionalProperties":false,"properties":{"score":{"type":"number","minimum":0,"maximum":1,"title":"Score","description":"The confidence of the claim between and inclusive of 0 and 1, where 1 is 100% confidence."},"rationale":{"type":"string","title":"Rationale","description":"The rationale for the confidence score."}}}}}},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}}},"claims":{"type":"array","title":"Claims","description":"The list of claims.","items":{"type":"object","title":"Claim","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."},"target":{"$ref":"#/definitions/refLinkType","title":"Target","description":"The `bom-ref` to a target representing a specific system, application, API, module, team, person, process, business unit, company, etc... that this claim is being applied to."},"predicate":{"type":"string","title":"Predicate","description":"The specific statement or assertion about the target."},"mitigationStrategies":{"type":"array","title":"Mitigation Strategies","description":"The list of `bom-ref` to the evidence provided describing the mitigation strategies. Each mitigation strategy should include an explanation of how any weaknesses in the evidence will be mitigated.","items":{"$ref":"#/definitions/refLinkType"}},"reasoning":{"type":"string","title":"Reasoning","description":"The written explanation of why the evidence provided substantiates the claim."},"evidence":{"type":"array","title":"Evidence","description":"The list of `bom-ref` to evidence that supports this claim.","items":{"$ref":"#/definitions/refLinkType"}},"counterEvidence":{"type":"array","title":"Counter Evidence","description":"The list of `bom-ref` to counterEvidence that supports this claim.","items":{"$ref":"#/definitions/refLinkType"}},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}}},"evidence":{"type":"array","title":"Evidence","description":"The list of evidence","items":{"type":"object","title":"Evidence","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."},"propertyName":{"type":"string","title":"Property Name","description":"The reference to the property name as defined in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy/)."},"description":{"type":"string","title":"Description","description":"The written description of what this evidence is and how it was created."},"data":{"type":"array","title":"Data","description":"The output or analysis that supports claims.","items":{"type":"object","title":"Data","additionalProperties":false,"properties":{"name":{"title":"Data Name","description":"The name of the data.","type":"string"},"contents":{"type":"object","title":"Data Contents","description":"The contents or references to the contents of the data being described.","additionalProperties":false,"properties":{"attachment":{"title":"Data Attachment","description":"An optional way to include textual or encoded data.","$ref":"#/definitions/attachment"},"url":{"type":"string","title":"Data URL","description":"The URL to where the data can be retrieved.","format":"iri-reference"}}},"classification":{"$ref":"#/definitions/dataClassification"},"sensitiveData":{"type":"array","title":"Sensitive Data","description":"A description of any sensitive data included.","items":{"type":"string"}},"governance":{"title":"Data Governance","$ref":"#/definitions/dataGovernance"}}}},"created":{"type":"string","format":"date-time","title":"Created","description":"The date and time (timestamp) when the evidence was created."},"expires":{"type":"string","format":"date-time","title":"Expires","description":"The optional date and time (timestamp) when the evidence is no longer valid."},"author":{"$ref":"#/definitions/organizationalContact","title":"Author","description":"The author of the evidence."},"reviewer":{"$ref":"#/definitions/organizationalContact","title":"Reviewer","description":"The reviewer of the evidence."},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}}},"targets":{"type":"object","title":"Targets","description":"The list of targets which claims are made against.","additionalProperties":false,"properties":{"organizations":{"type":"array","title":"Organizations","description":"The list of organizations which claims are made against.","items":{"$ref":"#/definitions/organizationalEntity"}},"components":{"type":"array","title":"Components","description":"The list of components which claims are made against.","items":{"$ref":"#/definitions/component"}},"services":{"type":"array","title":"Services","description":"The list of services which claims are made against.","items":{"$ref":"#/definitions/service"}}}},"affirmation":{"type":"object","title":"Affirmation","description":"A concise statement affirmed by an individual regarding all declarations, often used for third-party auditor acceptance or recipient acknowledgment. It includes a list of authorized signatories who assert the validity of the document on behalf of the organization.","additionalProperties":false,"properties":{"statement":{"type":"string","title":"Statement","description":"The brief statement affirmed by an individual regarding all declarations.\n*- Notes This could be an affirmation of acceptance by a third-party auditor or receiving individual of a file.","examples":["I certify, to the best of my knowledge, that all information is correct."]},"signatories":{"type":"array","title":"Signatories","description":"The list of signatories authorized on behalf of an organization to assert validity of this document.","items":{"type":"object","title":"Signatory","additionalProperties":false,"oneOf":[{"required":["signature"]},{"required":["externalReference","organization"]}],"properties":{"name":{"type":"string","title":"Name","description":"The signatory's name."},"role":{"type":"string","title":"Role","description":"The signatory's role within an organization."},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."},"organization":{"$ref":"#/definitions/organizationalEntity","title":"Organization","description":"The signatory's organization."},"externalReference":{"$ref":"#/definitions/externalReference","title":"External Reference","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."}}}},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"definitions":{"type":"object","title":"Definitions","description":"A collection of reusable objects that are defined and may be used elsewhere in the BOM.","additionalProperties":false,"properties":{"standards":{"type":"array","title":"Standards","description":"The list of standards which may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.","items":{"$ref":"#/definitions/standard"}}}},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}},"definitions":{"refType":{"description":"Identifier for referable and therefore interlinkable elements.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","type":"string","minLength":1,"$comment":"TODO (breaking change): add a format constraint that prevents the value from staring with 'urn:cdx:'"},"refLinkType":{"description":"Descriptor for an element identified by the attribute 'bom-ref' in the same BOM document.\nIn contrast to `bomLinkElementType`.","$ref":"#/definitions/refType"},"bomLinkDocumentType":{"title":"BOM-Link Document","description":"Descriptor for another BOM document. See https://cyclonedx.org/capabilities/bomlink/","type":"string","format":"iri-reference","pattern":"^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*$","$comment":"part of the pattern is based on `bom.serialNumber`'s pattern"},"bomLinkElementType":{"title":"BOM-Link Element","description":"Descriptor for an element in a BOM document. See https://cyclonedx.org/capabilities/bomlink/","type":"string","format":"iri-reference","pattern":"^urn:cdx:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/[1-9][0-9]*#.+$","$comment":"part of the pattern is based on `bom.serialNumber`'s pattern"},"bomLink":{"title":"BOM-Link","anyOf":[{"title":"BOM-Link Document","$ref":"#/definitions/bomLinkDocumentType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"metadata":{"type":"object","title":"BOM Metadata","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The date and time (timestamp) when the BOM was created."},"lifecycles":{"type":"array","title":"Lifecycles","description":"Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.","items":{"type":"object","title":"Lifecycle","description":"The product lifecycle(s) that this BOM represents.","oneOf":[{"title":"Pre-Defined Phase","required":["phase"],"additionalProperties":false,"properties":{"phase":{"type":"string","title":"Phase","description":"A pre-defined phase in the product lifecycle.","enum":["design","pre-build","build","post-build","operations","discovery","decommission"],"meta:enum":{"design":"BOM produced early in the development lifecycle containing an inventory of components and services that are proposed or planned to be used. The inventory may need to be procured, retrieved, or resourced prior to use.","pre-build":"BOM consisting of information obtained prior to a build process and may contain source files and development artifacts and manifests. The inventory may need to be resolved and retrieved prior to use.","build":"BOM consisting of information obtained during a build process where component inventory is available for use. The precise versions of resolved components are usually available at this time as well as the provenance of where the components were retrieved from.","post-build":"BOM consisting of information obtained after a build process has completed and the resulting components(s) are available for further analysis. Built components may exist as the result of a CI/CD process, may have been installed or deployed to a system or device, and may need to be retrieved or extracted from the system or device.","operations":"BOM produced that represents inventory that is running and operational. This may include staging or production environments and will generally encompass multiple SBOMs describing the applications and operating system, along with HBOMs describing the hardware that makes up the system. Operations Bill of Materials (OBOM) can provide full-stack inventory of runtime environments, configurations, and additional dependencies.","discovery":"BOM consisting of information observed through network discovery providing point-in-time enumeration of embedded, on-premise, and cloud-native services such as server applications, connected devices, microservices, and serverless functions.","decommission":"BOM containing inventory that will be, or has been retired from operations."}}}},{"title":"Custom Phase","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","title":"Name","description":"The name of the lifecycle phase"},"description":{"type":"string","title":"Description","description":"The description of the lifecycle phase"}}}]}},"tools":{"title":"Tools","description":"The tool(s) used in the creation, enrichment, and validation of the BOM.","oneOf":[{"type":"object","title":"Tools","description":"The tool(s) used in the creation, enrichment, and validation of the BOM.","additionalProperties":false,"properties":{"components":{"type":"array","items":{"$ref":"#/definitions/component"},"uniqueItems":true,"title":"Components","description":"A list of software and hardware components used as tools."},"services":{"type":"array","items":{"$ref":"#/definitions/service"},"uniqueItems":true,"title":"Services","description":"A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services."}}},{"type":"array","title":"Tools (legacy)","description":"[Deprecated] The tool(s) used in the creation, enrichment, and validation of the BOM.","items":{"$ref":"#/definitions/tool"}}]},"manufacturer":{"title":"BOM Manufacturer","description":"The organization that created the BOM.\nManufacturer is common in BOMs created through automated processes. BOMs created through manual means may have `@.authors` instead.","$ref":"#/definitions/organizationalEntity"},"authors":{"type":"array","title":"BOM Authors","description":"The person(s) who created the BOM.\nAuthors are common in BOMs created through manual processes. BOMs created through automated means may have `@.manufacturer` instead.","items":{"$ref":"#/definitions/organizationalContact"}},"component":{"title":"Component","description":"The component that the BOM describes.","$ref":"#/definitions/component"},"manufacture":{"deprecated":true,"title":"Component Manufacture (legacy)","description":"[Deprecated] This will be removed in a future version. Use the `@.component.manufacturer` instead.\nThe organization that manufactured the component that the BOM describes.","$ref":"#/definitions/organizationalEntity"},"supplier":{"title":"Supplier","description":" The organization that supplied the component that the BOM describes. The supplier may often be the manufacturer, but may also be a distributor or repackager.","$ref":"#/definitions/organizationalEntity"},"licenses":{"title":"BOM License(s)","description":"The license information for the BOM document.\nThis may be different from the license(s) of the component(s) that the BOM describes.","$ref":"#/definitions/licenseChoice"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"tool":{"type":"object","title":"Tool","description":"[Deprecated] This will be removed in a future version. Use component or service instead. Information about the automated or manual tool used","additionalProperties":false,"properties":{"vendor":{"type":"string","title":"Tool Vendor","description":"The name of the vendor who created the tool"},"name":{"type":"string","title":"Tool Name","description":"The name of the tool"},"version":{"$ref":"#/definitions/version","title":"Tool Version","description":"The version of the tool"},"hashes":{"type":"array","items":{"$ref":"#/definitions/hash"},"title":"Hashes","description":"The hashes of the tool (if applicable)."},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."}}},"organizationalEntity":{"type":"object","title":"Organizational Entity","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"name":{"type":"string","title":"Organization Name","description":"The name of the organization","examples":["Example Inc."]},"address":{"$ref":"#/definitions/postalAddress","title":"Organization Address","description":"The physical address (location) of the organization"},"url":{"type":"array","items":{"type":"string","format":"iri-reference"},"title":"Organization URL(s)","description":"The URL of the organization. Multiple URLs are allowed.","examples":["https://example.com"]},"contact":{"type":"array","title":"Organizational Contact","description":"A contact at the organization. Multiple contacts are allowed.","items":{"$ref":"#/definitions/organizationalContact"}}}},"organizationalContact":{"type":"object","title":"Organizational Contact","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"name":{"type":"string","title":"Name","description":"The name of a contact","examples":["Contact name"]},"email":{"type":"string","format":"idn-email","title":"Email Address","description":"The email address of the contact.","examples":["[email protected]"]},"phone":{"type":"string","title":"Phone","description":"The phone number of the contact.","examples":["800-555-1212"]}}},"component":{"type":"object","title":"Component","required":["type","name"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["application","framework","library","container","platform","operating-system","device","device-driver","firmware","file","machine-learning-model","data","cryptographic-asset"],"meta:enum":{"application":"A software application. Refer to [https://en.wikipedia.org/wiki/Application_software](https://en.wikipedia.org/wiki/Application_software) for information about applications.","framework":"A software framework. Refer to [https://en.wikipedia.org/wiki/Software_framework](https://en.wikipedia.org/wiki/Software_framework) for information on how frameworks vary slightly from libraries.","library":"A software library. Refer to [https://en.wikipedia.org/wiki/Library_(computing)](https://en.wikipedia.org/wiki/Library_(computing)) for information about libraries. All third-party and open source reusable components will likely be a library. If the library also has key features of a framework, then it should be classified as a framework. If not, or is unknown, then specifying library is recommended.","container":"A packaging and/or runtime format, not specific to any particular technology, which isolates software inside the container from software outside of a container through virtualization technology. Refer to [https://en.wikipedia.org/wiki/OS-level_virtualization](https://en.wikipedia.org/wiki/OS-level_virtualization).","platform":"A runtime environment which interprets or executes software. This may include runtimes such as those that execute bytecode or low-code/no-code application platforms.","operating-system":"A software operating system without regard to deployment model (i.e. installed on physical hardware, virtual machine, image, etc) Refer to [https://en.wikipedia.org/wiki/Operating_system](https://en.wikipedia.org/wiki/Operating_system).","device":"A hardware device such as a processor or chip-set. A hardware device containing firmware SHOULD include a component for the physical hardware itself and another component of type 'firmware' or 'operating-system' (whichever is relevant), describing information about the software running on the device. See also the list of [known device properties](https://github.com/CycloneDX/cyclonedx-property-taxonomy/blob/main/cdx/device.md).","device-driver":"A special type of software that operates or controls a particular type of device. Refer to [https://en.wikipedia.org/wiki/Device_driver](https://en.wikipedia.org/wiki/Device_driver).","firmware":"A special type of software that provides low-level control over a device's hardware. Refer to [https://en.wikipedia.org/wiki/Firmware](https://en.wikipedia.org/wiki/Firmware).","file":"A computer file. Refer to [https://en.wikipedia.org/wiki/Computer_file](https://en.wikipedia.org/wiki/Computer_file) for information about files.","machine-learning-model":"A model based on training data that can make predictions or decisions without being explicitly programmed to do so.","data":"A collection of discrete values that convey information.","cryptographic-asset":"A cryptographic asset including algorithms, protocols, certificates, keys, tokens, and secrets."},"title":"Component Type","description":"Specifies the type of component. For software components, classify as application if no more specific appropriate classification is available or cannot be determined for the component.","examples":["library"]},"mime-type":{"type":"string","title":"Mime-Type","description":"The optional mime-type of the component. When used on file components, the mime-type can provide additional context about the kind of file being represented, such as an image, font, or executable. Some library or framework components may also have an associated mime-type.","examples":["image/jpeg"],"pattern":"^[-+a-z0-9.]+/[-+a-z0-9.]+$"},"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the component elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"supplier":{"title":"Component Supplier","description":" The organization that supplied the component. The supplier may often be the manufacturer, but may also be a distributor or repackager.","$ref":"#/definitions/organizationalEntity"},"manufacturer":{"title":"Component Manufacturer","description":"The organization that created the component.\nManufacturer is common in components created through automated processes. Components created through manual means may have `@.authors` instead.","$ref":"#/definitions/organizationalEntity"},"authors":{"type":"array","title":"Component Authors","description":"The person(s) who created the component.\nAuthors are common in components created through manual processes. Components created through automated means may have `@.manufacturer` instead.","items":{"$ref":"#/definitions/organizationalContact"}},"author":{"deprecated":true,"type":"string","title":"Component Author (legacy)","description":"[Deprecated] This will be removed in a future version. Use `@.authors` or `@.manufacturer` instead.\nThe person(s) or organization(s) that authored the component","examples":["Acme Inc"]},"publisher":{"type":"string","title":"Component Publisher","description":"The person(s) or organization(s) that published the component","examples":["Acme Inc"]},"group":{"type":"string","title":"Component Group","description":"The grouping name or identifier. This will often be a shortened, single name of the company or project that produced the component, or the source package or domain name. Whitespace and special characters should be avoided. Examples include: apache, org.apache.commons, and apache.org.","examples":["com.acme"]},"name":{"type":"string","title":"Component Name","description":"The name of the component. This will often be a shortened, single name of the component. Examples: commons-lang3 and jquery","examples":["tomcat-catalina"]},"version":{"$ref":"#/definitions/version","title":"Component Version","description":"The component version. The version should ideally comply with semantic versioning but is not enforced."},"description":{"type":"string","title":"Component Description","description":"Specifies a description for the component"},"scope":{"type":"string","enum":["required","optional","excluded"],"meta:enum":{"required":"The component is required for runtime","optional":"The component is optional at runtime. Optional components are components that are not capable of being called due to them not being installed or otherwise accessible by any means. Components that are installed but due to configuration or other restrictions are prohibited from being called must be scoped as 'required'.","excluded":"Components that are excluded provide the ability to document component usage for test and other non-runtime purposes. Excluded components are not reachable within a call graph at runtime."},"title":"Component Scope","description":"Specifies the scope of the component. If scope is not specified, 'required' scope SHOULD be assumed by the consumer of the BOM.","default":"required"},"hashes":{"type":"array","title":"Component Hashes","description":"The hashes of the component.","items":{"$ref":"#/definitions/hash"}},"licenses":{"$ref":"#/definitions/licenseChoice","title":"Component License(s)"},"copyright":{"type":"string","title":"Component Copyright","description":"A copyright notice informing users of the underlying claims to copyright ownership in a published work.","examples":["Acme Inc"]},"cpe":{"type":"string","title":"Common Platform Enumeration (CPE)","description":"Asserts the identity of the component using CPE. The CPE must conform to the CPE 2.2 or 2.3 specification. See [https://nvd.nist.gov/products/cpe](https://nvd.nist.gov/products/cpe). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.","examples":["cpe:2.3:a:acme:component_framework:-:*:*:*:*:*:*:*"]},"purl":{"type":"string","title":"Package URL (purl)","description":"Asserts the identity of the component using package-url (purl). The purl, if specified, must be valid and conform to the specification defined at: [https://github.com/package-url/purl-spec](https://github.com/package-url/purl-spec). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.","examples":["pkg:maven/com.acme/[email protected]?packaging=jar"]},"omniborId":{"type":"array","title":"OmniBOR Artifact Identifier (gitoid)","description":"Asserts the identity of the component using the OmniBOR Artifact ID. The OmniBOR, if specified, must be valid and conform to the specification defined at: [https://www.iana.org/assignments/uri-schemes/prov/gitoid](https://www.iana.org/assignments/uri-schemes/prov/gitoid). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.","items":{"type":"string"},"examples":["gitoid:blob:sha1:a94a8fe5ccb19ba61c4c0873d391e987982fbbd3","gitoid:blob:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"]},"swhid":{"type":"array","title":"Software Heritage Identifier","description":"Asserts the identity of the component using the Software Heritage persistent identifier (SWHID). The SWHID, if specified, must be valid and conform to the specification defined at: [https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html](https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity.","items":{"type":"string"},"examples":["swh:1:cnt:94a9ed024d3859793618152ea559a168bbcbb5e2"]},"swid":{"$ref":"#/definitions/swid","title":"SWID Tag","description":"Asserts the identity of the component using [ISO-IEC 19770-2 Software Identification (SWID) Tags](https://www.iso.org/standard/65666.html). Refer to `@.evidence.identity` to optionally provide evidence that substantiates the assertion of the component's identity."},"modified":{"type":"boolean","title":"Component Modified From Original","description":"[Deprecated] This will be removed in a future version. Use the pedigree element instead to supply information on exactly how the component was modified. A boolean value indicating if the component has been modified from the original. A value of true indicates the component is a derivative of the original. A value of false indicates the component has not been modified from the original."},"pedigree":{"type":"object","title":"Component Pedigree","description":"Component pedigree is a way to document complex supply chain scenarios where components are created, distributed, modified, redistributed, combined with other components, etc. Pedigree supports viewing this complex chain from the beginning, the end, or anywhere in the middle. It also provides a way to document variants where the exact relation may not be known.","additionalProperties":false,"properties":{"ancestors":{"type":"array","title":"Ancestors","description":"Describes zero or more components in which a component is derived from. This is commonly used to describe forks from existing projects where the forked version contains a ancestor node containing the original component it was forked from. For example, Component A is the original component. Component B is the component being used and documented in the BOM. However, Component B contains a pedigree node with a single ancestor documenting Component A - the original component from which Component B is derived from.","items":{"$ref":"#/definitions/component"}},"descendants":{"type":"array","title":"Descendants","description":"Descendants are the exact opposite of ancestors. This provides a way to document all forks (and their forks) of an original or root component.","items":{"$ref":"#/definitions/component"}},"variants":{"type":"array","title":"Variants","description":"Variants describe relations where the relationship between the components is not known. For example, if Component A contains nearly identical code to Component B. They are both related, but it is unclear if one is derived from the other, or if they share a common ancestor.","items":{"$ref":"#/definitions/component"}},"commits":{"type":"array","title":"Commits","description":"A list of zero or more commits which provide a trail describing how the component deviates from an ancestor, descendant, or variant.","items":{"$ref":"#/definitions/commit"}},"patches":{"type":"array","title":"Patches","description":">A list of zero or more patches describing how the component deviates from an ancestor, descendant, or variant. Patches may be complementary to commits or may be used in place of commits.","items":{"$ref":"#/definitions/patch"}},"notes":{"type":"string","title":"Notes","description":"Notes, observations, and other non-structured commentary describing the components pedigree."}}},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."},"components":{"type":"array","items":{"$ref":"#/definitions/component"},"uniqueItems":true,"title":"Components","description":"A list of software and hardware components included in the parent component. This is not a dependency tree. It provides a way to specify a hierarchical representation of component assemblies, similar to system → subsystem → parts assembly in physical supply chains."},"evidence":{"$ref":"#/definitions/componentEvidence","title":"Evidence","description":"Provides the ability to document evidence collected through various forms of extraction or analysis."},"releaseNotes":{"$ref":"#/definitions/releaseNotes","title":"Release notes","description":"Specifies optional release notes."},"modelCard":{"$ref":"#/definitions/modelCard","title":"AI/ML Model Card"},"data":{"type":"array","items":{"$ref":"#/definitions/componentData"},"title":"Data","description":"This object SHOULD be specified for any component of type `data` and must not be specified for other component types."},"cryptoProperties":{"$ref":"#/definitions/cryptoProperties","title":"Cryptographic Properties"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}},"tags":{"$ref":"#/definitions/tags","title":"Tags"},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"swid":{"type":"object","title":"SWID Tag","description":"Specifies metadata and content for ISO-IEC 19770-2 Software Identification (SWID) Tags.","required":["tagId","name"],"additionalProperties":false,"properties":{"tagId":{"type":"string","title":"Tag ID","description":"Maps to the tagId of a SoftwareIdentity."},"name":{"type":"string","title":"Name","description":"Maps to the name of a SoftwareIdentity."},"version":{"type":"string","title":"Version","default":"0.0","description":"Maps to the version of a SoftwareIdentity."},"tagVersion":{"type":"integer","title":"Tag Version","default":0,"description":"Maps to the tagVersion of a SoftwareIdentity."},"patch":{"type":"boolean","title":"Patch","default":false,"description":"Maps to the patch of a SoftwareIdentity."},"text":{"title":"Attachment text","description":"Specifies the metadata and content of the SWID tag.","$ref":"#/definitions/attachment"},"url":{"type":"string","title":"URL","description":"The URL to the SWID file.","format":"iri-reference"}}},"attachment":{"type":"object","title":"Attachment","description":"Specifies the metadata and content for an attachment.","required":["content"],"additionalProperties":false,"properties":{"contentType":{"type":"string","title":"Content-Type","description":"Specifies the format and nature of the data being attached, helping systems correctly interpret and process the content. Common content type examples include `application/json` for JSON data and `text/plain` for plan text documents.\n [RFC 2045 section 5.1](https://www.ietf.org/rfc/rfc2045.html#section-5.1) outlines the structure and use of content types. For a comprehensive list of registered content types, refer to the [IANA media types registry](https://www.iana.org/assignments/media-types/media-types.xhtml).","default":"text/plain","examples":["text/plain","application/json","image/png"]},"encoding":{"type":"string","title":"Encoding","description":"Specifies the optional encoding the text is represented in.","enum":["base64"],"meta:enum":{"base64":"Base64 is a binary-to-text encoding scheme that represents binary data in an ASCII string."}},"content":{"type":"string","title":"Attachment Text","description":"The attachment data. Proactive controls such as input validation and sanitization should be employed to prevent misuse of attachment text."}}},"hash":{"type":"object","title":"Hash","required":["alg","content"],"additionalProperties":false,"properties":{"alg":{"$ref":"#/definitions/hash-alg"},"content":{"$ref":"#/definitions/hash-content"}}},"hash-alg":{"type":"string","title":"Hash Algorithm","description":"The algorithm that generated the hash value.","enum":["MD5","SHA-1","SHA-256","SHA-384","SHA-512","SHA3-256","SHA3-384","SHA3-512","BLAKE2b-256","BLAKE2b-384","BLAKE2b-512","BLAKE3"]},"hash-content":{"type":"string","title":"Hash Value","description":"The value of the hash.","examples":["3942447fac867ae5cdb3229b658f4d48"],"pattern":"^([a-fA-F0-9]{32}|[a-fA-F0-9]{40}|[a-fA-F0-9]{64}|[a-fA-F0-9]{96}|[a-fA-F0-9]{128})$"},"license":{"type":"object","title":"License","description":"Specifies the details and attributes related to a software license. It can either include a valid SPDX license identifier or a named license, along with additional properties such as license acknowledgment, comprehensive commercial licensing information, and the full text of the license.","oneOf":[{"required":["id"]},{"required":["name"]}],"additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"id":{"$ref":"spdx.schema.json","title":"License ID (SPDX)","description":"A valid SPDX license identifier. If specified, this value must be one of the enumeration of valid SPDX license identifiers defined in the spdx.schema.json (or spdx.xml) subschema which is synchronized with the official SPDX license list.","examples":["Apache-2.0"]},"name":{"type":"string","title":"License Name","description":"The name of the license. This may include the name of a commercial or proprietary license or an open source license that may not be defined by SPDX.","examples":["Acme Software License"]},"acknowledgement":{"$ref":"#/definitions/licenseAcknowledgementEnumeration"},"text":{"title":"License text","description":"An optional way to include the textual content of a license.","$ref":"#/definitions/attachment"},"url":{"type":"string","title":"License URL","description":"The URL to the license file. If specified, a 'license' externalReference should also be specified for completeness","examples":["https://www.apache.org/licenses/LICENSE-2.0.txt"],"format":"iri-reference"},"licensing":{"type":"object","title":"Licensing information","description":"Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata","additionalProperties":false,"properties":{"altIds":{"type":"array","title":"Alternate License Identifiers","description":"License identifiers that may be used to manage licenses and their lifecycle","items":{"type":"string"}},"licensor":{"title":"Licensor","description":"The individual or organization that grants a license to another individual or organization","type":"object","additionalProperties":false,"properties":{"organization":{"title":"Licensor (Organization)","description":"The organization that granted the license","$ref":"#/definitions/organizationalEntity"},"individual":{"title":"Licensor (Individual)","description":"The individual, not associated with an organization, that granted the license","$ref":"#/definitions/organizationalContact"}},"oneOf":[{"required":["organization"]},{"required":["individual"]}]},"licensee":{"title":"Licensee","description":"The individual or organization for which a license was granted to","type":"object","additionalProperties":false,"properties":{"organization":{"title":"Licensee (Organization)","description":"The organization that was granted the license","$ref":"#/definitions/organizationalEntity"},"individual":{"title":"Licensee (Individual)","description":"The individual, not associated with an organization, that was granted the license","$ref":"#/definitions/organizationalContact"}},"oneOf":[{"required":["organization"]},{"required":["individual"]}]},"purchaser":{"title":"Purchaser","description":"The individual or organization that purchased the license","type":"object","additionalProperties":false,"properties":{"organization":{"title":"Purchaser (Organization)","description":"The organization that purchased the license","$ref":"#/definitions/organizationalEntity"},"individual":{"title":"Purchaser (Individual)","description":"The individual, not associated with an organization, that purchased the license","$ref":"#/definitions/organizationalContact"}},"oneOf":[{"required":["organization"]},{"required":["individual"]}]},"purchaseOrder":{"type":"string","title":"Purchase Order","description":"The purchase order identifier the purchaser sent to a supplier or vendor to authorize a purchase"},"licenseTypes":{"type":"array","title":"License Type","description":"The type of license(s) that was granted to the licensee.","items":{"type":"string","enum":["academic","appliance","client-access","concurrent-user","core-points","custom-metric","device","evaluation","named-user","node-locked","oem","perpetual","processor-points","subscription","user","other"],"meta:enum":{"academic":"A license that grants use of software solely for the purpose of education or research.","appliance":"A license covering use of software embedded in a specific piece of hardware.","client-access":"A Client Access License (CAL) allows client computers to access services provided by server software.","concurrent-user":"A Concurrent User license (aka floating license) limits the number of licenses for a software application and licenses are shared among a larger number of users.","core-points":"A license where the core of a computer's processor is assigned a specific number of points.","custom-metric":"A license for which consumption is measured by non-standard metrics.","device":"A license that covers a defined number of installations on computers and other types of devices.","evaluation":"A license that grants permission to install and use software for trial purposes.","named-user":"A license that grants access to the software to one or more pre-defined users.","node-locked":"A license that grants access to the software on one or more pre-defined computers or devices.","oem":"An Original Equipment Manufacturer license that is delivered with hardware, cannot be transferred to other hardware, and is valid for the life of the hardware.","perpetual":"A license where the software is sold on a one-time basis and the licensee can use a copy of the software indefinitely.","processor-points":"A license where each installation consumes points per processor.","subscription":"A license where the licensee pays a fee to use the software or service.","user":"A license that grants access to the software or service by a specified number of users.","other":"Another license type."}}},"lastRenewal":{"type":"string","format":"date-time","title":"Last Renewal","description":"The timestamp indicating when the license was last renewed. For new purchases, this is often the purchase or acquisition date. For non-perpetual licenses or subscriptions, this is the timestamp of when the license was last renewed."},"expiration":{"type":"string","format":"date-time","title":"Expiration","description":"The timestamp indicating when the current license expires (if applicable)."}}},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"licenseAcknowledgementEnumeration":{"title":"License Acknowledgement","description":"Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in `@.evidence.licenses`. Observed licenses form the evidence necessary to substantiate a concluded license.","type":"string","enum":["declared","concluded"],"meta:enum":{"declared":"Declared licenses represent the initial intentions of authors regarding the licensing terms of their code.","concluded":"Concluded licenses are verified and confirmed."}},"licenseChoice":{"title":"License Choice","description":"EITHER (list of SPDX licenses and/or named licenses) OR (tuple of one SPDX License Expression)","type":"array","oneOf":[{"title":"Multiple licenses","description":"A list of SPDX licenses and/or named licenses.","type":"array","items":{"type":"object","title":"License","required":["license"],"additionalProperties":false,"properties":{"license":{"$ref":"#/definitions/license"}}}},{"title":"SPDX License Expression","description":"A tuple of exactly one SPDX License Expression.","type":"array","additionalItems":false,"minItems":1,"maxItems":1,"items":[{"type":"object","additionalProperties":false,"required":["expression"],"properties":{"expression":{"type":"string","title":"SPDX License Expression","description":"A valid SPDX license expression.\nRefer to https://spdx.org/specifications for syntax requirements","examples":["Apache-2.0 AND (MIT OR GPL-2.0-only)","GPL-3.0-only WITH Classpath-exception-2.0"]},"acknowledgement":{"$ref":"#/definitions/licenseAcknowledgementEnumeration"},"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the license elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."}}}]}]},"commit":{"type":"object","title":"Commit","description":"Specifies an individual commit","additionalProperties":false,"properties":{"uid":{"type":"string","title":"UID","description":"A unique identifier of the commit. This may be version control specific. For example, Subversion uses revision numbers whereas git uses commit hashes."},"url":{"type":"string","title":"URL","description":"The URL to the commit. This URL will typically point to a commit in a version control system.","format":"iri-reference"},"author":{"title":"Author","description":"The author who created the changes in the commit","$ref":"#/definitions/identifiableAction"},"committer":{"title":"Committer","description":"The person who committed or pushed the commit","$ref":"#/definitions/identifiableAction"},"message":{"type":"string","title":"Message","description":"The text description of the contents of the commit"}}},"patch":{"type":"object","title":"Patch","description":"Specifies an individual patch","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["unofficial","monkey","backport","cherry-pick"],"meta:enum":{"unofficial":"A patch which is not developed by the creators or maintainers of the software being patched. Refer to [https://en.wikipedia.org/wiki/Unofficial_patch](https://en.wikipedia.org/wiki/Unofficial_patch).","monkey":"A patch which dynamically modifies runtime behavior. Refer to [https://en.wikipedia.org/wiki/Monkey_patch](https://en.wikipedia.org/wiki/Monkey_patch).","backport":"A patch which takes code from a newer version of the software and applies it to older versions of the same software. Refer to [https://en.wikipedia.org/wiki/Backporting](https://en.wikipedia.org/wiki/Backporting).","cherry-pick":"A patch created by selectively applying commits from other versions or branches of the same software."},"title":"Patch Type","description":"Specifies the purpose for the patch including the resolution of defects, security issues, or new behavior or functionality."},"diff":{"title":"Diff","description":"The patch file (or diff) that shows changes. Refer to [https://en.wikipedia.org/wiki/Diff](https://en.wikipedia.org/wiki/Diff)","$ref":"#/definitions/diff"},"resolves":{"type":"array","items":{"$ref":"#/definitions/issue"},"title":"Resolves","description":"A collection of issues the patch resolves"}}},"diff":{"type":"object","title":"Diff","description":"The patch file (or diff) that shows changes. Refer to https://en.wikipedia.org/wiki/Diff","additionalProperties":false,"properties":{"text":{"title":"Diff text","description":"Specifies the optional text of the diff","$ref":"#/definitions/attachment"},"url":{"type":"string","title":"URL","description":"Specifies the URL to the diff","format":"iri-reference"}}},"issue":{"type":"object","title":"Issue","description":"An individual issue that has been resolved.","required":["type"],"additionalProperties":false,"properties":{"type":{"type":"string","enum":["defect","enhancement","security"],"meta:enum":{"defect":"A fault, flaw, or bug in software.","enhancement":"A new feature or behavior in software.","security":"A special type of defect which impacts security."},"title":"Issue Type","description":"Specifies the type of issue"},"id":{"type":"string","title":"Issue ID","description":"The identifier of the issue assigned by the source of the issue"},"name":{"type":"string","title":"Issue Name","description":"The name of the issue"},"description":{"type":"string","title":"Issue Description","description":"A description of the issue"},"source":{"type":"object","title":"Source","description":"The source of the issue where it is documented","additionalProperties":false,"properties":{"name":{"type":"string","title":"Name","description":"The name of the source.","examples":["National Vulnerability Database","NVD","Apache"]},"url":{"type":"string","title":"URL","description":"The url of the issue documentation as provided by the source","format":"iri-reference"}}},"references":{"type":"array","items":{"type":"string","format":"iri-reference"},"title":"References","description":"A collection of URL's for reference. Multiple URLs are allowed.","examples":["https://example.com"]}}},"identifiableAction":{"type":"object","title":"Identifiable Action","description":"Specifies an individual commit","additionalProperties":false,"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The timestamp in which the action occurred"},"name":{"type":"string","title":"Name","description":"The name of the individual who performed the action"},"email":{"type":"string","format":"idn-email","title":"E-mail","description":"The email address of the individual who performed the action"}}},"externalReference":{"type":"object","title":"External Reference","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.","required":["url","type"],"additionalProperties":false,"properties":{"url":{"anyOf":[{"title":"URL","type":"string","format":"iri-reference"},{"title":"BOM-Link","$ref":"#/definitions/bomLink"}],"title":"URL","description":"The URI (URL or URN) to the external reference. External references are URIs and therefore can accept any URL scheme including https ([RFC-7230](https://www.ietf.org/rfc/rfc7230.txt)), mailto ([RFC-2368](https://www.ietf.org/rfc/rfc2368.txt)), tel ([RFC-3966](https://www.ietf.org/rfc/rfc3966.txt)), and dns ([RFC-4501](https://www.ietf.org/rfc/rfc4501.txt)). External references may also include formally registered URNs such as [CycloneDX BOM-Link](https://cyclonedx.org/capabilities/bomlink/) to reference CycloneDX BOMs or any object within a BOM. BOM-Link transforms applicable external references into relationships that can be expressed in a BOM or across BOMs."},"comment":{"type":"string","title":"Comment","description":"An optional comment describing the external reference"},"type":{"type":"string","title":"Type","description":"Specifies the type of external reference.","enum":["vcs","issue-tracker","website","advisories","bom","mailing-list","social","chat","documentation","support","source-distribution","distribution","distribution-intake","license","build-meta","build-system","release-notes","security-contact","model-card","log","configuration","evidence","formulation","attestation","threat-model","adversary-model","risk-assessment","vulnerability-assertion","exploitability-statement","pentest-report","static-analysis-report","dynamic-analysis-report","runtime-analysis-report","component-analysis-report","maturity-report","certification-report","codified-infrastructure","quality-metrics","poam","electronic-signature","digital-signature","rfc-9116","other"],"meta:enum":{"vcs":"Version Control System","issue-tracker":"Issue or defect tracking system, or an Application Lifecycle Management (ALM) system","website":"Website","advisories":"Security advisories","bom":"Bill of Materials (SBOM, OBOM, HBOM, SaaSBOM, etc)","mailing-list":"Mailing list or discussion group","social":"Social media account","chat":"Real-time chat platform","documentation":"Documentation, guides, or how-to instructions","support":"Community or commercial support","source-distribution":"The location where the source code distributable can be obtained. This is often an archive format such as zip or tgz. The source-distribution type complements use of the version control (vcs) type.","distribution":"Direct or repository download location","distribution-intake":"The location where a component was published to. This is often the same as \"distribution\" but may also include specialized publishing processes that act as an intermediary.","license":"The reference to the license file. If a license URL has been defined in the license node, it should also be defined as an external reference for completeness.","build-meta":"Build-system specific meta file (i.e. pom.xml, package.json, .nuspec, etc)","build-system":"Reference to an automated build system","release-notes":"Reference to release notes","security-contact":"Specifies a way to contact the maintainer, supplier, or provider in the event of a security incident. Common URIs include links to a disclosure procedure, a mailto (RFC-2368) that specifies an email address, a tel (RFC-3966) that specifies a phone number, or dns (RFC-4501) that specifies the records containing DNS Security TXT.","model-card":"A model card describes the intended uses of a machine learning model, potential limitations, biases, ethical considerations, training parameters, datasets used to train the model, performance metrics, and other relevant data useful for ML transparency.","log":"A record of events that occurred in a computer system or application, such as problems, errors, or information on current operations.","configuration":"Parameters or settings that may be used by other components or services.","evidence":"Information used to substantiate a claim.","formulation":"Describes how a component or service was manufactured or deployed.","attestation":"Human or machine-readable statements containing facts, evidence, or testimony.","threat-model":"An enumeration of identified weaknesses, threats, and countermeasures, dataflow diagram (DFD), attack tree, and other supporting documentation in human-readable or machine-readable format.","adversary-model":"The defined assumptions, goals, and capabilities of an adversary.","risk-assessment":"Identifies and analyzes the potential of future events that may negatively impact individuals, assets, and/or the environment. Risk assessments may also include judgments on the tolerability of each risk.","vulnerability-assertion":"A Vulnerability Disclosure Report (VDR) which asserts the known and previously unknown vulnerabilities that affect a component, service, or product including the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on a component, service, or product.","exploitability-statement":"A Vulnerability Exploitability eXchange (VEX) which asserts the known vulnerabilities that do not affect a product, product family, or organization, and optionally the ones that do. The VEX should include the analysis and findings describing the impact (or lack of impact) that the reported vulnerability has on the product, product family, or organization.","pentest-report":"Results from an authorized simulated cyberattack on a component or service, otherwise known as a penetration test.","static-analysis-report":"SARIF or proprietary machine or human-readable report for which static analysis has identified code quality, security, and other potential issues with the source code.","dynamic-analysis-report":"Dynamic analysis report that has identified issues such as vulnerabilities and misconfigurations.","runtime-analysis-report":"Report generated by analyzing the call stack of a running application.","component-analysis-report":"Report generated by Software Composition Analysis (SCA), container analysis, or other forms of component analysis.","maturity-report":"Report containing a formal assessment of an organization, business unit, or team against a maturity model.","certification-report":"Industry, regulatory, or other certification from an accredited (if applicable) certification body.","codified-infrastructure":"Code or configuration that defines and provisions virtualized infrastructure, commonly referred to as Infrastructure as Code (IaC).","quality-metrics":"Report or system in which quality metrics can be obtained.","poam":"Plans of Action and Milestones (POA&M) complement an \"attestation\" external reference. POA&M is defined by NIST as a \"document that identifies tasks needing to be accomplished. It details resources required to accomplish the elements of the plan, any milestones in meeting the tasks and scheduled completion dates for the milestones\".","electronic-signature":"An e-signature is commonly a scanned representation of a written signature or a stylized script of the person's name.","digital-signature":"A signature that leverages cryptography, typically public/private key pairs, which provides strong authenticity verification.","rfc-9116":"Document that complies with [RFC 9116](https://www.ietf.org/rfc/rfc9116.html) (A File Format to Aid in Security Vulnerability Disclosure)","other":"Use this if no other types accurately describe the purpose of the external reference."}},"hashes":{"type":"array","items":{"$ref":"#/definitions/hash"},"title":"Hashes","description":"The hashes of the external reference (if applicable)."}}},"dependency":{"type":"object","title":"Dependency","description":"Defines the direct dependencies of a component, service, or the components provided/implemented by a given component. Components or services that do not have their own dependencies must be declared as empty elements within the graph. Components or services that are not represented in the dependency graph may have unknown dependencies. It is recommended that implementations assume this to be opaque and not an indicator of an object being dependency-free. It is recommended to leverage compositions to indicate unknown dependency graphs.","required":["ref"],"additionalProperties":false,"properties":{"ref":{"$ref":"#/definitions/refLinkType","title":"Reference","description":"References a component or service by its bom-ref attribute"},"dependsOn":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/refLinkType"},"title":"Depends On","description":"The bom-ref identifiers of the components or services that are dependencies of this dependency object."},"provides":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/refLinkType"},"title":"Provides","description":"The bom-ref identifiers of the components or services that define a given specification or standard, which are provided or implemented by this dependency object.\nFor example, a cryptographic library which implements a cryptographic algorithm. A component which implements another component does not imply that the implementation is in use."}}},"service":{"type":"object","title":"Service","required":["name"],"additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the service elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"provider":{"title":"Provider","description":"The organization that provides the service.","$ref":"#/definitions/organizationalEntity"},"group":{"type":"string","title":"Service Group","description":"The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.","examples":["com.acme"]},"name":{"type":"string","title":"Service Name","description":"The name of the service. This will often be a shortened, single name of the service.","examples":["ticker-service"]},"version":{"$ref":"#/definitions/version","title":"Service Version","description":"The service version."},"description":{"type":"string","title":"Service Description","description":"Specifies a description for the service"},"endpoints":{"type":"array","items":{"type":"string","format":"iri-reference"},"title":"Endpoints","description":"The endpoint URIs of the service. Multiple endpoints are allowed.","examples":["https://example.com/api/v1/ticker"]},"authenticated":{"type":"boolean","title":"Authentication Required","description":"A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication."},"x-trust-boundary":{"type":"boolean","title":"Crosses Trust Boundary","description":"A boolean value indicating if use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed."},"trustZone":{"type":"string","title":"Trust Zone","description":"The name of the trust zone the service resides in."},"data":{"type":"array","items":{"$ref":"#/definitions/serviceData"},"title":"Data","description":"Specifies information about the data including the directional flow of data and the data classification."},"licenses":{"$ref":"#/definitions/licenseChoice","title":"Service License(s)"},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."},"services":{"type":"array","items":{"$ref":"#/definitions/service"},"uniqueItems":true,"title":"Services","description":"A list of services included or deployed behind the parent service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies."},"releaseNotes":{"$ref":"#/definitions/releaseNotes","title":"Release notes","description":"Specifies optional release notes."},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}},"tags":{"$ref":"#/definitions/tags","title":"Tags"},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"serviceData":{"type":"object","title":"Hash Objects","required":["flow","classification"],"additionalProperties":false,"properties":{"flow":{"$ref":"#/definitions/dataFlowDirection","title":"Directional Flow","description":"Specifies the flow direction of the data. Direction is relative to the service. Inbound flow states that data enters the service. Outbound flow states that data leaves the service. Bi-directional states that data flows both ways and unknown states that the direction is not known."},"classification":{"$ref":"#/definitions/dataClassification"},"name":{"type":"string","title":"Name","description":"Name for the defined data","examples":["Credit card reporting"]},"description":{"type":"string","title":"Description","description":"Short description of the data content and usage","examples":["Credit card information being exchanged in between the web app and the database"]},"governance":{"title":"Data Governance","$ref":"#/definitions/dataGovernance"},"source":{"type":"array","items":{"anyOf":[{"title":"URL","type":"string","format":"iri-reference"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"title":"Source","description":"The URI, URL, or BOM-Link of the components or services the data came in from"},"destination":{"type":"array","items":{"anyOf":[{"title":"URL","type":"string","format":"iri-reference"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"title":"Destination","description":"The URI, URL, or BOM-Link of the components or services the data is sent to"}}},"dataFlowDirection":{"type":"string","enum":["inbound","outbound","bi-directional","unknown"],"meta:enum":{"inbound":"Data that enters a service.","outbound":"Data that exits a service.","bi-directional":"Data flows in and out of the service.","unknown":"The directional flow of data is not known."},"title":"Data flow direction","description":"Specifies the flow direction of the data. Direction is relative to the service."},"copyright":{"type":"object","title":"Copyright","description":"A copyright notice informing users of the underlying claims to copyright ownership in a published work.","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","title":"Copyright Text","description":"The textual content of the copyright."}}},"componentEvidence":{"type":"object","title":"Evidence","description":"Provides the ability to document evidence collected through various forms of extraction or analysis.","additionalProperties":false,"properties":{"identity":{"title":"Identity Evidence","description":"Evidence that substantiates the identity of a component. The identity may be an object or an array of identity objects. Support for specifying identity as a single object was introduced in CycloneDX v1.5. Arrays were introduced in v1.6. It is recommended that all implementations use arrays, even if only one identity object is specified.","oneOf":[{"type":"array","title":"Array of Identity Objects","items":{"$ref":"#/definitions/componentIdentityEvidence"}},{"title":"A Single Identity Object","description":"[Deprecated]","$ref":"#/definitions/componentIdentityEvidence","deprecated":true}]},"occurrences":{"type":"array","title":"Occurrences","description":"Evidence of individual instances of a component spread across multiple locations.","items":{"type":"object","required":["location"],"additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the occurrence elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"location":{"type":"string","title":"Location","description":"The location or path to where the component was found."},"line":{"type":"integer","minimum":0,"title":"Line Number","description":"The line number where the component was found."},"offset":{"type":"integer","minimum":0,"title":"Offset","description":"The offset where the component was found."},"symbol":{"type":"string","title":"Symbol","description":"The symbol name that was found associated with the component."},"additionalContext":{"type":"string","title":"Additional Context","description":"Any additional context of the detected component (e.g. a code snippet)."}}}},"callstack":{"type":"object","title":"Call Stack","description":"Evidence of the components use through the callstack.","additionalProperties":false,"properties":{"frames":{"type":"array","title":"Frames","description":"Within a call stack, a frame is a discrete unit that encapsulates an execution context, including local variables, parameters, and the return address. As function calls are made, frames are pushed onto the stack, forming an array-like structure that orchestrates the flow of program execution and manages the sequence of function invocations.","items":{"type":"object","required":["module"],"additionalProperties":false,"properties":{"package":{"title":"Package","description":"A package organizes modules into namespaces, providing a unique namespace for each type it contains.","type":"string"},"module":{"title":"Module","description":"A module or class that encloses functions/methods and other code.","type":"string"},"function":{"title":"Function","description":"A block of code designed to perform a particular task.","type":"string"},"parameters":{"title":"Parameters","description":"Optional arguments that are passed to the module or function.","type":"array","items":{"type":"string"}},"line":{"title":"Line","description":"The line number the code that is called resides on.","type":"integer"},"column":{"title":"Column","description":"The column the code that is called resides.","type":"integer"},"fullFilename":{"title":"Full Filename","description":"The full path and filename of the module.","type":"string"}}}}}},"licenses":{"$ref":"#/definitions/licenseChoice","title":"License Evidence"},"copyright":{"type":"array","items":{"$ref":"#/definitions/copyright"},"title":"Copyright Evidence","description":"Copyright evidence captures intellectual property assertions, providing evidence of possible ownership and legal protection."}}},"compositions":{"type":"object","title":"Compositions","required":["aggregate"],"additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the composition elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"aggregate":{"$ref":"#/definitions/aggregateType","title":"Aggregate","description":"Specifies an aggregate type that describes how complete a relationship is."},"assemblies":{"type":"array","uniqueItems":true,"items":{"anyOf":[{"title":"Ref","$ref":"#/definitions/refLinkType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"title":"BOM references","description":"The bom-ref identifiers of the components or services being described. Assemblies refer to nested relationships whereby a constituent part may include other constituent parts. References do not cascade to child parts. References are explicit for the specified constituent part only."},"dependencies":{"type":"array","uniqueItems":true,"items":{"type":"string"},"title":"BOM references","description":"The bom-ref identifiers of the components or services being described. Dependencies refer to a relationship whereby an independent constituent part requires another independent constituent part. References do not cascade to transitive dependencies. References are explicit for the specified dependency only."},"vulnerabilities":{"type":"array","uniqueItems":true,"items":{"type":"string"},"title":"BOM references","description":"The bom-ref identifiers of the vulnerabilities being described."},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"aggregateType":{"type":"string","default":"not_specified","enum":["complete","incomplete","incomplete_first_party_only","incomplete_first_party_proprietary_only","incomplete_first_party_opensource_only","incomplete_third_party_only","incomplete_third_party_proprietary_only","incomplete_third_party_opensource_only","unknown","not_specified"],"meta:enum":{"complete":"The relationship is complete. No further relationships including constituent components, services, or dependencies are known to exist.","incomplete":"The relationship is incomplete. Additional relationships exist and may include constituent components, services, or dependencies.","incomplete_first_party_only":"The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented.","incomplete_first_party_proprietary_only":"The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.","incomplete_first_party_opensource_only":"The relationship is incomplete. Only relationships for first-party components, services, or their dependencies are represented, limited specifically to those that are opensource.","incomplete_third_party_only":"The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented.","incomplete_third_party_proprietary_only":"The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are proprietary.","incomplete_third_party_opensource_only":"The relationship is incomplete. Only relationships for third-party components, services, or their dependencies are represented, limited specifically to those that are opensource.","unknown":"The relationship may be complete or incomplete. This usually signifies a 'best-effort' to obtain constituent components, services, or dependencies but the completeness is inconclusive.","not_specified":"The relationship completeness is not specified."}},"property":{"type":"object","title":"Lightweight name-value pair","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","required":["name"],"properties":{"name":{"type":"string","title":"Name","description":"The name of the property. Duplicate names are allowed, each potentially having a different value."},"value":{"type":"string","title":"Value","description":"The value of the property."}},"additionalProperties":false},"localeType":{"type":"string","pattern":"^([a-z]{2})(-[A-Z]{2})?$","title":"Locale","description":"Defines a syntax for representing two character language code (ISO-639) followed by an optional two character country code. The language code must be lower case. If the country code is specified, the country code must be upper case. The language code and country code must be separated by a minus sign. Examples: en, en-US, fr, fr-CA"},"releaseType":{"type":"string","examples":["major","minor","patch","pre-release","internal"],"description":"The software versioning type. It is recommended that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'. Representing all possible software release types is not practical, so standardizing on the recommended values, whenever possible, is strongly encouraged.\n\n* __major__ = A major release may contain significant changes or may introduce breaking changes.\n* __minor__ = A minor release, also known as an update, may contain a smaller number of changes than major releases.\n* __patch__ = Patch releases are typically unplanned and may resolve defects or important security issues.\n* __pre-release__ = A pre-release may include alpha, beta, or release candidates and typically have limited support. They provide the ability to preview a release prior to its general availability.\n* __internal__ = Internal releases are not for public consumption and are intended to be used exclusively by the project or manufacturer that produced it."},"note":{"type":"object","title":"Note","description":"A note containing the locale and content.","required":["text"],"additionalProperties":false,"properties":{"locale":{"$ref":"#/definitions/localeType","title":"Locale","description":"The ISO-639 (or higher) language code and optional ISO-3166 (or higher) country code. Examples include: \"en\", \"en-US\", \"fr\" and \"fr-CA\""},"text":{"title":"Release note content","description":"Specifies the full content of the release note.","$ref":"#/definitions/attachment"}}},"releaseNotes":{"type":"object","title":"Release notes","required":["type"],"additionalProperties":false,"properties":{"type":{"$ref":"#/definitions/releaseType","title":"Type","description":"The software versioning type the release note describes."},"title":{"type":"string","title":"Title","description":"The title of the release."},"featuredImage":{"type":"string","format":"iri-reference","title":"Featured image","description":"The URL to an image that may be prominently displayed with the release note."},"socialImage":{"type":"string","format":"iri-reference","title":"Social image","description":"The URL to an image that may be used in messaging on social media platforms."},"description":{"type":"string","title":"Description","description":"A short description of the release."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The date and time (timestamp) when the release note was created."},"aliases":{"type":"array","items":{"type":"string"},"title":"Aliases","description":"One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names)."},"tags":{"$ref":"#/definitions/tags","title":"Tags"},"resolves":{"type":"array","items":{"$ref":"#/definitions/issue"},"title":"Resolves","description":"A collection of issues that have been resolved."},"notes":{"type":"array","items":{"$ref":"#/definitions/note"},"title":"Notes","description":"Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages."},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"advisory":{"type":"object","title":"Advisory","description":"Title and location where advisory information can be obtained. An advisory is a notification of a threat to a component, service, or system.","required":["url"],"additionalProperties":false,"properties":{"title":{"type":"string","title":"Title","description":"An optional name of the advisory."},"url":{"type":"string","title":"URL","format":"iri-reference","description":"Location where the advisory can be obtained."}}},"cwe":{"type":"integer","minimum":1,"title":"CWE","description":"Integer representation of a Common Weaknesses Enumerations (CWE). For example 399 (of https://cwe.mitre.org/data/definitions/399.html)"},"severity":{"type":"string","title":"Severity","description":"Textual representation of the severity of the vulnerability adopted by the analysis method. If the analysis method uses values other than what is provided, the user is expected to translate appropriately.","enum":["critical","high","medium","low","info","none","unknown"],"meta:enum":{"critical":"Critical severity","high":"High severity","medium":"Medium severity","low":"Low severity","info":"Informational warning.","none":"None","unknown":"The severity is not known"}},"scoreMethod":{"type":"string","title":"Method","description":"Specifies the severity or risk scoring methodology or standard used.","enum":["CVSSv2","CVSSv3","CVSSv31","CVSSv4","OWASP","SSVC","other"],"meta:enum":{"CVSSv2":"Common Vulnerability Scoring System v2.0","CVSSv3":"Common Vulnerability Scoring System v3.0","CVSSv31":"Common Vulnerability Scoring System v3.1","CVSSv4":"Common Vulnerability Scoring System v4.0","OWASP":"OWASP Risk Rating Methodology","SSVC":"Stakeholder Specific Vulnerability Categorization","other":"Another severity or risk scoring methodology"}},"impactAnalysisState":{"type":"string","title":"Impact Analysis State","description":"Declares the current state of an occurrence of a vulnerability, after automated or manual analysis.","enum":["resolved","resolved_with_pedigree","exploitable","in_triage","false_positive","not_affected"],"meta:enum":{"resolved":"The vulnerability has been remediated.","resolved_with_pedigree":"The vulnerability has been remediated and evidence of the changes are provided in the affected components pedigree containing verifiable commit history and/or diff(s).","exploitable":"The vulnerability may be directly or indirectly exploitable.","in_triage":"The vulnerability is being investigated.","false_positive":"The vulnerability is not specific to the component or service and was falsely identified or associated.","not_affected":"The component or service is not affected by the vulnerability. Justification should be specified for all not_affected cases."}},"impactAnalysisJustification":{"type":"string","title":"Impact Analysis Justification","description":"The rationale of why the impact analysis state was asserted.","enum":["code_not_present","code_not_reachable","requires_configuration","requires_dependency","requires_environment","protected_by_compiler","protected_at_runtime","protected_at_perimeter","protected_by_mitigating_control"],"meta:enum":{"code_not_present":"The code has been removed or tree-shaked.","code_not_reachable":"The vulnerable code is not invoked at runtime.","requires_configuration":"Exploitability requires a configurable option to be set/unset.","requires_dependency":"Exploitability requires a dependency that is not present.","requires_environment":"Exploitability requires a certain environment which is not present.","protected_by_compiler":"Exploitability requires a compiler flag to be set/unset.","protected_at_runtime":"Exploits are prevented at runtime.","protected_at_perimeter":"Attacks are blocked at physical, logical, or network perimeter.","protected_by_mitigating_control":"Preventative measures have been implemented that reduce the likelihood and/or impact of the vulnerability."}},"rating":{"type":"object","title":"Rating","description":"Defines the severity or risk ratings of a vulnerability.","additionalProperties":false,"properties":{"source":{"$ref":"#/definitions/vulnerabilitySource","description":"The source that calculated the severity or risk rating of the vulnerability."},"score":{"type":"number","title":"Score","description":"The numerical score of the rating."},"severity":{"$ref":"#/definitions/severity","description":"Textual representation of the severity that corresponds to the numerical score of the rating."},"method":{"$ref":"#/definitions/scoreMethod"},"vector":{"type":"string","title":"Vector","description":"Textual representation of the metric values used to score the vulnerability"},"justification":{"type":"string","title":"Justification","description":"An optional reason for rating the vulnerability as it was"}}},"vulnerabilitySource":{"type":"object","title":"Source","description":"The source of vulnerability information. This is often the organization that published the vulnerability.","additionalProperties":false,"properties":{"url":{"type":"string","title":"URL","description":"The url of the vulnerability documentation as provided by the source.","examples":["https://nvd.nist.gov/vuln/detail/CVE-2021-39182"]},"name":{"type":"string","title":"Name","description":"The name of the source.","examples":["NVD","National Vulnerability Database","OSS Index","VulnDB","GitHub Advisories"]}}},"vulnerability":{"type":"object","title":"Vulnerability","description":"Defines a weakness in a component or service that could be exploited or triggered by a threat source.","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the vulnerability elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"id":{"type":"string","title":"ID","description":"The identifier that uniquely identifies the vulnerability.","examples":["CVE-2021-39182","GHSA-35m5-8cvj-8783","SNYK-PYTHON-ENROCRYPT-1912876"]},"source":{"$ref":"#/definitions/vulnerabilitySource","description":"The source that published the vulnerability."},"references":{"type":"array","title":"References","description":"Zero or more pointers to vulnerabilities that are the equivalent of the vulnerability specified. Often times, the same vulnerability may exist in multiple sources of vulnerability intelligence, but have different identifiers. References provide a way to correlate vulnerabilities across multiple sources of vulnerability intelligence.","items":{"type":"object","required":["id","source"],"additionalProperties":false,"properties":{"id":{"type":"string","title":"ID","description":"An identifier that uniquely identifies the vulnerability.","examples":["CVE-2021-39182","GHSA-35m5-8cvj-8783","SNYK-PYTHON-ENROCRYPT-1912876"]},"source":{"$ref":"#/definitions/vulnerabilitySource","description":"The source that published the vulnerability."}}}},"ratings":{"type":"array","title":"Ratings","description":"List of vulnerability ratings","items":{"$ref":"#/definitions/rating"}},"cwes":{"type":"array","title":"CWEs","description":"List of Common Weaknesses Enumerations (CWEs) codes that describes this vulnerability.","examples":[399],"items":{"$ref":"#/definitions/cwe"}},"description":{"type":"string","title":"Description","description":"A description of the vulnerability as provided by the source."},"detail":{"type":"string","title":"Details","description":"If available, an in-depth description of the vulnerability as provided by the source organization. Details often include information useful in understanding root cause."},"recommendation":{"type":"string","title":"Recommendation","description":"Recommendations of how the vulnerability can be remediated or mitigated."},"workaround":{"type":"string","title":"Workarounds","description":"A bypass, usually temporary, of the vulnerability that reduces its likelihood and/or impact. Workarounds often involve changes to configuration or deployments."},"proofOfConcept":{"type":"object","title":"Proof of Concept","description":"Evidence used to reproduce the vulnerability.","properties":{"reproductionSteps":{"type":"string","title":"Steps to Reproduce","description":"Precise steps to reproduce the vulnerability."},"environment":{"type":"string","title":"Environment","description":"A description of the environment in which reproduction was possible."},"supportingMaterial":{"type":"array","title":"Supporting Material","description":"Supporting material that helps in reproducing or understanding how reproduction is possible. This may include screenshots, payloads, and PoC exploit code.","items":{"$ref":"#/definitions/attachment"}}}},"advisories":{"type":"array","title":"Advisories","description":"Published advisories of the vulnerability if provided.","items":{"$ref":"#/definitions/advisory"}},"created":{"type":"string","format":"date-time","title":"Created","description":"The date and time (timestamp) when the vulnerability record was created in the vulnerability database."},"published":{"type":"string","format":"date-time","title":"Published","description":"The date and time (timestamp) when the vulnerability record was first published."},"updated":{"type":"string","format":"date-time","title":"Updated","description":"The date and time (timestamp) when the vulnerability record was last updated."},"rejected":{"type":"string","format":"date-time","title":"Rejected","description":"The date and time (timestamp) when the vulnerability record was rejected (if applicable)."},"credits":{"type":"object","title":"Credits","description":"Individuals or organizations credited with the discovery of the vulnerability.","additionalProperties":false,"properties":{"organizations":{"type":"array","title":"Organizations","description":"The organizations credited with vulnerability discovery.","items":{"$ref":"#/definitions/organizationalEntity"}},"individuals":{"type":"array","title":"Individuals","description":"The individuals, not associated with organizations, that are credited with vulnerability discovery.","items":{"$ref":"#/definitions/organizationalContact"}}}},"tools":{"title":"Tools","description":"The tool(s) used to identify, confirm, or score the vulnerability.","oneOf":[{"type":"object","title":"Tools","description":"The tool(s) used to identify, confirm, or score the vulnerability.","additionalProperties":false,"properties":{"components":{"type":"array","items":{"$ref":"#/definitions/component"},"uniqueItems":true,"title":"Components","description":"A list of software and hardware components used as tools."},"services":{"type":"array","items":{"$ref":"#/definitions/service"},"uniqueItems":true,"title":"Services","description":"A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services."}}},{"type":"array","title":"Tools (legacy)","description":"[Deprecated] The tool(s) used to identify, confirm, or score the vulnerability.","items":{"$ref":"#/definitions/tool"}}]},"analysis":{"type":"object","title":"Impact Analysis","description":"An assessment of the impact and exploitability of the vulnerability.","additionalProperties":false,"properties":{"state":{"$ref":"#/definitions/impactAnalysisState"},"justification":{"$ref":"#/definitions/impactAnalysisJustification"},"response":{"type":"array","title":"Response","description":"A response to the vulnerability by the manufacturer, supplier, or project responsible for the affected component or service. More than one response is allowed. Responses are strongly encouraged for vulnerabilities where the analysis state is exploitable.","items":{"type":"string","enum":["can_not_fix","will_not_fix","update","rollback","workaround_available"],"meta:enum":{"can_not_fix":"Can not fix","will_not_fix":"Will not fix","update":"Update to a different revision or release","rollback":"Revert to a previous revision or release","workaround_available":"There is a workaround available"}}},"detail":{"type":"string","title":"Detail","description":"Detailed description of the impact including methods used during assessment. If a vulnerability is not exploitable, this field should include specific details on why the component or service is not impacted by this vulnerability."},"firstIssued":{"type":"string","format":"date-time","title":"First Issued","description":"The date and time (timestamp) when the analysis was first issued."},"lastUpdated":{"type":"string","format":"date-time","title":"Last Updated","description":"The date and time (timestamp) when the analysis was last updated."}}},"affects":{"type":"array","uniqueItems":true,"items":{"type":"object","required":["ref"],"additionalProperties":false,"properties":{"ref":{"anyOf":[{"title":"Ref","$ref":"#/definitions/refLinkType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}],"title":"Reference","description":"References a component or service by the objects bom-ref"},"versions":{"type":"array","title":"Versions","description":"Zero or more individual versions or range of versions.","items":{"type":"object","oneOf":[{"required":["version"]},{"required":["range"]}],"additionalProperties":false,"properties":{"version":{"title":"Version","description":"A single version of a component or service.","$ref":"#/definitions/version"},"range":{"title":"Version Range","description":"A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst","$ref":"#/definitions/versionRange"},"status":{"title":"Status","description":"The vulnerability status for the version or range of versions.","$ref":"#/definitions/affectedStatus","default":"affected"}}}}}},"title":"Affects","description":"The components or services that are affected by the vulnerability."},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"affectedStatus":{"description":"The vulnerability status of a given version or range of versions of a product. The statuses 'affected' and 'unaffected' indicate that the version is affected or unaffected by the vulnerability. The status 'unknown' indicates that it is unknown or unspecified whether the given version is affected. There can be many reasons for an 'unknown' status, including that an investigation has not been undertaken or that a vendor has not disclosed the status.","type":"string","enum":["affected","unaffected","unknown"],"meta:enum":{"affected":"The version is affected by the vulnerability.","unaffected":"The version is not affected by the vulnerability.","unknown":"It is unknown (or unspecified) whether the given version is affected."}},"version":{"description":"A single disjunctive version identifier, for a component or service.","type":"string","maxLength":1024,"examples":["9.0.14","v1.33.7","7.0.0-M1","2.0pre1","1.0.0-beta1","0.8.15"]},"versionRange":{"description":"A version range specified in Package URL Version Range syntax (vers) which is defined at https://github.com/package-url/purl-spec/blob/master/VERSION-RANGE-SPEC.rst","type":"string","minLength":1,"maxLength":4096,"examples":["vers:cargo/9.0.14","vers:npm/1.2.3|>=2.0.0|<5.0.0","vers:pypi/0.0.0|0.0.1|0.0.2|0.0.3|1.0|2.0pre1","vers:tomee/>=1.0.0-beta1|<=1.7.5|>=7.0.0-M1|<=7.0.7|>=7.1.0|<=7.1.2|>=8.0.0-M1|<=8.0.1","vers:gem/>=2.2.0|!= 2.2.1|<2.3.0"]},"range":{"deprecated":true,"description":"Deprecated definition. use definition `versionRange` instead.","$ref":"#/definitions/versionRange"},"annotations":{"type":"object","title":"Annotations","description":"A comment, note, explanation, or similar textual content which provides additional context to the object(s) being annotated.","required":["subjects","annotator","timestamp","text"],"additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the annotation elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"subjects":{"type":"array","uniqueItems":true,"items":{"anyOf":[{"title":"Ref","$ref":"#/definitions/refLinkType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"title":"Subjects","description":"The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs."},"annotator":{"type":"object","title":"Annotator","description":"The organization, person, component, or service which created the textual content of the annotation.","oneOf":[{"required":["organization"]},{"required":["individual"]},{"required":["component"]},{"required":["service"]}],"additionalProperties":false,"properties":{"organization":{"description":"The organization that created the annotation","$ref":"#/definitions/organizationalEntity"},"individual":{"description":"The person that created the annotation","$ref":"#/definitions/organizationalContact"},"component":{"description":"The tool or component that created the annotation","$ref":"#/definitions/component"},"service":{"description":"The service that created the annotation","$ref":"#/definitions/service"}}},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The date and time (timestamp) when the annotation was created."},"text":{"type":"string","title":"Text","description":"The textual content of the annotation."},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"modelCard":{"$comment":"Model card support in CycloneDX is derived from TensorFlow Model Card Toolkit released under the Apache 2.0 license and available from https://github.com/tensorflow/model-card-toolkit/blob/main/model_card_toolkit/schema/v0.0.2/model_card.schema.json. In addition, CycloneDX model card support includes portions of VerifyML, also released under the Apache 2.0 license and available from https://github.com/cylynx/verifyml/blob/main/verifyml/model_card_toolkit/schema/v0.0.4/model_card.schema.json.","type":"object","title":"Model Card","description":"A model card describes the intended uses of a machine learning model and potential limitations, including biases and ethical considerations. Model cards typically contain the training parameters, which datasets were used to train the model, performance metrics, and other relevant data useful for ML transparency. This object SHOULD be specified for any component of type `machine-learning-model` and must not be specified for other component types.","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the model card elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"modelParameters":{"type":"object","title":"Model Parameters","description":"Hyper-parameters for construction of the model.","additionalProperties":false,"properties":{"approach":{"type":"object","title":"Approach","description":"The overall approach to learning used by the model for problem solving.","additionalProperties":false,"properties":{"type":{"type":"string","title":"Learning Type","description":"Learning types describing the learning problem or hybrid learning problem.","enum":["supervised","unsupervised","reinforcement-learning","semi-supervised","self-supervised"],"meta:enum":{"supervised":"Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples.","unsupervised":"Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data.","reinforcement-learning":"Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error.","semi-supervised":"Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques.","self-supervised":"Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data."}}}},"task":{"type":"string","title":"Task","description":"Directly influences the input and/or output. Examples include classification, regression, clustering, etc."},"architectureFamily":{"type":"string","title":"Architecture Family","description":"The model architecture family such as transformer network, convolutional neural network, residual neural network, LSTM neural network, etc."},"modelArchitecture":{"type":"string","title":"Model Architecture","description":"The specific architecture of the model such as GPT-1, ResNet-50, YOLOv3, etc."},"datasets":{"type":"array","title":"Datasets","description":"The datasets used to train and evaluate the model.","items":{"oneOf":[{"title":"Inline Data Information","$ref":"#/definitions/componentData"},{"type":"object","title":"Data Reference","additionalProperties":false,"properties":{"ref":{"anyOf":[{"title":"Ref","$ref":"#/definitions/refLinkType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}],"title":"Reference","type":"string","description":"References a data component by the components bom-ref attribute"}}}]}},"inputs":{"type":"array","title":"Inputs","description":"The input format(s) of the model","items":{"$ref":"#/definitions/inputOutputMLParameters"}},"outputs":{"type":"array","title":"Outputs","description":"The output format(s) from the model","items":{"$ref":"#/definitions/inputOutputMLParameters"}}}},"quantitativeAnalysis":{"type":"object","title":"Quantitative Analysis","description":"A quantitative analysis of the model","additionalProperties":false,"properties":{"performanceMetrics":{"type":"array","title":"Performance Metrics","description":"The model performance metrics being reported. Examples may include accuracy, F1 score, precision, top-3 error rates, MSC, etc.","items":{"$ref":"#/definitions/performanceMetric"}},"graphics":{"$ref":"#/definitions/graphicsCollection"}}},"considerations":{"type":"object","title":"Considerations","description":"What considerations should be taken into account regarding the model's construction, training, and application?","additionalProperties":false,"properties":{"users":{"type":"array","title":"Users","description":"Who are the intended users of the model?","items":{"type":"string"}},"useCases":{"type":"array","title":"Use Cases","description":"What are the intended use cases of the model?","items":{"type":"string"}},"technicalLimitations":{"type":"array","title":"Technical Limitations","description":"What are the known technical limitations of the model? E.g. What kind(s) of data should the model be expected not to perform well on? What are the factors that might degrade model performance?","items":{"type":"string"}},"performanceTradeoffs":{"type":"array","title":"Performance Tradeoffs","description":"What are the known tradeoffs in accuracy/performance of the model?","items":{"type":"string"}},"ethicalConsiderations":{"type":"array","title":"Ethical Considerations","description":"What are the ethical risks involved in the application of this model?","items":{"$ref":"#/definitions/risk"}},"environmentalConsiderations":{"$ref":"#/definitions/environmentalConsiderations","title":"Environmental Considerations","description":"What are the various environmental impacts the corresponding machine learning model has exhibited across its lifecycle?"},"fairnessAssessments":{"type":"array","title":"Fairness Assessments","description":"How does the model affect groups at risk of being systematically disadvantaged? What are the harms and benefits to the various affected groups?","items":{"$ref":"#/definitions/fairnessAssessment"}}}},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"inputOutputMLParameters":{"type":"object","title":"Input and Output Parameters","additionalProperties":false,"properties":{"format":{"title":"Input/Output Format","description":"The data format for input/output to the model.","type":"string","examples":["string","image","time-series"]}}},"componentData":{"type":"object","additionalProperties":false,"required":["type"],"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links."},"type":{"type":"string","title":"Type of Data","description":"The general theme or subject matter of the data being specified.","enum":["source-code","configuration","dataset","definition","other"],"meta:enum":{"source-code":"Any type of code, code snippet, or data-as-code.","configuration":"Parameters or settings that may be used by other components.","dataset":"A collection of data.","definition":"Data that can be used to create new instances of what the definition defines.","other":"Any other type of data that does not fit into existing definitions."}},"name":{"title":"Dataset Name","description":"The name of the dataset.","type":"string"},"contents":{"type":"object","title":"Data Contents","description":"The contents or references to the contents of the data being described.","additionalProperties":false,"properties":{"attachment":{"title":"Data Attachment","description":"An optional way to include textual or encoded data.","$ref":"#/definitions/attachment"},"url":{"type":"string","title":"Data URL","description":"The URL to where the data can be retrieved.","format":"iri-reference"},"properties":{"type":"array","title":"Configuration Properties","description":"Provides the ability to document name-value parameters used for configuration.","items":{"$ref":"#/definitions/property"}}}},"classification":{"$ref":"#/definitions/dataClassification"},"sensitiveData":{"type":"array","title":"Sensitive Data","description":"A description of any sensitive data in a dataset.","items":{"type":"string"}},"graphics":{"$ref":"#/definitions/graphicsCollection"},"description":{"title":"Dataset Description","description":"A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.","type":"string"},"governance":{"title":"Data Governance","$ref":"#/definitions/dataGovernance"}}},"dataGovernance":{"type":"object","title":"Data Governance","description":"Data governance captures information regarding data ownership, stewardship, and custodianship, providing insights into the individuals or entities responsible for managing, overseeing, and safeguarding the data throughout its lifecycle.","additionalProperties":false,"properties":{"custodians":{"type":"array","title":"Data Custodians","description":"Data custodians are responsible for the safe custody, transport, and storage of data.","items":{"$ref":"#/definitions/dataGovernanceResponsibleParty"}},"stewards":{"type":"array","title":"Data Stewards","description":"Data stewards are responsible for data content, context, and associated business rules.","items":{"$ref":"#/definitions/dataGovernanceResponsibleParty"}},"owners":{"type":"array","title":"Data Owners","description":"Data owners are concerned with risk and appropriate access to data.","items":{"$ref":"#/definitions/dataGovernanceResponsibleParty"}}}},"dataGovernanceResponsibleParty":{"type":"object","additionalProperties":false,"properties":{"organization":{"title":"Organization","description":"The organization that is responsible for specific data governance role(s).","$ref":"#/definitions/organizationalEntity"},"contact":{"title":"Individual","description":"The individual that is responsible for specific data governance role(s).","$ref":"#/definitions/organizationalContact"}},"oneOf":[{"required":["organization"]},{"required":["contact"]}]},"graphicsCollection":{"type":"object","title":"Graphics Collection","description":"A collection of graphics that represent various measurements.","additionalProperties":false,"properties":{"description":{"title":"Description","description":"A description of this collection of graphics.","type":"string"},"collection":{"title":"Collection","description":"A collection of graphics.","type":"array","items":{"$ref":"#/definitions/graphic"}}}},"graphic":{"type":"object","title":"Graphic","additionalProperties":false,"properties":{"name":{"title":"Name","description":"The name of the graphic.","type":"string"},"image":{"title":"Graphic Image","description":"The graphic (vector or raster). Base64 encoding must be specified for binary images.","$ref":"#/definitions/attachment"}}},"performanceMetric":{"type":"object","title":"Performance Metric","additionalProperties":false,"properties":{"type":{"title":"Type","description":"The type of performance metric.","type":"string"},"value":{"title":"Value","description":"The value of the performance metric.","type":"string"},"slice":{"title":"Slice","description":"The name of the slice this metric was computed on. By default, assume this metric is not sliced.","type":"string"},"confidenceInterval":{"title":"Confidence Interval","description":"The confidence interval of the metric.","type":"object","additionalProperties":false,"properties":{"lowerBound":{"title":"Lower Bound","description":"The lower bound of the confidence interval.","type":"string"},"upperBound":{"title":"Upper Bound","description":"The upper bound of the confidence interval.","type":"string"}}}}},"risk":{"type":"object","title":"Risk","additionalProperties":false,"properties":{"name":{"title":"Name","description":"The name of the risk.","type":"string"},"mitigationStrategy":{"title":"Mitigation Strategy","description":"Strategy used to address this risk.","type":"string"}}},"fairnessAssessment":{"type":"object","title":"Fairness Assessment","description":"Information about the benefits and harms of the model to an identified at risk group.","additionalProperties":false,"properties":{"groupAtRisk":{"type":"string","title":"Group at Risk","description":"The groups or individuals at risk of being systematically disadvantaged by the model."},"benefits":{"type":"string","title":"Benefits","description":"Expected benefits to the identified groups."},"harms":{"type":"string","title":"Harms","description":"Expected harms to the identified groups."},"mitigationStrategy":{"type":"string","title":"Mitigation Strategy","description":"With respect to the benefits and harms outlined, please describe any mitigation strategy implemented."}}},"dataClassification":{"type":"string","title":"Data Classification","description":"Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed."},"environmentalConsiderations":{"type":"object","title":"Environmental Considerations","description":"Describes various environmental impact metrics.","additionalProperties":false,"properties":{"energyConsumptions":{"title":"Energy Consumptions","description":"Describes energy consumption information incurred for one or more component lifecycle activities.","type":"array","items":{"$ref":"#/definitions/energyConsumption"}},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"energyConsumption":{"title":"Energy consumption","description":"Describes energy consumption information incurred for the specified lifecycle activity.","type":"object","required":["activity","energyProviders","activityEnergyCost"],"additionalProperties":false,"properties":{"activity":{"type":"string","title":"Activity","description":"The type of activity that is part of a machine learning model development or operational lifecycle.","enum":["design","data-collection","data-preparation","training","fine-tuning","validation","deployment","inference","other"],"meta:enum":{"design":"A model design including problem framing, goal definition and algorithm selection.","data-collection":"Model data acquisition including search, selection and transfer.","data-preparation":"Model data preparation including data cleaning, labeling and conversion.","training":"Model building, training and generalized tuning.","fine-tuning":"Refining a trained model to produce desired outputs for a given problem space.","validation":"Model validation including model output evaluation and testing.","deployment":"Explicit model deployment to a target hosting infrastructure.","inference":"Generating an output response from a hosted model from a set of inputs.","other":"A lifecycle activity type whose description does not match currently defined values."}},"energyProviders":{"title":"Energy Providers","description":"The provider(s) of the energy consumed by the associated model development lifecycle activity.","type":"array","items":{"$ref":"#/definitions/energyProvider"}},"activityEnergyCost":{"title":"Activity Energy Cost","description":"The total energy cost associated with the model lifecycle activity.","$ref":"#/definitions/energyMeasure"},"co2CostEquivalent":{"title":"CO2 Equivalent Cost","description":"The CO2 cost (debit) equivalent to the total energy cost.","$ref":"#/definitions/co2Measure"},"co2CostOffset":{"title":"CO2 Cost Offset","description":"The CO2 offset (credit) for the CO2 equivalent cost.","$ref":"#/definitions/co2Measure"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"energyMeasure":{"type":"object","title":"Energy Measure","description":"A measure of energy.","required":["value","unit"],"additionalProperties":false,"properties":{"value":{"type":"number","title":"Value","description":"Quantity of energy."},"unit":{"type":"string","enum":["kWh"],"title":"Unit","description":"Unit of energy.","meta:enum":{"kWh":"Kilowatt-hour (kWh) is the energy delivered by one kilowatt (kW) of power for one hour (h)."}}}},"co2Measure":{"type":"object","title":"CO2 Measure","description":"A measure of carbon dioxide (CO2).","required":["value","unit"],"additionalProperties":false,"properties":{"value":{"type":"number","title":"Value","description":"Quantity of carbon dioxide (CO2)."},"unit":{"type":"string","enum":["tCO2eq"],"title":"Unit","description":"Unit of carbon dioxide (CO2).","meta:enum":{"tCO2eq":"Tonnes (t) of carbon dioxide (CO2) equivalent (eq)."}}}},"energyProvider":{"type":"object","title":"Energy Provider","description":"Describes the physical provider of energy used for model development or operations.","required":["organization","energySource","energyProvided"],"additionalProperties":false,"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the energy provider elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"description":{"type":"string","title":"Description","description":"A description of the energy provider."},"organization":{"type":"object","title":"Organization","description":"The organization that provides energy.","$ref":"#/definitions/organizationalEntity"},"energySource":{"type":"string","enum":["coal","oil","natural-gas","nuclear","wind","solar","geothermal","hydropower","biofuel","unknown","other"],"meta:enum":{"coal":"Energy produced by types of coal.","oil":"Petroleum products (primarily crude oil and its derivative fuel oils).","natural-gas":"Hydrocarbon gas liquids (HGL) that occur as gases at atmospheric pressure and as liquids under higher pressures including Natural gas (C5H12 and heavier), Ethane (C2H6), Propane (C3H8), etc.","nuclear":"Energy produced from the cores of atoms (i.e., through nuclear fission or fusion).","wind":"Energy produced from moving air.","solar":"Energy produced from the sun (i.e., solar radiation).","geothermal":"Energy produced from heat within the earth.","hydropower":"Energy produced from flowing water.","biofuel":"Liquid fuels produced from biomass feedstocks (i.e., organic materials such as plants or animals).","unknown":"The energy source is unknown.","other":"An energy source that is not listed."},"title":"Energy Source","description":"The energy source for the energy provider."},"energyProvided":{"$ref":"#/definitions/energyMeasure","title":"Energy Provided","description":"The energy provided by the energy source for an associated activity."},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."}}},"postalAddress":{"type":"object","title":"Postal address","description":"An address used to identify a contactable location.","additionalProperties":false,"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the address elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"country":{"type":"string","title":"Country","description":"The country name or the two-letter ISO 3166-1 country code."},"region":{"type":"string","title":"Region","description":"The region or state in the country.","examples":["Texas"]},"locality":{"type":"string","title":"Locality","description":"The locality or city within the country.","examples":["Austin"]},"postOfficeBoxNumber":{"type":"string","title":"Post Office Box Number","description":"The post office box number.","examples":["901"]},"postalCode":{"type":"string","title":"Postal Code","description":"The postal code.","examples":["78758"]},"streetAddress":{"type":"string","title":"Street Address","description":"The street address.","examples":["100 Main Street"]}}},"formula":{"title":"Formula","description":"Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.","type":"object","additionalProperties":false,"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the formula elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"components":{"title":"Components","description":"Transient components that are used in tasks that constitute one or more of this formula's workflows","type":"array","items":{"$ref":"#/definitions/component"},"uniqueItems":true},"services":{"title":"Services","description":"Transient services that are used in tasks that constitute one or more of this formula's workflows","type":"array","items":{"$ref":"#/definitions/service"},"uniqueItems":true},"workflows":{"title":"Workflows","description":"List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered.","$comment":"Different workflows can be designed to work together to perform end-to-end CI/CD builds and deployments.","type":"array","items":{"$ref":"#/definitions/workflow"},"uniqueItems":true},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"workflow":{"title":"Workflow","description":"A specialized orchestration task.","$comment":"Workflow are as task themselves and can trigger other workflow tasks. These relationships can be modeled in the taskDependencies graph.","type":"object","required":["bom-ref","uid","taskTypes"],"additionalProperties":false,"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the workflow elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"uid":{"title":"Unique Identifier (UID)","description":"The unique identifier for the resource instance within its deployment context.","type":"string"},"name":{"title":"Name","description":"The name of the resource instance.","type":"string"},"description":{"title":"Description","description":"A description of the resource instance.","type":"string"},"resourceReferences":{"title":"Resource references","description":"References to component or service resources that are used to realize the resource instance.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/resourceReferenceChoice"}},"tasks":{"title":"Tasks","description":"The tasks that comprise the workflow.","$comment":"Note that tasks can appear more than once as different instances (by name or UID).","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/task"}},"taskDependencies":{"title":"Task dependency graph","description":"The graph of dependencies between tasks within the workflow.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/dependency"}},"taskTypes":{"title":"Task types","description":"Indicates the types of activities performed by the set of workflow tasks.","$comment":"Currently, these types reflect common CI/CD actions.","type":"array","items":{"$ref":"#/definitions/taskType"}},"trigger":{"title":"Trigger","description":"The trigger that initiated the task.","$ref":"#/definitions/trigger"},"steps":{"title":"Steps","description":"The sequence of steps for the task.","type":"array","items":{"$ref":"#/definitions/step"},"uniqueItems":true},"inputs":{"title":"Inputs","description":"Represents resources and data brought into a task at runtime by executor or task commands","examples":["a `configuration` file which was declared as a local `component` or `externalReference`"],"type":"array","items":{"$ref":"#/definitions/inputType"},"uniqueItems":true},"outputs":{"title":"Outputs","description":"Represents resources and data output from a task at runtime by executor or task commands","examples":["a log file or metrics data produced by the task"],"type":"array","items":{"$ref":"#/definitions/outputType"},"uniqueItems":true},"timeStart":{"title":"Time start","description":"The date and time (timestamp) when the task started.","type":"string","format":"date-time"},"timeEnd":{"title":"Time end","description":"The date and time (timestamp) when the task ended.","type":"string","format":"date-time"},"workspaces":{"title":"Workspaces","description":"A set of named filesystem or data resource shareable by workflow tasks.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/workspace"}},"runtimeTopology":{"title":"Runtime topology","description":"A graph of the component runtime topology for workflow's instance.","$comment":"A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/dependency"}},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"task":{"title":"Task","description":"Describes the inputs, sequence of steps and resources used to accomplish a task and its output.","$comment":"Tasks are building blocks for constructing assemble CI/CD workflows or pipelines.","type":"object","required":["bom-ref","uid","taskTypes"],"additionalProperties":false,"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the task elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"uid":{"title":"Unique Identifier (UID)","description":"The unique identifier for the resource instance within its deployment context.","type":"string"},"name":{"title":"Name","description":"The name of the resource instance.","type":"string"},"description":{"title":"Description","description":"A description of the resource instance.","type":"string"},"resourceReferences":{"title":"Resource references","description":"References to component or service resources that are used to realize the resource instance.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/resourceReferenceChoice"}},"taskTypes":{"title":"Task types","description":"Indicates the types of activities performed by the set of workflow tasks.","$comment":"Currently, these types reflect common CI/CD actions.","type":"array","items":{"$ref":"#/definitions/taskType"}},"trigger":{"title":"Trigger","description":"The trigger that initiated the task.","$ref":"#/definitions/trigger"},"steps":{"title":"Steps","description":"The sequence of steps for the task.","type":"array","items":{"$ref":"#/definitions/step"},"uniqueItems":true},"inputs":{"title":"Inputs","description":"Represents resources and data brought into a task at runtime by executor or task commands","examples":["a `configuration` file which was declared as a local `component` or `externalReference`"],"type":"array","items":{"$ref":"#/definitions/inputType"},"uniqueItems":true},"outputs":{"title":"Outputs","description":"Represents resources and data output from a task at runtime by executor or task commands","examples":["a log file or metrics data produced by the task"],"type":"array","items":{"$ref":"#/definitions/outputType"},"uniqueItems":true},"timeStart":{"title":"Time start","description":"The date and time (timestamp) when the task started.","type":"string","format":"date-time"},"timeEnd":{"title":"Time end","description":"The date and time (timestamp) when the task ended.","type":"string","format":"date-time"},"workspaces":{"title":"Workspaces","description":"A set of named filesystem or data resource shareable by workflow tasks.","type":"array","items":{"$ref":"#/definitions/workspace"},"uniqueItems":true},"runtimeTopology":{"title":"Runtime topology","description":"A graph of the component runtime topology for task's instance.","$comment":"A description of the runtime component and service topology. This can describe a partial or complete topology used to host and execute the task (e.g., hardware, operating systems, configurations, etc.),","type":"array","items":{"$ref":"#/definitions/dependency"},"uniqueItems":true},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"step":{"type":"object","description":"Executes specific commands or tools in order to accomplish its owning task as part of a sequence.","additionalProperties":false,"properties":{"name":{"title":"Name","description":"A name for the step.","type":"string"},"description":{"title":"Description","description":"A description of the step.","type":"string"},"commands":{"title":"Commands","description":"Ordered list of commands or directives for the step","type":"array","items":{"$ref":"#/definitions/command"}},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"command":{"type":"object","additionalProperties":false,"properties":{"executed":{"title":"Executed","description":"A text representation of the executed command.","type":"string"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"workspace":{"title":"Workspace","description":"A named filesystem or data resource shareable by workflow tasks.","type":"object","required":["bom-ref","uid"],"additionalProperties":false,"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the workspace elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"uid":{"title":"Unique Identifier (UID)","description":"The unique identifier for the resource instance within its deployment context.","type":"string"},"name":{"title":"Name","description":"The name of the resource instance.","type":"string"},"aliases":{"title":"Aliases","description":"The names for the workspace as referenced by other workflow tasks. Effectively, a name mapping so other tasks can use their own local name in their steps.","type":"array","items":{"type":"string"}},"description":{"title":"Description","description":"A description of the resource instance.","type":"string"},"resourceReferences":{"title":"Resource references","description":"References to component or service resources that are used to realize the resource instance.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/resourceReferenceChoice"}},"accessMode":{"title":"Access mode","description":"Describes the read-write access control for the workspace relative to the owning resource instance.","type":"string","enum":["read-only","read-write","read-write-once","write-once","write-only"]},"mountPath":{"title":"Mount path","description":"A path to a location on disk where the workspace will be available to the associated task's steps.","type":"string"},"managedDataType":{"title":"Managed data type","description":"The name of a domain-specific data type the workspace represents.","$comment":"This property is for CI/CD frameworks that are able to provide access to structured, managed data at a more granular level than a filesystem.","examples":["ConfigMap","Secret"],"type":"string"},"volumeRequest":{"title":"Volume request","description":"Identifies the reference to the request for a specific volume type and parameters.","examples":["a kubernetes Persistent Volume Claim (PVC) name"],"type":"string"},"volume":{"title":"Volume","description":"Information about the actual volume instance allocated to the workspace.","$comment":"The actual volume allocated may be different than the request.","examples":["see https://kubernetes.io/docs/concepts/storage/persistent-volumes/"],"$ref":"#/definitions/volume"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"volume":{"title":"Volume","description":"An identifiable, logical unit of data storage tied to a physical device.","type":"object","additionalProperties":false,"properties":{"uid":{"title":"Unique Identifier (UID)","description":"The unique identifier for the volume instance within its deployment context.","type":"string"},"name":{"title":"Name","description":"The name of the volume instance","type":"string"},"mode":{"title":"Mode","description":"The mode for the volume instance.","type":"string","enum":["filesystem","block"],"default":"filesystem"},"path":{"title":"Path","description":"The underlying path created from the actual volume.","type":"string"},"sizeAllocated":{"title":"Size allocated","description":"The allocated size of the volume accessible to the associated workspace. This should include the scalar size as well as IEC standard unit in either decimal or binary form.","examples":["10GB","2Ti","1Pi"],"type":"string"},"persistent":{"title":"Persistent","description":"Indicates if the volume persists beyond the life of the resource it is associated with.","type":"boolean"},"remote":{"title":"Remote","description":"Indicates if the volume is remotely (i.e., network) attached.","type":"boolean"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"trigger":{"title":"Trigger","description":"Represents a resource that can conditionally activate (or fire) tasks based upon associated events and their data.","type":"object","additionalProperties":false,"required":["type","bom-ref","uid"],"properties":{"bom-ref":{"title":"BOM Reference","description":"An optional identifier which can be used to reference the trigger elsewhere in the BOM. Every bom-ref must be unique within the BOM.\nValue SHOULD not start with the BOM-Link intro 'urn:cdx:' to avoid conflicts with BOM-Links.","$ref":"#/definitions/refType"},"uid":{"title":"Unique Identifier (UID)","description":"The unique identifier for the resource instance within its deployment context.","type":"string"},"name":{"title":"Name","description":"The name of the resource instance.","type":"string"},"description":{"title":"Description","description":"A description of the resource instance.","type":"string"},"resourceReferences":{"title":"Resource references","description":"References to component or service resources that are used to realize the resource instance.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/resourceReferenceChoice"}},"type":{"title":"Type","description":"The source type of event which caused the trigger to fire.","type":"string","enum":["manual","api","webhook","scheduled"]},"event":{"title":"Event","description":"The event data that caused the associated trigger to activate.","$ref":"#/definitions/event"},"conditions":{"type":"array","title":"Conditions","description":"A list of conditions used to determine if a trigger should be activated.","uniqueItems":true,"items":{"$ref":"#/definitions/condition"}},"timeActivated":{"title":"Time activated","description":"The date and time (timestamp) when the trigger was activated.","type":"string","format":"date-time"},"inputs":{"title":"Inputs","description":"Represents resources and data brought into a task at runtime by executor or task commands","examples":["a `configuration` file which was declared as a local `component` or `externalReference`"],"type":"array","items":{"$ref":"#/definitions/inputType"},"uniqueItems":true},"outputs":{"title":"Outputs","description":"Represents resources and data output from a task at runtime by executor or task commands","examples":["a log file or metrics data produced by the task"],"type":"array","items":{"$ref":"#/definitions/outputType"},"uniqueItems":true},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"event":{"title":"Event","description":"Represents something that happened that may trigger a response.","type":"object","additionalProperties":false,"properties":{"uid":{"title":"Unique Identifier (UID)","description":"The unique identifier of the event.","type":"string"},"description":{"title":"Description","description":"A description of the event.","type":"string"},"timeReceived":{"title":"Time Received","description":"The date and time (timestamp) when the event was received.","type":"string","format":"date-time"},"data":{"title":"Data","description":"Encoding of the raw event data.","$ref":"#/definitions/attachment"},"source":{"title":"Source","description":"References the component or service that was the source of the event","$ref":"#/definitions/resourceReferenceChoice"},"target":{"title":"Target","description":"References the component or service that was the target of the event","$ref":"#/definitions/resourceReferenceChoice"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"inputType":{"title":"Input type","description":"Type that represents various input data types and formats.","type":"object","oneOf":[{"required":["resource"]},{"required":["parameters"]},{"required":["environmentVars"]},{"required":["data"]}],"additionalProperties":false,"properties":{"source":{"title":"Source","description":"A reference to the component or service that provided the input to the task (e.g., reference to a service with data flow value of `inbound`)","examples":["source code repository","database"],"$ref":"#/definitions/resourceReferenceChoice"},"target":{"title":"Target","description":"A reference to the component or service that received or stored the input if not the task itself (e.g., a local, named storage workspace)","examples":["workspace","directory"],"$ref":"#/definitions/resourceReferenceChoice"},"resource":{"title":"Resource","description":"A reference to an independent resource provided as an input to a task by the workflow runtime.","examples":["a reference to a configuration file in a repository (i.e., a bom-ref)","a reference to a scanning service used in a task (i.e., a bom-ref)"],"$ref":"#/definitions/resourceReferenceChoice"},"parameters":{"title":"Parameters","description":"Inputs that have the form of parameters with names and values.","type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/parameter"}},"environmentVars":{"title":"Environment variables","description":"Inputs that have the form of parameters with names and values.","type":"array","uniqueItems":true,"items":{"oneOf":[{"$ref":"#/definitions/property"},{"type":"string"}]}},"data":{"title":"Data","description":"Inputs that have the form of data.","$ref":"#/definitions/attachment"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"outputType":{"type":"object","oneOf":[{"required":["resource"]},{"required":["environmentVars"]},{"required":["data"]}],"additionalProperties":false,"properties":{"type":{"title":"Type","description":"Describes the type of data output.","type":"string","enum":["artifact","attestation","log","evidence","metrics","other"]},"source":{"title":"Source","description":"Component or service that generated or provided the output from the task (e.g., a build tool)","$ref":"#/definitions/resourceReferenceChoice"},"target":{"title":"Target","description":"Component or service that received the output from the task (e.g., reference to an artifactory service with data flow value of `outbound`)","examples":["a log file described as an `externalReference` within its target domain."],"$ref":"#/definitions/resourceReferenceChoice"},"resource":{"title":"Resource","description":"A reference to an independent resource generated as output by the task.","examples":["configuration file","source code","scanning service"],"$ref":"#/definitions/resourceReferenceChoice"},"data":{"title":"Data","description":"Outputs that have the form of data.","$ref":"#/definitions/attachment"},"environmentVars":{"title":"Environment variables","description":"Outputs that have the form of environment variables.","type":"array","items":{"oneOf":[{"$ref":"#/definitions/property"},{"type":"string"}]},"uniqueItems":true},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"resourceReferenceChoice":{"title":"Resource reference choice","description":"A reference to a locally defined resource (e.g., a bom-ref) or an externally accessible resource.","$comment":"Enables reference to a resource that participates in a workflow; using either internal (bom-ref) or external (externalReference) types.","type":"object","additionalProperties":false,"properties":{"ref":{"title":"BOM Reference","description":"References an object by its bom-ref attribute","anyOf":[{"title":"Ref","$ref":"#/definitions/refLinkType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"externalReference":{"title":"External reference","description":"Reference to an externally accessible resource.","$ref":"#/definitions/externalReference"}},"oneOf":[{"required":["ref"]},{"required":["externalReference"]}]},"condition":{"title":"Condition","description":"A condition that was used to determine a trigger should be activated.","type":"object","additionalProperties":false,"properties":{"description":{"title":"Description","description":"Describes the set of conditions which cause the trigger to activate.","type":"string"},"expression":{"title":"Expression","description":"The logical expression that was evaluated that determined the trigger should be fired.","type":"string"},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}}}},"taskType":{"type":"string","enum":["copy","clone","lint","scan","merge","build","test","deliver","deploy","release","clean","other"],"meta:enum":{"copy":"A task that copies software or data used to accomplish other tasks in the workflow.","clone":"A task that clones a software repository into the workflow in order to retrieve its source code or data for use in a build step.","lint":"A task that checks source code for programmatic and stylistic errors.","scan":"A task that performs a scan against source code, or built or deployed components and services. Scans are typically run to gather or test for security vulnerabilities or policy compliance.","merge":"A task that merges changes or fixes into source code prior to a build step in the workflow.","build":"A task that builds the source code, dependencies and/or data into an artifact that can be deployed to and executed on target systems.","test":"A task that verifies the functionality of a component or service.","deliver":"A task that delivers a built artifact to one or more target repositories or storage systems.","deploy":"A task that deploys a built artifact for execution on one or more target systems.","release":"A task that releases a built, versioned artifact to a target repository or distribution system.","clean":"A task that cleans unnecessary tools, build artifacts and/or data from workflow storage.","other":"A workflow task that does not match current task type definitions."}},"parameter":{"title":"Parameter","description":"A representation of a functional parameter.","type":"object","additionalProperties":false,"properties":{"name":{"title":"Name","description":"The name of the parameter.","type":"string"},"value":{"title":"Value","description":"The value of the parameter.","type":"string"},"dataType":{"title":"Data type","description":"The data type of the parameter.","type":"string"}}},"componentIdentityEvidence":{"type":"object","title":"Identity Evidence","description":"Evidence that substantiates the identity of a component.","required":["field"],"additionalProperties":false,"properties":{"field":{"type":"string","enum":["group","name","version","purl","cpe","omniborId","swhid","swid","hash"],"title":"Field","description":"The identity field of the component which the evidence describes."},"confidence":{"type":"number","minimum":0,"maximum":1,"title":"Confidence","description":"The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence."},"concludedValue":{"type":"string","title":"Concluded Value","description":"The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available)."},"methods":{"type":"array","title":"Methods","description":"The methods used to extract and/or analyze the evidence.","items":{"type":"object","required":["technique","confidence"],"additionalProperties":false,"properties":{"technique":{"title":"Technique","description":"The technique used in this method of analysis.","type":"string","enum":["source-code-analysis","binary-analysis","manifest-analysis","ast-fingerprint","hash-comparison","instrumentation","dynamic-analysis","filename","attestation","other"]},"confidence":{"type":"number","minimum":0,"maximum":1,"title":"Confidence","description":"The confidence of the evidence from 0 - 1, where 1 is 100% confidence. Confidence is specific to the technique used. Each technique of analysis can have independent confidence."},"value":{"type":"string","title":"Value","description":"The value or contents of the evidence."}}}},"tools":{"type":"array","uniqueItems":true,"items":{"anyOf":[{"title":"Ref","$ref":"#/definitions/refLinkType"},{"title":"BOM-Link Element","$ref":"#/definitions/bomLinkElementType"}]},"title":"BOM References","description":"The object in the BOM identified by its bom-ref. This is often a component or service but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation."}}},"standard":{"type":"object","title":"Standard","description":"A standard may consist of regulations, industry or organizational-specific standards, maturity models, best practices, or any other requirements which can be evaluated against or attested to.","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."},"name":{"type":"string","title":"Name","description":"The name of the standard. This will often be a shortened, single name of the standard."},"version":{"type":"string","title":"Version","description":"The version of the standard."},"description":{"type":"string","title":"Description","description":"The description of the standard."},"owner":{"type":"string","title":"Owner","description":"The owner of the standard, often the entity responsible for its release."},"requirements":{"type":"array","title":"Requirements","description":"The list of requirements comprising the standard.","items":{"type":"object","title":"Requirement","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."},"identifier":{"type":"string","title":"Identifier","description":"The unique identifier used in the standard to identify a specific requirement. This should match what is in the standard and should not be the requirements bom-ref."},"title":{"type":"string","title":"Title","description":"The title of the requirement."},"text":{"type":"string","title":"Text","description":"The textual content of the requirement."},"descriptions":{"type":"array","title":"Descriptions","description":"The supplemental text that provides additional guidance or context to the requirement, but is not directly part of the requirement.","items":{"type":"string"}},"openCre":{"type":"array","title":"OWASP OpenCRE Identifier(s)","description":"The Common Requirements Enumeration (CRE) identifier(s). CRE is a structured and standardized framework for uniting security standards and guidelines. CRE links each section of a resource to a shared topic identifier (a Common Requirement). Through this shared topic link, all resources map to each other. Use of CRE promotes clear and unambiguous communication among stakeholders.","items":{"type":"string","pattern":"^CRE:[0-9]+-[0-9]+$","examples":["CRE:764-507"]}},"parent":{"$ref":"#/definitions/refLinkType","title":"Parent BOM Reference","description":"The optional `bom-ref` to a parent requirement. This establishes a hierarchy of requirements. Top-level requirements must not define a parent. Only child requirements should define parents."},"properties":{"type":"array","title":"Properties","description":"Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the [CycloneDX Property Taxonomy](https://github.com/CycloneDX/cyclonedx-property-taxonomy). Formal registration is optional.","items":{"$ref":"#/definitions/property"}},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant, but are not included with the BOM. They may also establish specific relationships within or external to the BOM."}}}},"levels":{"type":"array","title":"Levels","description":"The list of levels associated with the standard. Some standards have different levels of compliance.","items":{"type":"object","title":"Level","additionalProperties":false,"properties":{"bom-ref":{"$ref":"#/definitions/refType","title":"BOM Reference","description":"An optional identifier which can be used to reference the object elsewhere in the BOM. Every bom-ref must be unique within the BOM."},"identifier":{"type":"string","title":"Identifier","description":"The identifier used in the standard to identify a specific level."},"title":{"type":"string","title":"Title","description":"The title of the level."},"description":{"type":"string","title":"Description","description":"The description of the level."},"requirements":{"type":"array","title":"Requirements","description":"The list of requirement `bom-ref`s that comprise the level.","items":{"$ref":"#/definitions/refLinkType"}}}}},"externalReferences":{"type":"array","items":{"$ref":"#/definitions/externalReference"},"title":"External References","description":"External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM."},"signature":{"$ref":"#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."}}},"signature":{"$ref":"jsf-0.82.schema.json#/definitions/signature","title":"Signature","description":"Enveloped signature in [JSON Signature Format (JSF)](https://cyberphone.github.io/doc/security/jsf.html)."},"cryptoProperties":{"type":"object","title":"Cryptographic Properties","description":"Cryptographic assets have properties that uniquely define them and that make them actionable for further reasoning. As an example, it makes a difference if one knows the algorithm family (e.g. AES) or the specific variant or instantiation (e.g. AES-128-GCM). This is because the security level and the algorithm primitive (authenticated encryption) are only defined by the definition of the algorithm variant. The presence of a weak cryptographic algorithm like SHA1 vs. HMAC-SHA1 also makes a difference.","additionalProperties":false,"required":["assetType"],"properties":{"assetType":{"type":"string","title":"Asset Type","description":"Cryptographic assets occur in several forms. Algorithms and protocols are most commonly implemented in specialized cryptographic libraries. They may, however, also be 'hardcoded' in software components. Certificates and related cryptographic material like keys, tokens, secrets or passwords are other cryptographic assets to be modelled.","enum":["algorithm","certificate","protocol","related-crypto-material"],"meta:enum":{"algorithm":"Mathematical function commonly used for data encryption, authentication, and digital signatures.","certificate":"An electronic document that is used to provide the identity or validate a public key.","protocol":"A set of rules and guidelines that govern the behavior and communication with each other.","related-crypto-material":"Other cryptographic assets related to algorithms, certificates, and protocols such as keys and tokens."}},"algorithmProperties":{"type":"object","title":"Algorithm Properties","description":"Additional properties specific to a cryptographic algorithm.","additionalProperties":false,"properties":{"primitive":{"type":"string","title":"primitive","description":"Cryptographic building blocks used in higher-level cryptographic systems and protocols. Primitives represent different cryptographic routines: deterministic random bit generators (drbg, e.g. CTR_DRBG from NIST SP800-90A-r1), message authentication codes (mac, e.g. HMAC-SHA-256), blockciphers (e.g. AES), streamciphers (e.g. Salsa20), signatures (e.g. ECDSA), hash functions (e.g. SHA-256), public-key encryption schemes (pke, e.g. RSA), extended output functions (xof, e.g. SHAKE256), key derivation functions (e.g. pbkdf2), key agreement algorithms (e.g. ECDH), key encapsulation mechanisms (e.g. ML-KEM), authenticated encryption (ae, e.g. AES-GCM) and the combination of multiple algorithms (combiner, e.g. SP800-56Cr2).","enum":["drbg","mac","block-cipher","stream-cipher","signature","hash","pke","xof","kdf","key-agree","kem","ae","combiner","other","unknown"],"meta:enum":{"drbg":"Deterministic Random Bit Generator (DRBG) is a type of pseudorandom number generator designed to produce a sequence of bits from an initial seed value. DRBGs are commonly used in cryptographic applications where reproducibility of random values is important.","mac":"In cryptography, a Message Authentication Code (MAC) is information used for authenticating and integrity-checking a message.","block-cipher":"A block cipher is a symmetric key algorithm that operates on fixed-size blocks of data. It encrypts or decrypts the data in block units, providing confidentiality. Block ciphers are widely used in various cryptographic modes and protocols for secure data transmission.","stream-cipher":"A stream cipher is a symmetric key cipher where plaintext digits are combined with a pseudorandom cipher digit stream (keystream).","signature":"In cryptography, a signature is a digital representation of a message or data that proves its origin, identity, and integrity. Digital signatures are generated using cryptographic algorithms and are widely used for authentication and verification in secure communication.","hash":"A hash function is a mathematical algorithm that takes an input (or 'message') and produces a fixed-size string of characters, which is typically a hash value. Hash functions are commonly used in various cryptographic applications, including data integrity verification and password hashing.","pke":"Public Key Encryption (PKE) is a type of encryption that uses a pair of public and private keys for secure communication. The public key is used for encryption, while the private key is used for decryption. PKE is a fundamental component of public-key cryptography.","xof":"An XOF is an extendable output function that can take arbitrary input and creates a stream of output, up to a limit determined by the size of the internal state of the hash function that underlies the XOF.","kdf":"A Key Derivation Function (KDF) derives key material from another source of entropy while preserving the entropy of the input.","key-agree":"In cryptography, a key-agreement is a protocol whereby two or more parties agree on a cryptographic key in such a way that both influence the outcome.","kem":"A Key Encapsulation Mechanism (KEM) algorithm is a mechanism for transporting random keying material to a recipient using the recipient's public key.","ae":"Authenticated Encryption (AE) is a cryptographic process that provides both confidentiality and data integrity. It ensures that the encrypted data has not been tampered with and comes from a legitimate source. AE is commonly used in secure communication protocols.","combiner":"A combiner aggregates many candidates for a cryptographic primitive and generates a new candidate for the same primitive.","other":"Another primitive type.","unknown":"The primitive is not known."}},"parameterSetIdentifier":{"type":"string","title":"Parameter Set Identifier","description":"An identifier for the parameter set of the cryptographic algorithm. Examples: in AES128, '128' identifies the key length in bits, in SHA256, '256' identifies the digest length, '128' in SHAKE128 identifies its maximum security level in bits, and 'SHA2-128s' identifies a parameter set used in SLH-DSA (FIPS205)."},"curve":{"type":"string","title":"Elliptic Curve","description":"The specific underlying Elliptic Curve (EC) definition employed which is an indicator of the level of security strength, performance and complexity. Absent an authoritative source of curve names, CycloneDX recommends using curve names as defined at [https://neuromancer.sk/std/](https://neuromancer.sk/std/), the source of which can be found at [https://github.com/J08nY/std-curves](https://github.com/J08nY/std-curves)."},"executionEnvironment":{"type":"string","title":"Execution Environment","description":"The target and execution environment in which the algorithm is implemented in.","enum":["software-plain-ram","software-encrypted-ram","software-tee","hardware","other","unknown"],"meta:enum":{"software-plain-ram":"A software implementation running in plain unencrypted RAM.","software-encrypted-ram":"A software implementation running in encrypted RAM.","software-tee":"A software implementation running in a trusted execution environment.","hardware":"A hardware implementation.","other":"Another implementation environment.","unknown":"The execution environment is not known."}},"implementationPlatform":{"type":"string","title":"Implementation platform","description":"The target platform for which the algorithm is implemented. The implementation can be 'generic', running on any platform or for a specific platform.","enum":["generic","x86_32","x86_64","armv7-a","armv7-m","armv8-a","armv8-m","armv9-a","armv9-m","s390x","ppc64","ppc64le","other","unknown"]},"certificationLevel":{"type":"array","title":"Certification Level","description":"The certification that the implementation of the cryptographic algorithm has received, if any. Certifications include revisions and levels of FIPS 140 or Common Criteria of different Extended Assurance Levels (CC-EAL).","items":{"type":"string","enum":["none","fips140-1-l1","fips140-1-l2","fips140-1-l3","fips140-1-l4","fips140-2-l1","fips140-2-l2","fips140-2-l3","fips140-2-l4","fips140-3-l1","fips140-3-l2","fips140-3-l3","fips140-3-l4","cc-eal1","cc-eal1+","cc-eal2","cc-eal2+","cc-eal3","cc-eal3+","cc-eal4","cc-eal4+","cc-eal5","cc-eal5+","cc-eal6","cc-eal6+","cc-eal7","cc-eal7+","other","unknown"],"meta:enum":{"none":"No certification obtained","fips140-1-l1":"FIPS 140-1 Level 1","fips140-1-l2":"FIPS 140-1 Level 2","fips140-1-l3":"FIPS 140-1 Level 3","fips140-1-l4":"FIPS 140-1 Level 4","fips140-2-l1":"FIPS 140-2 Level 1","fips140-2-l2":"FIPS 140-2 Level 2","fips140-2-l3":"FIPS 140-2 Level 3","fips140-2-l4":"FIPS 140-2 Level 4","fips140-3-l1":"FIPS 140-3 Level 1","fips140-3-l2":"FIPS 140-3 Level 2","fips140-3-l3":"FIPS 140-3 Level 3","fips140-3-l4":"FIPS 140-3 Level 4","cc-eal1":"Common Criteria - Evaluation Assurance Level 1","cc-eal1+":"Common Criteria - Evaluation Assurance Level 1 (Augmented)","cc-eal2":"Common Criteria - Evaluation Assurance Level 2","cc-eal2+":"Common Criteria - Evaluation Assurance Level 2 (Augmented)","cc-eal3":"Common Criteria - Evaluation Assurance Level 3","cc-eal3+":"Common Criteria - Evaluation Assurance Level 3 (Augmented)","cc-eal4":"Common Criteria - Evaluation Assurance Level 4","cc-eal4+":"Common Criteria - Evaluation Assurance Level 4 (Augmented)","cc-eal5":"Common Criteria - Evaluation Assurance Level 5","cc-eal5+":"Common Criteria - Evaluation Assurance Level 5 (Augmented)","cc-eal6":"Common Criteria - Evaluation Assurance Level 6","cc-eal6+":"Common Criteria - Evaluation Assurance Level 6 (Augmented)","cc-eal7":"Common Criteria - Evaluation Assurance Level 7","cc-eal7+":"Common Criteria - Evaluation Assurance Level 7 (Augmented)","other":"Another certification","unknown":"The certification level is not known"}}},"mode":{"type":"string","title":"Mode","description":"The mode of operation in which the cryptographic algorithm (block cipher) is used.","enum":["cbc","ecb","ccm","gcm","cfb","ofb","ctr","other","unknown"],"meta:enum":{"cbc":"Cipher block chaining","ecb":"Electronic codebook","ccm":"Counter with cipher block chaining message authentication code","gcm":"Galois/counter","cfb":"Cipher feedback","ofb":"Output feedback","ctr":"Counter","other":"Another mode of operation","unknown":"The mode of operation is not known"}},"padding":{"type":"string","title":"Padding","description":"The padding scheme that is used for the cryptographic algorithm.","enum":["pkcs5","pkcs7","pkcs1v15","oaep","raw","other","unknown"],"meta:enum":{"pkcs5":"Public Key Cryptography Standard: Password-Based Cryptography","pkcs7":"Public Key Cryptography Standard: Cryptographic Message Syntax","pkcs1v15":"Public Key Cryptography Standard: RSA Cryptography v1.5","oaep":"Optimal asymmetric encryption padding","raw":"Raw","other":"Another padding scheme","unknown":"The padding scheme is not known"}},"cryptoFunctions":{"type":"array","title":"Cryptographic functions","description":"The cryptographic functions implemented by the cryptographic algorithm.","items":{"type":"string","enum":["generate","keygen","encrypt","decrypt","digest","tag","keyderive","sign","verify","encapsulate","decapsulate","other","unknown"]}},"classicalSecurityLevel":{"type":"integer","title":"classical security level","description":"The classical security level that a cryptographic algorithm provides (in bits).","minimum":0},"nistQuantumSecurityLevel":{"type":"integer","title":"NIST security strength category","description":"The NIST security strength category as defined in https://csrc.nist.gov/projects/post-quantum-cryptography/post-quantum-cryptography-standardization/evaluation-criteria/security-(evaluation-criteria). A value of 0 indicates that none of the categories are met.","minimum":0,"maximum":6}}},"certificateProperties":{"type":"object","title":"Certificate Properties","description":"Properties for cryptographic assets of asset type 'certificate'","additionalProperties":false,"properties":{"subjectName":{"type":"string","title":"Subject Name","description":"The subject name for the certificate"},"issuerName":{"type":"string","title":"Issuer Name","description":"The issuer name for the certificate"},"notValidBefore":{"type":"string","format":"date-time","title":"Not Valid Before","description":"The date and time according to ISO-8601 standard from which the certificate is valid"},"notValidAfter":{"type":"string","format":"date-time","title":"Not Valid After","description":"The date and time according to ISO-8601 standard from which the certificate is not valid anymore"},"signatureAlgorithmRef":{"$ref":"#/definitions/refType","title":"Algorithm Reference","description":"The bom-ref to signature algorithm used by the certificate"},"subjectPublicKeyRef":{"$ref":"#/definitions/refType","title":"Key reference","description":"The bom-ref to the public key of the subject"},"certificateFormat":{"type":"string","title":"Certificate Format","description":"The format of the certificate","examples":["X.509","PEM","DER","CVC"]},"certificateExtension":{"type":"string","title":"Certificate File Extension","description":"The file extension of the certificate","examples":["crt","pem","cer","der","p12"]}}},"relatedCryptoMaterialProperties":{"type":"object","title":"Related Cryptographic Material Properties","description":"Properties for cryptographic assets of asset type: `related-crypto-material`","additionalProperties":false,"properties":{"type":{"type":"string","title":"relatedCryptoMaterialType","description":"The type for the related cryptographic material","enum":["private-key","public-key","secret-key","key","ciphertext","signature","digest","initialization-vector","nonce","seed","salt","shared-secret","tag","additional-data","password","credential","token","other","unknown"],"meta:enum":{"private-key":"The confidential key of a key pair used in asymmetric cryptography.","public-key":"The non-confidential key of a key pair used in asymmetric cryptography.","secret-key":"A key used to encrypt and decrypt messages in symmetric cryptography.","key":"A piece of information, usually an octet string, which, when processed through a cryptographic algorithm, processes cryptographic data.","ciphertext":"The result of encryption performed on plaintext using an algorithm (or cipher).","signature":"A cryptographic value that is calculated from the data and a key known only by the signer.","digest":"The output of the hash function.","initialization-vector":"A fixed-size random or pseudo-random value used as an input parameter for cryptographic algorithms.","nonce":"A random or pseudo-random number that can only be used once in a cryptographic communication.","seed":"The input to a pseudo-random number generator. Different seeds generate different pseudo-random sequences.","salt":"A value used in a cryptographic process, usually to ensure that the results of computations for one instance cannot be reused by an attacker.","shared-secret":"A piece of data known only to the parties involved, in a secure communication.","tag":"A message authentication code (MAC), sometimes known as an authentication tag, is a short piece of information used for authenticating and integrity-checking a message.","additional-data":"An unspecified collection of data with relevance to cryptographic activity.","password":"A secret word, phrase, or sequence of characters used during authentication or authorization.","credential":"Establishes the identity of a party to communication, usually in the form of cryptographic keys or passwords.","token":"An object encapsulating a security identity.","other":"Another type of cryptographic asset.","unknown":"The type of cryptographic asset is not known."}},"id":{"type":"string","title":"ID","description":"The optional unique identifier for the related cryptographic material."},"state":{"type":"string","title":"State","description":"The key state as defined by NIST SP 800-57.","enum":["pre-activation","active","suspended","deactivated","compromised","destroyed"]},"algorithmRef":{"$ref":"#/definitions/refType","title":"Algorithm Reference","description":"The bom-ref to the algorithm used to generate the related cryptographic material."},"creationDate":{"type":"string","format":"date-time","title":"Creation Date","description":"The date and time (timestamp) when the related cryptographic material was created."},"activationDate":{"type":"string","format":"date-time","title":"Activation Date","description":"The date and time (timestamp) when the related cryptographic material was activated."},"updateDate":{"type":"string","format":"date-time","title":"Update Date","description":"The date and time (timestamp) when the related cryptographic material was updated."},"expirationDate":{"type":"string","format":"date-time","title":"Expiration Date","description":"The date and time (timestamp) when the related cryptographic material expires."},"value":{"type":"string","title":"Value","description":"The associated value of the cryptographic material."},"size":{"type":"integer","title":"Size","description":"The size of the cryptographic asset (in bits)."},"format":{"type":"string","title":"Format","description":"The format of the related cryptographic material (e.g. P8, PEM, DER)."},"securedBy":{"$ref":"#/definitions/securedBy","title":"Secured By","description":"The mechanism by which the cryptographic asset is secured by."}}},"protocolProperties":{"type":"object","title":"Protocol Properties","description":"Properties specific to cryptographic assets of type: `protocol`.","additionalProperties":false,"properties":{"type":{"type":"string","title":"Type","description":"The concrete protocol type.","enum":["tls","ssh","ipsec","ike","sstp","wpa","other","unknown"],"meta:enum":{"tls":"Transport Layer Security","ssh":"Secure Shell","ipsec":"Internet Protocol Security","ike":"Internet Key Exchange","sstp":"Secure Socket Tunneling Protocol","wpa":"Wi-Fi Protected Access","other":"Another protocol type","unknown":"The protocol type is not known"}},"version":{"type":"string","title":"Protocol Version","description":"The version of the protocol.","examples":["1.0","1.2","1.99"]},"cipherSuites":{"type":"array","title":"Cipher Suites","description":"A list of cipher suites related to the protocol.","items":{"$ref":"#/definitions/cipherSuite","title":"Cipher Suite"}},"ikev2TransformTypes":{"type":"object","title":"IKEv2 Transform Types","description":"The IKEv2 transform types supported (types 1-4), defined in [RFC 7296 section 3.3.2](https://www.ietf.org/rfc/rfc7296.html#section-3.3.2), and additional properties.","additionalProperties":false,"properties":{"encr":{"$ref":"#/definitions/cryptoRefArray","title":"Encryption Algorithm (ENCR)","description":"Transform Type 1: encryption algorithms"},"prf":{"$ref":"#/definitions/cryptoRefArray","title":"Pseudorandom Function (PRF)","description":"Transform Type 2: pseudorandom functions"},"integ":{"$ref":"#/definitions/cryptoRefArray","title":"Integrity Algorithm (INTEG)","description":"Transform Type 3: integrity algorithms"},"ke":{"$ref":"#/definitions/cryptoRefArray","title":"Key Exchange Method (KE)","description":"Transform Type 4: Key Exchange Method (KE) per [RFC 9370](https://www.ietf.org/rfc/rfc9370.html), formerly called Diffie-Hellman Group (D-H)."},"esn":{"type":"boolean","title":"Extended Sequence Numbers (ESN)","description":"Specifies if an Extended Sequence Number (ESN) is used."},"auth":{"$ref":"#/definitions/cryptoRefArray","title":"IKEv2 Authentication method","description":"IKEv2 Authentication method"}}},"cryptoRefArray":{"$ref":"#/definitions/cryptoRefArray","title":"Cryptographic References","description":"A list of protocol-related cryptographic assets"}}},"oid":{"type":"string","title":"OID","description":"The object identifier (OID) of the cryptographic asset."}}},"cipherSuite":{"type":"object","title":"Cipher Suite","description":"Object representing a cipher suite","additionalProperties":false,"properties":{"name":{"type":"string","title":"Common Name","description":"A common name for the cipher suite.","examples":["TLS_DHE_RSA_WITH_AES_128_CCM"]},"algorithms":{"type":"array","title":"Related Algorithms","description":"A list of algorithms related to the cipher suite.","items":{"$ref":"#/definitions/refType","title":"Algorithm reference","description":"The bom-ref to algorithm cryptographic asset."}},"identifiers":{"type":"array","title":"Cipher Suite Identifiers","description":"A list of common identifiers for the cipher suite.","items":{"type":"string","title":"identifier","description":"Cipher suite identifier","examples":["0xC0","0x9E"]}}}},"cryptoRefArray":{"type":"array","items":{"$ref":"#/definitions/refType"}},"securedBy":{"type":"object","title":"Secured By","description":"Specifies the mechanism by which the cryptographic asset is secured by","additionalProperties":false,"properties":{"mechanism":{"type":"string","title":"Mechanism","description":"Specifies the mechanism by which the cryptographic asset is secured by.","examples":["HSM","TPM","SGX","Software","None"]},"algorithmRef":{"$ref":"#/definitions/refType","title":"Algorithm Reference","description":"The bom-ref to the algorithm."}}},"tags":{"type":"array","items":{"type":"string"},"title":"Tags","description":"Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.","examples":["json-parser","object-persistence","text-to-image","translation","object-detection"]}}}
|
Provide a JSON object that satisfies the schema "CycloneDX Bill of Materials Standard". Here are the required top‑level fields: bomFormat, specVersion. Return only the valid JSON object.
|
CycloneDX Bill of Materials Standard
|
schema-store
|
schema_store_97
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"allOf\":[{\"$ref\":\"#/definitions/coreProperties\"},{\"anyOf\":[{\"properties\":{\"env\":{\"description\":\"Sets the extractStyles property based on the value of NODE_ENV\",\"type\":\"object\",\"properties\":{\"development\":{\"$ref\":\"#/definitions/extractStyling\"},\"production\":{\"$ref\":\"#/definitions/extractStyling\"}}}},\"not\":{\"properties\":{\"extractStyles\":{}},\"required\":[\"extractStyles\"]}},{\"properties\":{\"extractStyles\":{\"$ref\":\"#/definitions/extractStyling/properties/extractStyles\"}},\"not\":{\"properties\":{\"env\":{}},\"required\":[\"env\"]}}]},{\"required\":[\"bootstrapVersion\",\"styleLoaders\"]}],\"definitions\":{\"extractStyling\":{\"type\":\"object\",\"properties\":{\"extractStyles\":{\"default\":false,\"description\":\"Enables/disables extraction of styles to a standalone CSS file using extract-text-webpack-plugin\",\"type\":\"boolean\"}}},\"coreProperties\":{\"type\":\"object\",\"properties\":{\"appStyles\":{\"description\":\"Import your custom styles here. Usually this endpoint file contains a list of @imports of your application styles.\",\"type\":\"string\"},\"bootstrapCustomizations\":{\"description\":\"The .scss file path to be loaded after Bootstrap's _variables.scss file\",\"type\":\"string\"},\"bootstrapVersion\":{\"default\":3,\"description\":\"The major version of Bootstrap being used\",\"enum\":[3,4],\"type\":\"integer\"},\"loglevel\":{\"description\":\"The verbosity of logging. Exclude this property to disable.\",\"enum\":[\"debug\"],\"type\":\"string\"},\"preBootstrapCustomizations\":{\"description\":\"The .scss file path to be loaded before Bootstrap's _variables.scss file\",\"type\":\"string\"},\"scripts\":{\"description\":\"Excludes/includes Bootstrap's JavaScript modules\",\"type\":[\"boolean\",\"object\"]},\"styleLoaders\":{\"default\":[\"style\",\"css\",\"sass\"],\"description\":\"An array of Webpack loader names. Order matters, and sass-loader is required.\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"type\":\"array\",\"uniqueItems\":true},\"styles\":{\"description\":\"Excludes/includes Bootstrap's CSS modules\",\"type\":[\"boolean\",\"object\"]},\"useCustomIconFontPath\":{\"default\":false,\"description\":\"Set to true if using a custom icon font and you need to specify its path in your Sass files\",\"type\":\"boolean\"},\"useFlexbox\":{\"default\":true,\"description\":\"Enables/disables the flexbox model available in Bootstrap 4\",\"type\":\"boolean\"}}}},\"id\":\"https://json.schemastore.org/bootstraprc.json\",\"title\":\"JSON schema for Webpack's bootstrap-loader configuration file\",\"type\":\"object\"}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"JSON schema for Webpack's bootstrap-loader configuration file\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-04/schema#","allOf":[{"$ref":"#/definitions/coreProperties"},{"anyOf":[{"properties":{"env":{"description":"Sets the extractStyles property based on the value of NODE_ENV","type":"object","properties":{"development":{"$ref":"#/definitions/extractStyling"},"production":{"$ref":"#/definitions/extractStyling"}}}},"not":{"properties":{"extractStyles":{}},"required":["extractStyles"]}},{"properties":{"extractStyles":{"$ref":"#/definitions/extractStyling/properties/extractStyles"}},"not":{"properties":{"env":{}},"required":["env"]}}]},{"required":["bootstrapVersion","styleLoaders"]}],"definitions":{"extractStyling":{"type":"object","properties":{"extractStyles":{"default":false,"description":"Enables/disables extraction of styles to a standalone CSS file using extract-text-webpack-plugin","type":"boolean"}}},"coreProperties":{"type":"object","properties":{"appStyles":{"description":"Import your custom styles here. Usually this endpoint file contains a list of @imports of your application styles.","type":"string"},"bootstrapCustomizations":{"description":"The .scss file path to be loaded after Bootstrap's _variables.scss file","type":"string"},"bootstrapVersion":{"default":3,"description":"The major version of Bootstrap being used","enum":[3,4],"type":"integer"},"loglevel":{"description":"The verbosity of logging. Exclude this property to disable.","enum":["debug"],"type":"string"},"preBootstrapCustomizations":{"description":"The .scss file path to be loaded before Bootstrap's _variables.scss file","type":"string"},"scripts":{"description":"Excludes/includes Bootstrap's JavaScript modules","type":["boolean","object"]},"styleLoaders":{"default":["style","css","sass"],"description":"An array of Webpack loader names. Order matters, and sass-loader is required.","items":{"type":"string"},"minItems":1,"type":"array","uniqueItems":true},"styles":{"description":"Excludes/includes Bootstrap's CSS modules","type":["boolean","object"]},"useCustomIconFontPath":{"default":false,"description":"Set to true if using a custom icon font and you need to specify its path in your Sass files","type":"boolean"},"useFlexbox":{"default":true,"description":"Enables/disables the flexbox model available in Bootstrap 4","type":"boolean"}}}},"id":"https://json.schemastore.org/bootstraprc.json","title":"JSON schema for Webpack's bootstrap-loader configuration file","type":"object"}
|
Provide a JSON object that satisfies the schema "JSON schema for Webpack's bootstrap-loader configuration file". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
JSON schema for Webpack's bootstrap-loader configuration file
|
schema-store
|
schema_store_98
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/bosh-cpi-config.json\",\"$comment\":\"This schema was built from information on https://bosh.io/docs/cpi-config/ and https://github.com/cloudfoundry/bosh/blob/0bb56927d04d3ce2b7f9d4283a9acd5ee2d6aaf3/src/bosh-director/lib/bosh/director/cpi_config/cpi.rb.\",\"$ref\":\"#/definitions/CPIConfig\",\"definitions\":{\"CPIConfig\":{\"type\":\"object\",\"title\":\"BOSH Director CPI Config\",\"description\":\"To define CPIs and CPI-specific properties for a BOSH Director.\\n\\nIntroduced in: v261\",\"properties\":{\"cpis\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/CPIs\"}}}},\"CPIs\":{\"type\":\"object\",\"required\":[\"name\",\"type\"],\"properties\":{\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"exec_path\":{\"type\":\"string\"},\"migrated_from\":{\"$ref\":\"#/definitions/MigratedFrom\"},\"properties\":{\"type\":\"object\"}}},\"MigratedFrom\":{\"type\":\"array\",\"description\":\"Allows for reusing IaaS resources from existing CPI configurations (such as pre-CPI config by using the special \\\"\\\" CPI name) without needing to re-upload stemcells or recreate all resources immediately.\\n\\nIntroduced in: v262.8.0 (https://github.com/cloudfoundry/bosh/commit/1a98a964f9c0238ba6a9b330e20a266cde9370c0)\",\"items\":{\"type\":\"object\",\"required\":[\"name\"],\"properties\":{\"name\":{\"type\":\"string\"}}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"bosh-cpi-config\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/bosh-cpi-config.json","$comment":"This schema was built from information on https://bosh.io/docs/cpi-config/ and https://github.com/cloudfoundry/bosh/blob/0bb56927d04d3ce2b7f9d4283a9acd5ee2d6aaf3/src/bosh-director/lib/bosh/director/cpi_config/cpi.rb.","$ref":"#/definitions/CPIConfig","definitions":{"CPIConfig":{"type":"object","title":"BOSH Director CPI Config","description":"To define CPIs and CPI-specific properties for a BOSH Director.\n\nIntroduced in: v261","properties":{"cpis":{"type":"array","items":{"$ref":"#/definitions/CPIs"}}}},"CPIs":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string"},"type":{"type":"string"},"exec_path":{"type":"string"},"migrated_from":{"$ref":"#/definitions/MigratedFrom"},"properties":{"type":"object"}}},"MigratedFrom":{"type":"array","description":"Allows for reusing IaaS resources from existing CPI configurations (such as pre-CPI config by using the special \"\" CPI name) without needing to re-upload stemcells or recreate all resources immediately.\n\nIntroduced in: v262.8.0 (https://github.com/cloudfoundry/bosh/commit/1a98a964f9c0238ba6a9b330e20a266cde9370c0)","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}}}}}}
|
Provide a JSON object that satisfies the schema "bosh-cpi-config". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
bosh-cpi-config
|
schema-store
|
schema_store_99
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://json.schemastore.org/bosh-deploy-config.json\",\"$comment\":\"This schema was built from information on https://bosh.io/docs/deploy-config/ and https://github.com/cloudfoundry/bosh-cli/pull/634.\",\"$ref\":\"#/definitions/DeployConfig\",\"definitions\":{\"DeployConfig\":{\"type\":\"object\",\"title\":\"BOSH CLI Deploy Config\",\"description\":\"A config to enable `bosh deploy` flags on a BOSH Director-wide or per-deployment basis.\",\"anyOf\":[{\"additionalProperties\":false,\"required\":[\"flags\"],\"properties\":{\"flags\":{\"$ref\":\"#/definitions/Flags\"},\"exclude\":{\"$ref\":\"#/definitions/Deployments\"}}},{\"additionalProperties\":false,\"required\":[\"flags\"],\"properties\":{\"flags\":{\"$ref\":\"#/definitions/Flags\"},\"include\":{\"$ref\":\"#/definitions/Deployments\"}}}]},\"Flags\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"regex\",\"pattern\":\"^(fix|fix-releases|recreate|recreate-persistent-disks)$\"}},\"Deployments\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"bosh-deploy-config\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/bosh-deploy-config.json","$comment":"This schema was built from information on https://bosh.io/docs/deploy-config/ and https://github.com/cloudfoundry/bosh-cli/pull/634.","$ref":"#/definitions/DeployConfig","definitions":{"DeployConfig":{"type":"object","title":"BOSH CLI Deploy Config","description":"A config to enable `bosh deploy` flags on a BOSH Director-wide or per-deployment basis.","anyOf":[{"additionalProperties":false,"required":["flags"],"properties":{"flags":{"$ref":"#/definitions/Flags"},"exclude":{"$ref":"#/definitions/Deployments"}}},{"additionalProperties":false,"required":["flags"],"properties":{"flags":{"$ref":"#/definitions/Flags"},"include":{"$ref":"#/definitions/Deployments"}}}]},"Flags":{"type":"array","items":{"type":"string","format":"regex","pattern":"^(fix|fix-releases|recreate|recreate-persistent-disks)$"}},"Deployments":{"type":"array","items":{"type":"string"}}}}
|
Provide a JSON object that satisfies the schema "bosh-deploy-config". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
bosh-deploy-config
|
schema-store
|
schema_store_100
|
[
{
"from": "system",
"value": "You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:\n<schema>\n{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"$id\":\"https://github.com/ClementTsang/bottom/blob/main/schema/v0.10/bottom.json\",\"title\":\"Schema for bottom's configs (v0.10)\",\"description\":\"https://clementtsang.github.io/bottom/0.10.0/configuration/config-file/\",\"type\":\"object\",\"properties\":{\"cpu\":{\"anyOf\":[{\"$ref\":\"#/definitions/CpuConfig\"},{\"type\":\"null\"}]},\"disk\":{\"anyOf\":[{\"$ref\":\"#/definitions/DiskConfig\"},{\"type\":\"null\"}]},\"flags\":{\"anyOf\":[{\"$ref\":\"#/definitions/FlagConfig\"},{\"type\":\"null\"}]},\"network\":{\"anyOf\":[{\"$ref\":\"#/definitions/NetworkConfig\"},{\"type\":\"null\"}]},\"processes\":{\"anyOf\":[{\"$ref\":\"#/definitions/ProcessesConfig\"},{\"type\":\"null\"}]},\"row\":{\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/row\"}},\"styles\":{\"anyOf\":[{\"$ref\":\"#/definitions/StyleConfig\"},{\"type\":\"null\"}]},\"temperature\":{\"anyOf\":[{\"$ref\":\"#/definitions/TempConfig\"},{\"type\":\"null\"}]}},\"definitions\":{\"BatteryStyle\":{\"description\":\"Styling specific to the battery widget.\",\"type\":\"object\",\"properties\":{\"high_battery_color\":{\"description\":\"The colour of the battery widget bar when the battery is over 50%.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"low_battery_color\":{\"description\":\"The colour of the battery widget bar when the battery is under 10%.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"medium_battery_color\":{\"description\":\"The colour of the battery widget bar when the battery between 10% to 50%.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]}}},\"ColorStr\":{\"type\":\"string\"},\"CpuConfig\":{\"description\":\"CPU column settings.\",\"type\":\"object\",\"properties\":{\"default\":{\"$ref\":\"#/definitions/CpuDefault\"}}},\"CpuDefault\":{\"description\":\"The default selection of the CPU widget. If the given selection is invalid, we will fall back to all.\",\"type\":\"string\",\"enum\":[\"all\",\"average\"]},\"CpuStyle\":{\"description\":\"Styling specific to the CPU widget.\",\"type\":\"object\",\"properties\":{\"all_entry_color\":{\"description\":\"The colour of the \\\"All\\\" CPU label.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"avg_entry_color\":{\"description\":\"The colour of the average CPU label and graph line.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"cpu_core_colors\":{\"description\":\"Colour of each CPU threads' label and graph line. Read in order.\",\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/ColorStr\"}}}},\"DiskConfig\":{\"description\":\"Disk configuration.\",\"type\":\"object\",\"properties\":{\"mount_filter\":{\"description\":\"A filter over the mount names.\",\"anyOf\":[{\"$ref\":\"#/definitions/IgnoreList\"},{\"type\":\"null\"}]},\"name_filter\":{\"description\":\"A filter over the disk names.\",\"anyOf\":[{\"$ref\":\"#/definitions/IgnoreList\"},{\"type\":\"null\"}]}}},\"FinalWidget\":{\"description\":\"Represents a widget.\",\"type\":\"object\",\"required\":[\"type\"],\"properties\":{\"default\":{\"type\":[\"boolean\",\"null\"]},\"ratio\":{\"type\":[\"integer\",\"null\"],\"format\":\"uint32\",\"minimum\":0.0},\"type\":{\"type\":\"string\"}}},\"FlagConfig\":{\"type\":\"object\",\"properties\":{\"autohide_time\":{\"type\":[\"boolean\",\"null\"]},\"basic\":{\"type\":[\"boolean\",\"null\"]},\"battery\":{\"type\":[\"boolean\",\"null\"]},\"case_sensitive\":{\"type\":[\"boolean\",\"null\"]},\"cpu_left_legend\":{\"type\":[\"boolean\",\"null\"]},\"current_usage\":{\"type\":[\"boolean\",\"null\"]},\"default_time_value\":{\"anyOf\":[{\"$ref\":\"#/definitions/StringOrNum\"},{\"type\":\"null\"}]},\"default_widget_count\":{\"type\":[\"integer\",\"null\"],\"format\":\"uint64\",\"minimum\":0.0},\"default_widget_type\":{\"type\":[\"string\",\"null\"]},\"disable_advanced_kill\":{\"type\":[\"boolean\",\"null\"]},\"disable_click\":{\"type\":[\"boolean\",\"null\"]},\"dot_marker\":{\"type\":[\"boolean\",\"null\"]},\"enable_cache_memory\":{\"type\":[\"boolean\",\"null\"]},\"enable_gpu\":{\"type\":[\"boolean\",\"null\"]},\"expanded\":{\"type\":[\"boolean\",\"null\"]},\"group_processes\":{\"type\":[\"boolean\",\"null\"]},\"hide_avg_cpu\":{\"type\":[\"boolean\",\"null\"]},\"hide_table_gap\":{\"type\":[\"boolean\",\"null\"]},\"hide_time\":{\"type\":[\"boolean\",\"null\"]},\"memory_legend\":{\"type\":[\"string\",\"null\"]},\"network_legend\":{\"type\":[\"string\",\"null\"]},\"network_use_binary_prefix\":{\"type\":[\"boolean\",\"null\"]},\"network_use_bytes\":{\"type\":[\"boolean\",\"null\"]},\"network_use_log\":{\"type\":[\"boolean\",\"null\"]},\"no_write\":{\"type\":[\"boolean\",\"null\"]},\"process_command\":{\"type\":[\"boolean\",\"null\"]},\"process_memory_as_value\":{\"type\":[\"boolean\",\"null\"]},\"rate\":{\"anyOf\":[{\"$ref\":\"#/definitions/StringOrNum\"},{\"type\":\"null\"}]},\"regex\":{\"type\":[\"boolean\",\"null\"]},\"retention\":{\"anyOf\":[{\"$ref\":\"#/definitions/StringOrNum\"},{\"type\":\"null\"}]},\"show_table_scroll_position\":{\"type\":[\"boolean\",\"null\"]},\"temperature_type\":{\"type\":[\"string\",\"null\"]},\"time_delta\":{\"anyOf\":[{\"$ref\":\"#/definitions/StringOrNum\"},{\"type\":\"null\"}]},\"tree\":{\"type\":[\"boolean\",\"null\"]},\"unnormalized_cpu\":{\"type\":[\"boolean\",\"null\"]},\"use_old_network_legend\":{\"type\":[\"boolean\",\"null\"]},\"whole_word\":{\"type\":[\"boolean\",\"null\"]}}},\"GraphStyle\":{\"description\":\"General styling for graph widgets.\",\"type\":\"object\",\"properties\":{\"graph_color\":{\"description\":\"The general colour of the parts of the graph.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"legend_text\":{\"description\":\"Text styling for graph's legend text.\",\"anyOf\":[{\"$ref\":\"#/definitions/TextStyleConfig\"},{\"type\":\"null\"}]}}},\"IgnoreList\":{\"type\":\"object\",\"required\":[\"list\"],\"properties\":{\"case_sensitive\":{\"default\":false,\"type\":\"boolean\"},\"is_list_ignored\":{\"default\":true,\"type\":\"boolean\"},\"list\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"regex\":{\"default\":false,\"type\":\"boolean\"},\"whole_word\":{\"default\":false,\"type\":\"boolean\"}}},\"MemoryStyle\":{\"description\":\"Styling specific to the memory widget.\",\"type\":\"object\",\"properties\":{\"arc_color\":{\"description\":\"The colour of the ARC label and graph line.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"cache_color\":{\"description\":\"The colour of the cache label and graph line. Does not do anything on Windows.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"gpu_colors\":{\"description\":\"Colour of each GPU's memory label and graph line. Read in order.\",\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/ColorStr\"}},\"ram_color\":{\"description\":\"The colour of the RAM label and graph line.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"swap_color\":{\"description\":\"The colour of the swap label and graph line.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]}}},\"NetworkConfig\":{\"description\":\"Network configuration.\",\"type\":\"object\",\"properties\":{\"interface_filter\":{\"description\":\"A filter over the network interface names.\",\"anyOf\":[{\"$ref\":\"#/definitions/IgnoreList\"},{\"type\":\"null\"}]}}},\"NetworkStyle\":{\"description\":\"Styling specific to the network widget.\",\"type\":\"object\",\"properties\":{\"rx_color\":{\"description\":\"The colour of the RX (download) label and graph line.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"rx_total_color\":{\"description\":\"he colour of the total RX (download) label in basic mode.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"tx_color\":{\"description\":\"The colour of the TX (upload) label and graph line.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"tx_total_color\":{\"description\":\"The colour of the total TX (upload) label in basic mode.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]}}},\"ProcColumn\":{\"description\":\"A column in the process widget.\",\"type\":\"string\",\"enum\":[\"PID\",\"Count\",\"Name\",\"Command\",\"CPU%\",\"Mem\",\"Mem%\",\"R/s\",\"Read\",\"Rps\",\"W/s\",\"Write\",\"Wps\",\"T.Read\",\"TWrite\",\"T.Write\",\"TRead\",\"State\",\"User\",\"Time\",\"GMem\",\"GMem%\",\"GPU%\"]},\"ProcessesConfig\":{\"description\":\"Process configuration.\",\"type\":\"object\",\"properties\":{\"columns\":{\"description\":\"A list of process widget columns.\",\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/ProcColumn\"}}}},\"RowChildren\":{\"description\":\"Represents a child of a Row - either a Col (column) or a FinalWidget.\\n\\nA Col can also have an optional length and children. We only allow columns to have FinalWidgets as children, lest we get some amount of mutual recursion between Row and Col.\",\"anyOf\":[{\"$ref\":\"#/definitions/FinalWidget\"},{\"type\":\"object\",\"required\":[\"child\"],\"properties\":{\"child\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/FinalWidget\"}},\"ratio\":{\"type\":[\"integer\",\"null\"],\"format\":\"uint32\",\"minimum\":0.0}}}]},\"StringOrNum\":{\"anyOf\":[{\"type\":\"string\"},{\"type\":\"integer\",\"format\":\"uint64\",\"minimum\":0.0}]},\"StyleConfig\":{\"description\":\"Style-related configs.\",\"type\":\"object\",\"properties\":{\"battery\":{\"description\":\"Styling for the battery widget.\",\"anyOf\":[{\"$ref\":\"#/definitions/BatteryStyle\"},{\"type\":\"null\"}]},\"cpu\":{\"description\":\"Styling for the CPU widget.\",\"anyOf\":[{\"$ref\":\"#/definitions/CpuStyle\"},{\"type\":\"null\"}]},\"graphs\":{\"description\":\"Styling for graph widgets.\",\"anyOf\":[{\"$ref\":\"#/definitions/GraphStyle\"},{\"type\":\"null\"}]},\"memory\":{\"description\":\"Styling for the memory widget.\",\"anyOf\":[{\"$ref\":\"#/definitions/MemoryStyle\"},{\"type\":\"null\"}]},\"network\":{\"description\":\"Styling for the network widget.\",\"anyOf\":[{\"$ref\":\"#/definitions/NetworkStyle\"},{\"type\":\"null\"}]},\"tables\":{\"description\":\"Styling for table widgets.\",\"anyOf\":[{\"$ref\":\"#/definitions/TableStyle\"},{\"type\":\"null\"}]},\"theme\":{\"description\":\"A built-in theme.\\n\\nIf this is and a custom colour are both set, in the config file, the custom colour scheme will be prioritized first. If a theme is set in the command-line args, however, it will always be prioritized first.\",\"type\":[\"string\",\"null\"]},\"widgets\":{\"description\":\"Styling for general widgets.\",\"anyOf\":[{\"$ref\":\"#/definitions/WidgetStyle\"},{\"type\":\"null\"}]}}},\"TableStyle\":{\"description\":\"General styling for table widgets.\",\"type\":\"object\",\"properties\":{\"headers\":{\"description\":\"Text styling for table headers.\",\"anyOf\":[{\"$ref\":\"#/definitions/TextStyleConfig\"},{\"type\":\"null\"}]}}},\"TempConfig\":{\"description\":\"Temperature configuration.\",\"type\":\"object\",\"properties\":{\"sensor_filter\":{\"description\":\"A filter over the sensor names.\",\"anyOf\":[{\"$ref\":\"#/definitions/IgnoreList\"},{\"type\":\"null\"}]}}},\"TextStyleConfig\":{\"description\":\"A style for text.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"object\",\"properties\":{\"bg_color\":{\"description\":\"A built-in ANSI colour, RGB hex, or RGB colour code.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"bold\":{\"description\":\"Whether to make this text bolded or not. If not set, will default to built-in defaults.\",\"type\":[\"boolean\",\"null\"]},\"color\":{\"description\":\"A built-in ANSI colour, RGB hex, or RGB colour code.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"italics\":{\"description\":\"Whether to make this text italicized or not. If not set, will default to built-in defaults.\",\"type\":[\"boolean\",\"null\"]}}}]},\"WidgetStyle\":{\"description\":\"General styling for generic widgets.\",\"type\":\"object\",\"properties\":{\"border_color\":{\"description\":\"The colour of the widgets' borders.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"disabled_text\":{\"description\":\"Text styling for text when representing something that is disabled.\",\"anyOf\":[{\"$ref\":\"#/definitions/TextStyleConfig\"},{\"type\":\"null\"}]},\"selected_border_color\":{\"description\":\"The colour of a widget's borders when the widget is selected.\",\"anyOf\":[{\"$ref\":\"#/definitions/ColorStr\"},{\"type\":\"null\"}]},\"selected_text\":{\"description\":\"Text styling for text when representing something that is selected.\",\"anyOf\":[{\"$ref\":\"#/definitions/TextStyleConfig\"},{\"type\":\"null\"}]},\"text\":{\"description\":\"Text styling for text in general.\",\"anyOf\":[{\"$ref\":\"#/definitions/TextStyleConfig\"},{\"type\":\"null\"}]},\"widget_title\":{\"description\":\"Text styling for a widget's title.\",\"anyOf\":[{\"$ref\":\"#/definitions/TextStyleConfig\"},{\"type\":\"null\"}]}}},\"row\":{\"description\":\"Represents a row. This has a length of some sort (optional) and a vector of children.\",\"type\":\"object\",\"properties\":{\"child\":{\"type\":[\"array\",\"null\"],\"items\":{\"$ref\":\"#/definitions/RowChildren\"}},\"ratio\":{\"type\":[\"integer\",\"null\"],\"format\":\"uint32\",\"minimum\":0.0}}}}}\n</schema>"
},
{
"from": "human",
"value": "Provide a JSON object that satisfies the schema \"Schema for bottom's configs (v0.10)\". Here are the required top‑level fields: none (all optional). Return only the valid JSON object."
},
{
"from": "gpt",
"value": ""
}
] |
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://github.com/ClementTsang/bottom/blob/main/schema/v0.10/bottom.json","title":"Schema for bottom's configs (v0.10)","description":"https://clementtsang.github.io/bottom/0.10.0/configuration/config-file/","type":"object","properties":{"cpu":{"anyOf":[{"$ref":"#/definitions/CpuConfig"},{"type":"null"}]},"disk":{"anyOf":[{"$ref":"#/definitions/DiskConfig"},{"type":"null"}]},"flags":{"anyOf":[{"$ref":"#/definitions/FlagConfig"},{"type":"null"}]},"network":{"anyOf":[{"$ref":"#/definitions/NetworkConfig"},{"type":"null"}]},"processes":{"anyOf":[{"$ref":"#/definitions/ProcessesConfig"},{"type":"null"}]},"row":{"type":["array","null"],"items":{"$ref":"#/definitions/row"}},"styles":{"anyOf":[{"$ref":"#/definitions/StyleConfig"},{"type":"null"}]},"temperature":{"anyOf":[{"$ref":"#/definitions/TempConfig"},{"type":"null"}]}},"definitions":{"BatteryStyle":{"description":"Styling specific to the battery widget.","type":"object","properties":{"high_battery_color":{"description":"The colour of the battery widget bar when the battery is over 50%.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"low_battery_color":{"description":"The colour of the battery widget bar when the battery is under 10%.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"medium_battery_color":{"description":"The colour of the battery widget bar when the battery between 10% to 50%.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]}}},"ColorStr":{"type":"string"},"CpuConfig":{"description":"CPU column settings.","type":"object","properties":{"default":{"$ref":"#/definitions/CpuDefault"}}},"CpuDefault":{"description":"The default selection of the CPU widget. If the given selection is invalid, we will fall back to all.","type":"string","enum":["all","average"]},"CpuStyle":{"description":"Styling specific to the CPU widget.","type":"object","properties":{"all_entry_color":{"description":"The colour of the \"All\" CPU label.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"avg_entry_color":{"description":"The colour of the average CPU label and graph line.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"cpu_core_colors":{"description":"Colour of each CPU threads' label and graph line. Read in order.","type":["array","null"],"items":{"$ref":"#/definitions/ColorStr"}}}},"DiskConfig":{"description":"Disk configuration.","type":"object","properties":{"mount_filter":{"description":"A filter over the mount names.","anyOf":[{"$ref":"#/definitions/IgnoreList"},{"type":"null"}]},"name_filter":{"description":"A filter over the disk names.","anyOf":[{"$ref":"#/definitions/IgnoreList"},{"type":"null"}]}}},"FinalWidget":{"description":"Represents a widget.","type":"object","required":["type"],"properties":{"default":{"type":["boolean","null"]},"ratio":{"type":["integer","null"],"format":"uint32","minimum":0.0},"type":{"type":"string"}}},"FlagConfig":{"type":"object","properties":{"autohide_time":{"type":["boolean","null"]},"basic":{"type":["boolean","null"]},"battery":{"type":["boolean","null"]},"case_sensitive":{"type":["boolean","null"]},"cpu_left_legend":{"type":["boolean","null"]},"current_usage":{"type":["boolean","null"]},"default_time_value":{"anyOf":[{"$ref":"#/definitions/StringOrNum"},{"type":"null"}]},"default_widget_count":{"type":["integer","null"],"format":"uint64","minimum":0.0},"default_widget_type":{"type":["string","null"]},"disable_advanced_kill":{"type":["boolean","null"]},"disable_click":{"type":["boolean","null"]},"dot_marker":{"type":["boolean","null"]},"enable_cache_memory":{"type":["boolean","null"]},"enable_gpu":{"type":["boolean","null"]},"expanded":{"type":["boolean","null"]},"group_processes":{"type":["boolean","null"]},"hide_avg_cpu":{"type":["boolean","null"]},"hide_table_gap":{"type":["boolean","null"]},"hide_time":{"type":["boolean","null"]},"memory_legend":{"type":["string","null"]},"network_legend":{"type":["string","null"]},"network_use_binary_prefix":{"type":["boolean","null"]},"network_use_bytes":{"type":["boolean","null"]},"network_use_log":{"type":["boolean","null"]},"no_write":{"type":["boolean","null"]},"process_command":{"type":["boolean","null"]},"process_memory_as_value":{"type":["boolean","null"]},"rate":{"anyOf":[{"$ref":"#/definitions/StringOrNum"},{"type":"null"}]},"regex":{"type":["boolean","null"]},"retention":{"anyOf":[{"$ref":"#/definitions/StringOrNum"},{"type":"null"}]},"show_table_scroll_position":{"type":["boolean","null"]},"temperature_type":{"type":["string","null"]},"time_delta":{"anyOf":[{"$ref":"#/definitions/StringOrNum"},{"type":"null"}]},"tree":{"type":["boolean","null"]},"unnormalized_cpu":{"type":["boolean","null"]},"use_old_network_legend":{"type":["boolean","null"]},"whole_word":{"type":["boolean","null"]}}},"GraphStyle":{"description":"General styling for graph widgets.","type":"object","properties":{"graph_color":{"description":"The general colour of the parts of the graph.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"legend_text":{"description":"Text styling for graph's legend text.","anyOf":[{"$ref":"#/definitions/TextStyleConfig"},{"type":"null"}]}}},"IgnoreList":{"type":"object","required":["list"],"properties":{"case_sensitive":{"default":false,"type":"boolean"},"is_list_ignored":{"default":true,"type":"boolean"},"list":{"type":"array","items":{"type":"string"}},"regex":{"default":false,"type":"boolean"},"whole_word":{"default":false,"type":"boolean"}}},"MemoryStyle":{"description":"Styling specific to the memory widget.","type":"object","properties":{"arc_color":{"description":"The colour of the ARC label and graph line.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"cache_color":{"description":"The colour of the cache label and graph line. Does not do anything on Windows.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"gpu_colors":{"description":"Colour of each GPU's memory label and graph line. Read in order.","type":["array","null"],"items":{"$ref":"#/definitions/ColorStr"}},"ram_color":{"description":"The colour of the RAM label and graph line.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"swap_color":{"description":"The colour of the swap label and graph line.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]}}},"NetworkConfig":{"description":"Network configuration.","type":"object","properties":{"interface_filter":{"description":"A filter over the network interface names.","anyOf":[{"$ref":"#/definitions/IgnoreList"},{"type":"null"}]}}},"NetworkStyle":{"description":"Styling specific to the network widget.","type":"object","properties":{"rx_color":{"description":"The colour of the RX (download) label and graph line.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"rx_total_color":{"description":"he colour of the total RX (download) label in basic mode.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"tx_color":{"description":"The colour of the TX (upload) label and graph line.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"tx_total_color":{"description":"The colour of the total TX (upload) label in basic mode.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]}}},"ProcColumn":{"description":"A column in the process widget.","type":"string","enum":["PID","Count","Name","Command","CPU%","Mem","Mem%","R/s","Read","Rps","W/s","Write","Wps","T.Read","TWrite","T.Write","TRead","State","User","Time","GMem","GMem%","GPU%"]},"ProcessesConfig":{"description":"Process configuration.","type":"object","properties":{"columns":{"description":"A list of process widget columns.","type":"array","items":{"$ref":"#/definitions/ProcColumn"}}}},"RowChildren":{"description":"Represents a child of a Row - either a Col (column) or a FinalWidget.\n\nA Col can also have an optional length and children. We only allow columns to have FinalWidgets as children, lest we get some amount of mutual recursion between Row and Col.","anyOf":[{"$ref":"#/definitions/FinalWidget"},{"type":"object","required":["child"],"properties":{"child":{"type":"array","items":{"$ref":"#/definitions/FinalWidget"}},"ratio":{"type":["integer","null"],"format":"uint32","minimum":0.0}}}]},"StringOrNum":{"anyOf":[{"type":"string"},{"type":"integer","format":"uint64","minimum":0.0}]},"StyleConfig":{"description":"Style-related configs.","type":"object","properties":{"battery":{"description":"Styling for the battery widget.","anyOf":[{"$ref":"#/definitions/BatteryStyle"},{"type":"null"}]},"cpu":{"description":"Styling for the CPU widget.","anyOf":[{"$ref":"#/definitions/CpuStyle"},{"type":"null"}]},"graphs":{"description":"Styling for graph widgets.","anyOf":[{"$ref":"#/definitions/GraphStyle"},{"type":"null"}]},"memory":{"description":"Styling for the memory widget.","anyOf":[{"$ref":"#/definitions/MemoryStyle"},{"type":"null"}]},"network":{"description":"Styling for the network widget.","anyOf":[{"$ref":"#/definitions/NetworkStyle"},{"type":"null"}]},"tables":{"description":"Styling for table widgets.","anyOf":[{"$ref":"#/definitions/TableStyle"},{"type":"null"}]},"theme":{"description":"A built-in theme.\n\nIf this is and a custom colour are both set, in the config file, the custom colour scheme will be prioritized first. If a theme is set in the command-line args, however, it will always be prioritized first.","type":["string","null"]},"widgets":{"description":"Styling for general widgets.","anyOf":[{"$ref":"#/definitions/WidgetStyle"},{"type":"null"}]}}},"TableStyle":{"description":"General styling for table widgets.","type":"object","properties":{"headers":{"description":"Text styling for table headers.","anyOf":[{"$ref":"#/definitions/TextStyleConfig"},{"type":"null"}]}}},"TempConfig":{"description":"Temperature configuration.","type":"object","properties":{"sensor_filter":{"description":"A filter over the sensor names.","anyOf":[{"$ref":"#/definitions/IgnoreList"},{"type":"null"}]}}},"TextStyleConfig":{"description":"A style for text.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"object","properties":{"bg_color":{"description":"A built-in ANSI colour, RGB hex, or RGB colour code.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"bold":{"description":"Whether to make this text bolded or not. If not set, will default to built-in defaults.","type":["boolean","null"]},"color":{"description":"A built-in ANSI colour, RGB hex, or RGB colour code.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"italics":{"description":"Whether to make this text italicized or not. If not set, will default to built-in defaults.","type":["boolean","null"]}}}]},"WidgetStyle":{"description":"General styling for generic widgets.","type":"object","properties":{"border_color":{"description":"The colour of the widgets' borders.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"disabled_text":{"description":"Text styling for text when representing something that is disabled.","anyOf":[{"$ref":"#/definitions/TextStyleConfig"},{"type":"null"}]},"selected_border_color":{"description":"The colour of a widget's borders when the widget is selected.","anyOf":[{"$ref":"#/definitions/ColorStr"},{"type":"null"}]},"selected_text":{"description":"Text styling for text when representing something that is selected.","anyOf":[{"$ref":"#/definitions/TextStyleConfig"},{"type":"null"}]},"text":{"description":"Text styling for text in general.","anyOf":[{"$ref":"#/definitions/TextStyleConfig"},{"type":"null"}]},"widget_title":{"description":"Text styling for a widget's title.","anyOf":[{"$ref":"#/definitions/TextStyleConfig"},{"type":"null"}]}}},"row":{"description":"Represents a row. This has a length of some sort (optional) and a vector of children.","type":"object","properties":{"child":{"type":["array","null"],"items":{"$ref":"#/definitions/RowChildren"}},"ratio":{"type":["integer","null"],"format":"uint32","minimum":0.0}}}}}
|
Provide a JSON object that satisfies the schema "Schema for bottom's configs (v0.10)". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.
|
Schema for bottom's configs (v0.10)
|
schema-store
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.