name
stringlengths 7
62
| content
stringlengths 200
6.79M
|
|---|---|
ruleset_schema.json | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/ansible/ansible-rulebook/main/ansible_rulebook/schema/ruleset_schema.json",
"type": "array",
"items": {
"$ref": "#/$defs/ruleset"
},
"minItems": 1,
"examples": [
"rulebooks/*.yml",
"rulebooks/*.yaml"
],
"$defs": {
"ruleset": {
"type": "object",
"properties": {
"default_events_ttl": {
"type": "string",
"pattern": "^\\d+\\s(seconds?|minutes?|hours?|days?)$"
},
"hosts": {
"type": "string"
},
"gather_facts": {
"type": "boolean",
"default": false
},
"match_multiple_rules": {
"type": "boolean",
"default": false
},
"name": {
"type": "string"
},
"execution_strategy": {
"type": "string",
"enum": [
"parallel",
"sequential"
],
"default": "sequential"
},
"sources": {
"type": "array",
"items": {
"$ref": "#/$defs/source"
}
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/rule"
}
}
},
"required": [
"hosts",
"sources",
"rules"
],
"additionalProperties": false
},
"source": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"filters": {
"type": "array",
"items": {
"type": "object"
}
}
},
"additionalProperties": {
"oneOf": [
{
"type": "object"
},
{
"type": "null"
}
]
}
},
"throttle": {
"type": "object",
"oneOf": [
{
"required": [
"once_within",
"group_by_attributes"
]
},
{
"required": [
"once_after",
"group_by_attributes"
]
}
],
"properties": {
"once_within": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
},
"once_after": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
},
"group_by_attributes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"rule": {
"type": "object",
"oneOf": [
{
"required": [
"name",
"condition",
"actions"
]
},
{
"required": [
"name",
"condition",
"action"
]
}
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"pattern": "\\S"
},
"enabled": {
"type": "boolean"
},
"throttle": {
"$ref": "#/$defs/throttle"
},
"condition": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/all-condition"
},
{
"$ref": "#/$defs/any-condition"
},
{
"$ref": "#/$defs/not-all-condition"
}
]
},
"actions": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/run-playbook-action"
},
{
"$ref": "#/$defs/run-module-action"
},
{
"$ref": "#/$defs/run-job-template-action"
},
{
"$ref": "#/$defs/run-workflow-template-action"
},
{
"$ref": "#/$defs/post-event-action"
},
{
"$ref": "#/$defs/set-fact-action"
},
{
"$ref": "#/$defs/retract-fact-action"
},
{
"$ref": "#/$defs/print-event-action"
},
{
"$ref": "#/$defs/debug-action"
},
{
"$ref": "#/$defs/none-action"
},
{
"$ref": "#/$defs/shutdown-action"
}
]
}
},
"action": {
"oneOf": [
{
"$ref": "#/$defs/run-playbook-action"
},
{
"$ref": "#/$defs/run-module-action"
},
{
"$ref": "#/$defs/run-job-template-action"
},
{
"$ref": "#/$defs/run-workflow-template-action"
},
{
"$ref": "#/$defs/post-event-action"
},
{
"$ref": "#/$defs/set-fact-action"
},
{
"$ref": "#/$defs/retract-fact-action"
},
{
"$ref": "#/$defs/print-event-action"
},
{
"$ref": "#/$defs/debug-action"
},
{
"$ref": "#/$defs/none-action"
},
{
"$ref": "#/$defs/shutdown-action"
}
]
}
},
"additionalProperties": false
},
"all-condition": {
"type": "object",
"properties": {
"all": {
"type": "array",
"items": {
"type": "string"
}
},
"timeout": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
}
},
"additionalProperties": false
},
"not-all-condition": {
"type": "object",
"properties": {
"not_all": {
"type": "array",
"items": {
"type": "string"
}
},
"timeout": {
"type": "string",
"pattern": "^\\d+\\s(milliseconds?|seconds?|minutes?|hours?|days?)$"
}
},
"required": [
"timeout",
"not_all"
],
"additionalProperties": false
},
"any-condition": {
"type": "object",
"properties": {
"any": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"run-playbook-action": {
"type": "object",
"properties": {
"run_playbook": {
"type": "object",
"properties": {
"copy_files": {
"type": "boolean"
},
"name": {
"type": "string"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"ruleset": {
"type": "string"
},
"verbosity": {
"type": "integer"
},
"var_root": {
"type": [
"string",
"object"
]
},
"json_mode": {
"type": "boolean"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "number"
},
"extra_vars": {
"type": "object"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"run_playbook"
],
"additionalProperties": false
},
"run-module-action": {
"type": "object",
"properties": {
"run_module": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"verbosity": {
"type": "integer"
},
"var_root": {
"type": [
"string",
"object"
]
},
"json_mode": {
"type": "boolean"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "number"
},
"module_args": {
"type": [
"object",
"string"
]
},
"extra_vars": {
"type": "object"
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"run_module"
],
"additionalProperties": false
},
"run-job-template-action": {
"type": "object",
"properties": {
"run_job_template": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"organization": {
"type": "string"
},
"job_args": {
"type": "object"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"ruleset": {
"type": "string"
},
"var_root": {
"type": "string"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "integer"
}
},
"required": [
"name",
"organization"
],
"additionalProperties": false
}
},
"required": [
"run_job_template"
],
"additionalProperties": false
},
"run-workflow-template-action": {
"type": "object",
"properties": {
"run_workflow_template": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"organization": {
"type": "string"
},
"job_args": {
"type": "object"
},
"post_events": {
"type": "boolean"
},
"set_facts": {
"type": "boolean"
},
"ruleset": {
"type": "string"
},
"var_root": {
"type": "string"
},
"retry": {
"type": "boolean"
},
"retries": {
"type": "integer"
},
"delay": {
"type": "integer"
}
},
"required": [
"name",
"organization"
],
"additionalProperties": false
}
},
"required": [
"run_workflow_template"
],
"additionalProperties": false
},
"post-event-action": {
"type": "object",
"properties": {
"post_event": {
"type": "object",
"properties": {
"ruleset": {
"type": "string"
},
"event": {
"type": "object"
}
},
"required": [
"event"
],
"additionalProperties": false
}
},
"required": [
"post_event"
],
"additionalProperties": false
},
"set-fact-action": {
"type": "object",
"properties": {
"set_fact": {
"type": "object",
"properties": {
"ruleset": {
"type": "string"
},
"fact": {
"type": "object"
}
},
"required": [
"fact"
],
"additionalProperties": false
}
},
"required": [
"set_fact"
],
"additionalProperties": false
},
"retract-fact-action": {
"type": "object",
"properties": {
"retract_fact": {
"type": "object",
"properties": {
"ruleset": {
"type": "string"
},
"fact": {
"type": "object"
},
"partial": {
"type": "boolean",
"default": true
}
},
"required": [
"fact"
],
"additionalProperties": false
}
},
"required": [
"retract_fact"
],
"additionalProperties": false
},
"print-event-action": {
"type": "object",
"properties": {
"print_event": {
"type": [
"object",
"null"
],
"properties": {
"var_root": {
"type": [
"string",
"object"
]
},
"pretty": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"print_event"
],
"additionalProperties": false
},
"debug-msg": {
"type": "object",
"properties": {
"msg": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"additionalProperties": false
},
"debug-var": {
"type": "object",
"properties": {
"var": {
"type": "string"
}
},
"additionalProperties": false
},
"debug-action": {
"type": "object",
"properties": {
"debug": {
"anyOf": [
{
"$ref": "#/$defs/debug-msg"
},
{
"$ref": "#/$defs/debug-var"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"required": [
"debug"
]
},
"none-action": {
"type": "object",
"properties": {
"none": {
"type": [
"object",
"null"
]
}
},
"required": [
"none"
],
"additionalProperties": false
},
"shutdown-action": {
"type": "object",
"properties": {
"shutdown": {
"type": [
"object",
"null"
],
"properties": {
"delay": {
"type": "number"
},
"message": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"graceful",
"now"
]
}
},
"additionalProperties": false
}
},
"required": [
"shutdown"
],
"additionalProperties": false
}
}
}
|
paf-module.schema.json | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"line_endings": "unix",
"$id": "https://qualisys.com/schemas/paf-module",
"title": "Qualisys PAF Module",
"description": "A settings.paf file used by Qualisys Project Automation Framework (PAF) Modules",
"type": "object",
"properties": {
"Project ID": {
"title": "Project ID",
"description": "A human readable name that identifies the project. This name is recorded in data files and should not be changed once data collection has started as doing so will render data files useless.",
"type": "string"
},
"Root type": {
"title": "Root type",
"description": "Reference to the class or type name to use at the highest level in the PAF item hierarchy.",
"type": "string"
},
"Date format": {
"title": "Date format",
"description": "Specifies what date format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are Iso, Little endian and Middle endian.",
"enum": ["Iso", "Little endian", "Middle endian"]
},
"Date separator": {
"title": "Date separator",
"description": "Specifies which token to use to separate the parts of the dates when formatting them. Accepted values are Dash, Slash, Dot and None.",
"enum": ["Dash", "Slash", "Dot", "None"]
},
"Time format": {
"title": "Time format",
"description": "Specifies what time format to use in this project. Applies mainly to exports and column values but not to the field edit dialog. Accepted values are 12-hour and 24-hour.",
"enum": ["12-hour", "24-hour"]
},
"Filename filter": {
"title": "Filename filter",
"description": "A regular expression that determines which files (in addition to the qtm files) that will be visible in the tree view.",
"type": "string"
},
"Export c3d settings": {
"title": "Export c3d settings",
"description": "This section is optional and is used when exporting to c3d file.",
"type": "object",
"properties": {
"Point units": {
"title": "Point units in C3D export",
"description": "Possible units are: mm, cm or m.",
"enum": ["mm", "cm", "m"]
}
}
},
"Default fields": {
"title": "Default fields",
"description": "A sequence of names of fields that will be added to all types. QTM also adds a number of default fields automatically. For a list of these, see the Default Fields section.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"Package Information": {
"description": "This section contains information that the package management system uses. It is used mainly when installing packages and when creating new projects based on a package.",
"type": "object",
"properties": {
"Name": {
"title": "Package name",
"description": "The name of the package. Shown when creating a new project and used to keep the connection between a project and the package it was created from to, for instance, know if there is a new version of a package. This means that this value should not be changed unless strictly necessary because that will break the connection between existing projects and new versions of the package.",
"type": "string"
},
"Version": {
"title": "Module version",
"description": "Two numbers separated by a period sign (e.g. 44.23), three numbers separated by period signs (e.g. 1.45.3214), or three numbers separated by a period sign and a build number separated by a plus sign (e.g. 1.3.0+188). The version of the package. Used to keep track of which version a project is based on. Visible in the about box when a project is open. Useful for debugging purposes and for knowing if the package can be upgraded.",
"type": "string",
"pattern": "^\\d+\\.\\d+(\\.\\d+(\\+\\d+)?)?$"
},
"Required QTM version": {
"title": "Required QTM version",
"description": "Two or three digits separated by a period sign. The QTM version that is required for this package to work properly. Checked on install time. Must include major and minor version number and can optionally include build number too.",
"type": "string",
"pattern": "^\\d+\\.\\d+(\\.\\d+)?$"
},
"Previous names": {
"title": "Previous names",
"description": "A sequence of names that this package has had earlier in development. This is used only when checking if a project should be upgraded and allows for packages to be renamed without losing the project upgrade path.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"Name",
"Version",
"Required QTM version"
]
},
"Types": {
"title": "Types definition",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Type",
"description": "All type names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values.",
"properties": {
"Fields": {
"title": "Field reference",
"description": "Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"patternProperties": {
".+": {
"title": "Class",
"description": "All class names have to be unique. Each class definition is a map that contains the type names as keys and the type definitions as values.",
"properties": {
"Fields": {
"title": "Class fields",
"description": "Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "object",
"patternProperties": {
".+": {
"type": "string"
}
}
}
]
},
"Children": {
"title": "Children types or classes",
"description": "A sequence of references to class or type names that can be created as children to items of this type. A type that has children cannot have measurements.",
"type": "array",
"items": {
"type": "string"
}
},
"Measurements": {
"title": "Measurements",
"description": "A sequence of measurement type names. If a type has the measurement property, it is considered to be a session-like type. It cannot have other children and it will have a wizard interface containing measurements (of the types specified by this parameter) and analyses.",
"type": "array",
"items": {
"type": "string"
}
},
"Analyses": {
"title": "Analyses",
"description": "A sequence of analysis names. These will be shown in the Analyze dropdown of the session wizard. The first analysis in the list will be the default analysis that is run when the button itself is clicked.",
"type": "array",
"items": {
"type": "string"
}
},
"Display order": {
"title": "Field display order",
"description": "A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order.",
"type": "array",
"items": {
"type": "string"
}
},
"Heading": {
"title": "Field display order",
"description": "An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane.",
"type": "string"
},
"PDF guide": {
"title": "Path to PDF guide",
"description": "The path to a PDF file to show when the user clicks the Show guide button in the wizard pane.",
"type": "string"
},
"Directory pattern": {
"title": "Directory pattern",
"description": "A naming pattern for the directory created for each item (except measurements, for which this property is useless).\n\nThe pattern can contain any text as well as names of items braced by $ signs, so for instance the directory pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.\n\nAn item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.\n\nThe default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique.",
"type": "string"
},
"Icon": {
"title": "Path to icon file",
"description": "The path to an icon file (.ico) to show at the side of the item in the tree view. The path is relative to the `Templates` folder.",
"type": "string"
}
},
"patternProperties": {
".+": {
"title": "Field reference",
"description": "Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"oneOf": [
{ "required": ["Children"] },
{ "required": ["Measurements"] }
]
}
}
}
}
},
"Measurements": {
"title": "Measurement definitions",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Measurement",
"description": "A uniquely named measurement, defining its properties.",
"properties": {
"Fields": {
"title": "Class fields",
"description": "Fields to use for this class. If this key is present it should contain a map or sequence that contains fields that should be defined for each type of this class. If the fields are given as a map they also specify default values for the fields. A type can override the default value of a field by including the field name as part of its own definition but it cannot undefine a field that has been defined in the class.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "object",
"patternProperties": {
".+": {
"type": "string"
}
}
}
]
},
"Count": {
"title": "Default measurement button count",
"description": "The default number of measurement buttons that kind of measurement in a new session.",
"type": "integer",
"minimum": 0
},
"Minimum count": {
"title": "Minimum measurement count",
"description": "The minimum number of measurements of that kind in a session. The +/- buttons will not allow the count to go below this and if any analysis lists this kind of measurement as a prerequisite, the analysis will not be available until the minimum number of measurements have been performed.",
"type": "integer",
"minimum": 0
},
"Maximum count": {
"title": "Maximum measurement count",
"description": "The maximum number of measurements of that kind in a session.",
"type": "integer",
"minimum": 0
},
"Measurement length": {
"title": "Measurement recording length",
"description": "The default length of this kind of measurement.",
"type": "number",
"minimum": 0
},
"Pretrigger length": {
"title": "Pretrigger length",
"description": "The length of the pretrigger buffer. Setting this to zero disables pretrigger. Leaving this option out uses the project setting for pretrigger.",
"type": "number",
"minimum": 0
},
"Frequency": {
"title": "Measurement frequency",
"description": "The frequency used for this kind of measurement. If omitted, the frequency is not changed when starting the measurement.",
"type": "number",
"minimum": 1
},
"AIM models": {
"title": "AIM models",
"description": "A semicolon separated list (not a YAML sequence) of AIM models that should be applied to measurements of this kind.",
"type": "string"
},
"Display fields dialog after creation": {
"title": "Display fields dialog after creation",
"description": "If this value is set to true, the fields dialog will be displayed when a measurement has finished to allow the user to edit the fields of the measurement item in the same way that dialog is displayed when other (non-measurement) items are created.",
"$ref": "#/$defs/yaml-boolean"
},
"Heading": {
"title": "Measurement heading",
"description": "An optional string displayed instead of the type name as a heading for the measurement type in the wizard pane.",
"type": "string"
},
"Display order": {
"title": "Field display order",
"description": "A sequence of field names denoting the order in which to display the fields of items of this type. Inherited fields can also be entered. Fields named here will be displayed first in field lists. Fields that are not named are displayed afterwards in an arbitrary order.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"Measurement pattern": {
"title": "Measurement pattern",
"description": "A naming pattern for measurements created for each item. The pattern can contain any text as well as names of items braced by $ signs, so for instance the measurement pattern “Patient $ID$” would be expanded to Patient followed by the contents of the ID field of that item. In addition to the field names $ClassName$, $TypeName$, $WorkingDirectory$, $TemplateDirectory$ and $InstanceNumber$ can also be used in the naming patterns.\n\nAn item reference can also specify additional formatting options, inspired by those of the printf format strings. The syntax is: $[Opt. pad char][Minimum length]:Field name$ so for instance $08:ID$ would print the id field and pad it with zeros to a width of 8 characters.\n\nThe default naming pattern is $TypeName$. If directory names clash when a new directory is created, a counter is appended to the name to make it unique. The file extension .qtm will be added automatically. The default value is $TypeName$ $InstanceNumber$.",
"type": "string"
}
},
"patternProperties": {
".+": {
"title": "Field reference",
"description": "Naming any field as a key and a default value for that field in this type is permitted. Any default value given here overrides the default value from the field specification. The default value should always be a scalar except for string fields that also support sequences. See documentation of the Default property in the Fields section for more information.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
}
},
"Analyses": {
"title": "Analysis definitions",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Analysis",
"description": "A uniquely named analysis, defining its properties.",
"properties": {
"Type": {
"title": "Analysis type",
"description": "Names of the analysis type. Valid values are External program, Visual3D, Report, Compound, HTTPRequest, Instantiate template, Create skeleton, Solve skeleton.\n\nNote: only External program and Compound are available to all users. Other types require the Project Automation Framework developer license which is used for internal Qualisys development and by development partners.",
"enum": ["External program", "Visual3D", "Report", "Compound", "HTTPRequest", "Instantiate template", "Create skeleton", "Solve skeleton"]
},
"Prerequisites": {
"title": "Measurement and/or analysis prerequisites",
"description": "A sequence of measurement type names and analysis names that has to be completed before this analysis can be run. Measurement types are considered complete for the current session when the user has made at least the number of measurements given by that measurement type’s Minimum count field. Analyses are considered complete when the file denoted by the Output file field exists.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"Output file": {
"title": "Output file",
"description": "The name of a file that is created when this analysis is run. QTM uses this to check if the analysis has been completed. It is also used to issue a warning if this file has been changed since the analysis was last run for the current session. This property can contain patterns.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "string"
}
]
},
"Program display name": {
"title": "Program display name",
"description": "External program only: The name to be displayed in the directories tab in project options where the user will have to locate the external executable. NB: Because this path varies between computers rather than between projects, it is not stored in the project, but in computer-global settings file.\n\nSeveral analyses in different projects may share the same Program display name and QTM will automatically use the same executable path for all of them.",
"type": "string"
},
"Export session": {
"title": "Export session",
"description": "External program only: Optional. If present, the metadata of the session, all its ancestors and the measurements are exported into a file called session.xml.",
"$ref": "#/$defs/yaml-boolean"
},
"Export measurements": {
"title": "Formats for measurement exports",
"description": "External program only: Optional. A single string or an array containing any combination of the following values: “TSV”, “C3D”, “MAT”. Will make QTM export all the selected measurements to the corresponding formats before running the external program. Use “xml settings” to export a file with measurement settings (e.g. capture start time and analog channel names). The file will be named [file name].settings.xml.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]
},
"minItems": 1
},
{
"enum": ["TSV", "C3D", "MAT", "JSON", "tsv", "c3d", "mat", "json", "xml settings"]
}
]
},
"Template files": {
"title": "Template files",
"description": "External program only: Optional. A single string or an array containing names of files in the template directory. Each file will be run through the PHP engine and the result written to a file with the same name in the session directory. Standard Windows wildcards are supported, but note that if the asterisk is used to match a part of the filename, the pattern must be enclosed in single quotation marks to make sure it is not parsed as a YAML alias.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
{
"type": "string"
}
]
},
"Working directory": {
"title": "Working directory",
"description": "External program only: Optional. The working directory set when the program is launched. Defaults to the session directory.",
"type": "string"
},
"Arguments": {
"title": "Arguments",
"description": "Optional. An array of arguments to be sent to the program being started. Each argument will be subject to pattern expansion and if the result contains spaces, it will be enclosed in double quotation marks when the command line is built.",
"type": "array",
"items": {
"type": "string"
}
},
"Show output file": {
"title": "Show output file",
"description": "External program only: Optional. If set, and if the Output file property has been specified, and if the execution of the external program is successful (exit code 0), the output file will be shown in the systems standard program for that file type (as if it was double-clicked in the windows explorer).",
"$ref": "#/$defs/yaml-boolean"
},
"Do not wait for Application": {
"title": "Do not wait for Application",
"description": "External program only: Optional. If analysis includes this property, QTM does not wait for external program to finish the processing. If property does not exit, to continue with subsequent analyses, external program must be closed manually (> QTM 2019.1).",
"$ref": "#/$defs/yaml-boolean"
},
"Pipeline template": {
"title": "Pipeline template",
"description": "Visual3D analysis only: Required. The name of a template file in the Templates directory. This file will be instantiated and used as the pipeline script in visual 3d.",
"type": "string"
},
"Do not wait for Visual3D": {
"title": "Do not wait for Visual3D",
"description": "Visual3D analysis only: Optional. If analysis includes this property, QTM does not wait for Visual3D to finish the processing. If property does not exit, to continue with subsequent analyses, Visual3D must be closed manually or Exit_Workspace; command has to be added to the very end of Visual3D script.",
"$ref": "#/$defs/yaml-boolean"
},
"Close Visual3D": {
"title": "Deprecated: Close Visual3D",
"deprecated": true,
"description": "Visual3D analysis only: Deprecated (> QTM 2.16).",
"enum": ["Never", "No Warnings"]
},
"Components": {
"title": "Compound analysis components",
"description": "Compound analysis only. Required. An array of analysis steps.",
"type": "array",
"items": {
"type": "string"
}
},
"Template": {
"title": "Template to instantiate",
"description": "Instantiate template analysis only: Required. The name of the input file. If this name contains any path delimiter tokens, it will be considered to be relative to the project directory, otherwise QTM will assume that the input file is placed in the templates folder.",
"type": "string"
},
"Measurements": {
"title": "Measurements where skeleton should be solved",
"description": "Create / Solve skeleton analyses only: Required. A string or list of strings to specify the file names to solve the skeletons. Wildcard can be used in the name to specify multiple files at once. To specify all measurements, simply use the wildcard character. Only measurements that are marked as used in the PAF pane will be affected.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"Exclude": {
"title": "Measurements where skeleton should _not_ be solved",
"description": "Create / Solve skeleton analyses only: Optional. A string or list of strings to specify the file names to exclude. Wildcard can be used in the name to specify multiple files at once. Only measurements that are marked as used in the PAF pane will be affected.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
}
}
}
},
"Fields": {
"title": "Field definitions",
"description": "",
"type": "object",
"patternProperties": {
".+": {
"title": "Field",
"description": "A uniquely named field, defining its properties.",
"properties": {
"Type": {
"title": "Field type",
"description": "Required. Defines the type of the field. Possible values are Integer, Float, String, Date, TimeOfDay, Enum or Boolean.",
"enum": ["Integer", "Float", "String", "Date", "TimeOfDay", "Enum", "Boolean"]
},
"Hidden": {
"title": "Hidden field",
"description": "If the value is Yes or True, this field will not be displayed in the GUI (and thus will not be editable by the user) but will be exported to files. It will keep its default value.",
"$ref": "#/$defs/yaml-boolean"
},
"Readonly": {
"title": "Readonly field",
"description": "If the value is Yes or True this field will be displayed, but the user will not be able to edit it. It will keep its default value.",
"$ref": "#/$defs/yaml-boolean"
},
"Inherit": {
"title": "Inherit from parent fields",
"description": "This field will be inherited by all subitems of the item that contains it. There are two modes of inheritance Copy and Connect and the value of this property has to be one of them.\n\nCopy: Inheritance by copying means that when a child to an item that has an inheritable field is created, a field with the same name is created in the child and the value of the field in the parent is copied to that field.\n\nConnect fields work the same way when an item is created, but if the field is changed in any of the items (any ancestor or heir) it is updated in all the items that have inherited this field from the same origin. If, for instance, a value is inherited by connection from a patient to a number of sessions and the measurements in those sessions and it is changed in one of the sessions it is changed in all those objects, but not in other patients and the sessions of those patients.\n\nFields are inherited all the down to the leaves from the item including the fields so if the root item would include an inherited field, it would be copied to all items in the tree.",
"enum": ["Copy", "Connect"]
},
"Default": {
"title": "Default field value",
"description": "The default value that this field will get when an item that contains it is created. This can be overridden in the item type specification and by inheritance. The value of this property should have the same data type as the field. String fields can also specify a sequence as default value. The sequence will be converted into a string containing the elements of the sequence separated by semicolon.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"Max": {
"title": "Maximum value",
"description": "Integer / Float types only: The maximum value that can be entered in this field.",
"type": "number"
},
"Min": {
"title": "Minimum value",
"description": "Integer / Float types only: The minimum value that can be entered in this field.",
"type": "number"
},
"Quantity": {
"title": "Field physical quantity",
"description": "Float type only: The physical quantity that this field represents. This list contains the basic physical quantities but also some derived quantities because there is no possibility to combine quantities.",
"enum": [
"Length",
"Mass",
"Voltage",
"Current",
"Force",
"Moment",
"Power",
"Angle",
"Time",
"Frequency",
"Temperature",
"Speed",
"Acceleration",
"Magnetic field strength",
"Rotational speed"
]
},
"Unit": {
"title": "Field unit",
"description": "Float type only: The unit of this field. Can only be specified if a quantity has been specified. Different units apply to different quantities. Either the unit name or the abbreviation can be given. If a unit is not entered, the S/I unit is used.",
"enum": [
"meters",
"ångstroms",
"nanometers",
"microns",
"millimeters",
"centimeters",
"kilometers",
"inches",
"feet",
"yards",
"miles",
"kilograms",
"micrograms",
"milligrams",
"grams",
"ounces",
"pounds",
"volts",
"nanovolts",
"microvolts",
"millivolts",
"kilovolts",
"ampere",
"nanoampere",
"microampere",
"milliampere",
"kiloampere",
"newtons",
"millinewtons",
"kilonewtons",
"meganewtons",
"kiloponds",
"pounds force",
"newtonmeter",
"newtonmillimeter",
"watt",
"radians",
"degrees",
"seconds",
"minutes",
"hours",
"hertz",
"kilohertz",
"megahertz",
"revolutions per minute",
"beats per minute",
"kelvin",
"degrees celsius",
"degrees farenheit",
"meters per second",
"millimeters per second",
"kilometers per hour",
"feet per second",
"miles per hour",
"knots",
"meters per second squared",
"millimeters per second squared",
"feet per second squared",
"standard gravity",
"tesla",
"millitesla",
"degrees per second",
"Meters",
"Ångstroms",
"Nanometers",
"Microns",
"Millimeters",
"Centimeters",
"Kilometers",
"Inches",
"Feet",
"Yards",
"Miles",
"Kilograms",
"Micrograms",
"Milligrams",
"Grams",
"Ounces",
"Pounds",
"Volts",
"Nanovolts",
"Microvolts",
"Millivolts",
"Kilovolts",
"Ampere",
"Nanoampere",
"Microampere",
"Milliampere",
"Kiloampere",
"Newtons",
"Millinewtons",
"Kilonewtons",
"Meganewtons",
"Kiloponds",
"Pounds force",
"Newtonmeter",
"Newtonmillimeter",
"Watt",
"Radians",
"Degrees",
"Seconds",
"Minutes",
"Hours",
"Hertz",
"Kilohertz",
"Megahertz",
"Revolutions per minute",
"Beats per minute",
"Kelvin",
"Degrees celsius",
"Degrees farenheit",
"Meters per second",
"Millimeters per second",
"Kilometers per hour",
"Feet per second",
"Miles per hour",
"Knots",
"Meters per second squared",
"Millimeters per second squared",
"Feet per second squared",
"Standard gravity",
"Tesla",
"Millitesla",
"Degrees per second",
"m/s"
]
},
"Decimals": {
"title": "Field decimal count",
"description": "Float type only: The number of decimals to present to the user.",
"type": "integer"
},
"Force": {
"title": "Force non-empty string",
"description": "String type only: Force the string to be non-empty.",
"$ref": "#/$defs/yaml-boolean"
},
"JSON": {
"title": "Treat string as JSON object",
"description": "String type only: The string should be returned as JSON object when queried from the REST api. JSON fields are not exported to session.xml during the analysis step. (Available from QTM 2.14).",
"$ref": "#/$defs/yaml-boolean"
},
"Values": {
"title": "Enum values",
"description": "Enum type only: The enum field defines an enumeration. To the user it will be presented as a multiple selection and internally it will be saved as a numeric value. The possible values that an enum can have has to be specified in the Values property. This property can be either a sequence or a map.\n\nIf it is a sequence it simply lists the choices of the enum and these will be assigned an integer value automatically.\n\nIf it is a map it is a map from the choices to the numeric value of each particular choice.",
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"Display": {
"title": "Boolean display",
"description": "Boolean type only: Controls how this value will be displayed. Can be one of yesno, checkbox or truefalse.",
"enum": [
"yesno",
"checkbox",
"truefalse",
"YesNo",
"Checkbox",
"TrueFalse"
]
}
},
"required": [
"Type"
]
}
}
},
"Columns": {
"title": "Column definitions",
"description": "The columns section specifies the columns of the tree view in the project view. It allows the PAF file to specify multiple column setups. The idea is that the users should be able to switch between different configurations and possibly also add their own but currently only the first setup is used.",
"type": "object",
"patternProperties": {
".+": {
"title": "Column setup",
"description": "A uniquely named column setup. Each setup contains an arbitrary number of columns.",
"patternProperties": {
".+": {
"title": "Column",
"description": "A uniquely named column. Each column can specify a width (in pixels) and a way of determining the value displayed in the column. A key to understanding the column values is the understanding that each row in the tree view might contain a different type of item.",
"properties": {
"Width": {
"title": "Column width",
"description": "The width (in pixels) of this column.",
"type": "integer"
},
"Field": {
"title": "Column field",
"description": "The column will contain the value of the field named by this property regardless of the type of the item on the row.",
"type": "string"
},
"Fields": {
"title": "Column fields (with name mapping)",
"description": "A map from the item type name to the field to use. For each item type that is present as a key in the map the value of the field named will be used. For item types that are not named in the map the default field name will be used.",
"type": "object",
"properties": {
"Default": {
"title": "Default field",
"description": "Name used for item types not named in the map.",
"type": "string"
}
},
"patternProperties": {
".+": {
"title": "Field mapping",
"description": "Name used for item types not named in the map.",
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"Name": {
"title": "Type name",
"description": "",
"type": "string"
},
"Editable": {
"title": "Editable values",
"description": "If yes or true, the value of the field can be edited directly in the tree.",
"$ref": "#/$defs/yaml-boolean"
}
}
}
]
}
}
}
}
}
}
}
}
}
},
"required": [
"Project ID",
"Root type",
"Types",
"Columns"
],
"$defs": {
"yaml-boolean": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "string",
"enum": ["Yes", "yes", "No", "no"]
}
]
}
}
} |
ninjs-2.0.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "A news item as JSON object -- copyright 2021 IPTC - International Press Telecommunications Council - www.iptc.org - This document is published under the Creative Commons Attribution 4.0 license, see http://creativecommons.org/licenses/by/4.0/",
"id": "http://www.iptc.org/std/ninjs/ninjs-schema_2.0.json#",
"name": "ninjs",
"properties": {
"uri": {
"title": "Uniform Resource Identifier",
"description": "The global unique identifier for this news object. This is the only required property and should identify the ninjs object, not be used for links to external resources etc. nar:newsItem@guid",
"type": "string",
"format": "uri"
},
"type": {
"title": "Type",
"description": "The generic news type of this news object. (Value 'component' added in version 1.2 as issue #21.). See: http://cv.iptc.org/newscodes/ninature/ nar:itemClass",
"type": "string",
"enum": [
"text",
"audio",
"video",
"picture",
"graphic",
"composite",
"component"
]
},
"representationtype": {
"title": "Representation type",
"description": "Indicates how complete this representation of a news item is. No mapping to nar. Specific for ninjs.",
"type": "string",
"enum": ["full", "partial"]
},
"profile": {
"title": "Profile",
"description": "An identifier for the structure of the news object. This can be any string but we suggest something identifying the structure of the content such as 'text-only' or 'text-photo'. Profiles are typically provider-specific. nar:profile",
"type": "string"
},
"version": {
"title": "Version",
"description": "The version of the news object which is identified by the uri property. nar:newsItem@version",
"type": "string"
},
"firstcreated": {
"title": "First created",
"description": "Indicates when the first version of this ninjs object was created. (Added in version 1.2 from issue #5). nar:firstCreated",
"type": "string",
"format": "date-time"
},
"versioncreated": {
"title": "Version created",
"description": "The date and time when this version of this ninjs object was created. nar:versionCreated",
"type": "string",
"format": "date-time"
},
"contentcreated": {
"title": "Content created",
"description": "The date and time when the content of this ninjs object was originally created. For example and old photo that is now handled as a ninjs object. nar:contentCreated",
"type": "string",
"format": "date-time"
},
"embargoed": {
"title": "Embargoed",
"description": "The date and time before which all versions of the news object are embargoed. If absent, this object is not embargoed. nar:embargoed",
"type": "string",
"format": "date-time"
},
"pubstatus": {
"title": "Publication status",
"description": "The publishing status of the news object, its value is *usable* by default. nar:pubStatus",
"type": "string",
"enum": ["usable", "withheld", "canceled"]
},
"urgency": {
"title": "Urgency",
"description": "The editorial urgency of the content. Values from 1 to 9. 1 represents the highest urgency, 9 the lowest. nar:urgency",
"type": "number"
},
"copyrightholder": {
"title": "Copyright holder",
"description": "The person or organisation claiming the intellectual property for the content. nar:copyrightHolder",
"type": "string"
},
"copyrightnotice": {
"title": "Copyright notice",
"description": "Any necessary copyright notice for claiming the intellectual property for the content. nar:copyrightNotice",
"type": "string"
},
"usageterms": {
"title": "Usage terms",
"description": "A natural-language statement about the usage terms pertaining to the content. nar:usageTerms",
"type": "string"
},
"ednote": {
"title": "Editorial note",
"description": "A note that is intended to be read by internal staff at the receiving organisation, but not intended to be published. (Added in version 1.2 from issue #6.). (Consider using this before using the descriptions array.) ednote: nar:edNote",
"type": "string"
},
"language": {
"title": "Language",
"description": "The human language used by the content. The value should follow IETF BCP47. nar:language",
"type": "string"
},
"descriptions": {
"title": "Descriptions",
"description": "An array of one or more descriptions of the ninjs object. See also ednote for information from provider to reciever. Descriptions are seen as metadata. For a simple description use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.",
"type": "array",
"items": {
"type": "object",
"required": ["value"],
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of this description",
"type": "string"
},
"contenttype": {
"title": "Content Type",
"description": "The IANA (Internet Assigned Numbers Authority) MIME type of the content of this description.",
"type": "string"
},
"value": {
"title": "Value",
"description": "The descriptive text identified with the above role (and contenttype).",
"type": "string"
}
}
}
},
"bodies": {
"title": "Bodies",
"description": "An array of body objects with the content as text or with markup. For a simple body use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.",
"type": "array",
"items": {
"type": "object",
"required": ["value"],
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of this body",
"type": "string"
},
"contenttype": {
"title": "Content Type",
"description": "The IANA (Internet Assigned Numbers Authority) MIME type of the content of this body.",
"type": "string"
},
"charcount": {
"title": "Character count",
"description": "The total character count in this body excluding figure captions. (Added in version 1.2 according to issue #27.). nar:charcount",
"type": "number"
},
"wordcount": {
"title": "Word count",
"description": "The total number of words in this body excluding figure captions. (Added in version 1.2 according to issue #27.). nar:wordcount",
"type": "number"
},
"value": {
"title": "Value",
"description": "The body text identified with the above role and contenttype.",
"type": "string"
}
}
}
},
"headlines": {
"title": "Headlines",
"description": "An array of objects containing various types of headlines. For a simple headline use an array with one object only containing the value property. Role and contenttype are then undefined and it is up to the provider.",
"type": "array",
"items": {
"type": "object",
"required": ["value"],
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of this headline",
"type": "string"
},
"contenttype": {
"title": "Content Type",
"description": "The IANA (Internet Assigned Numbers Authority) MIME type of the content of this headline.",
"type": "string"
},
"value": {
"title": "Value",
"description": "The headline identified with the above role and contenttype.",
"type": "string"
}
}
}
},
"people": {
"title": "People",
"description": "An array of objects describing individual human beings. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of a person",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the person",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier for the person as a complete uri with the code.",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the person as a literal value.",
"type": "string"
}
}
}
},
"organisations": {
"title": "Organisations",
"description": "An array of objects describing administrative and functional structures which may, for example, act as as a business, as a political party or not-for-profit party. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the organisation",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the organisation",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier of the organisation as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the organisation as a literal",
"type": "string"
},
"symbols": {
"title": "Symbols",
"description": "Symbols used for a financial instrument linked to the organisation at a specific market place",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ticker": {
"title": "Ticker",
"description": "Ticker symbol used for the financial instrument",
"type": "string"
},
"exchange": {
"title": "Exchange",
"description": "Identifier for the marketplace which uses the ticker symbols of the ticker property",
"type": "string"
}
}
}
}
}
}
},
"places": {
"title": "Places",
"description": "An array of named locations. nar:subject",
"additionalProperties": false,
"type": "array",
"items": {
"type": "object",
"anyOf": [
{
"properties": {
"name": {
"title": "Name",
"description": "The name of the place",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the place",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier for the place as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the place as a literal",
"type": "string"
}
}
},
{
"$ref": "https://json.schemastore.org/geojson"
}
]
}
},
"subjects": {
"title": "Subjects",
"description": "An array of objects holding concepts with a relationship to the content. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the subject",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the subject",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier of the subject as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the subject as a string literal",
"type": "string"
}
}
}
},
"events": {
"title": "Events",
"description": "An array of objects describing something which happens in a planned or unplanned manner. nar:?",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the event",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the event",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier for the event as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the event as a string literal",
"type": "string"
}
}
}
},
"objects": {
"title": "Objects",
"description": "An array of objects describing something material, excluding persons. nar:subject",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the object",
"type": "string"
},
"rel": {
"title": "Relationship",
"description": "The relationship of the content of the news object to the object",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier for the object as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the object as a string literal",
"type": "string"
}
}
}
},
"infosources": {
"title": "Info sources",
"description": "An array of parties (person or organisation) which originated, modified, enhanced, distributed, aggregated or supplied the content or provided some information used to create or enhance the content. (Added in version 1.2 according to issue #15.) . infosource: nar:infoSource",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the infosource",
"type": "string"
},
"role": {
"title": "Role",
"description": "The role the infosource in relationship to the content as a uri.",
"type": "string",
"format": "uri"
},
"uri": {
"title": "URI",
"description": "The identifier of the infosource as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the infosource as a string literal",
"type": "string"
}
}
}
},
"title": {
"title": "Title",
"description": "A short natural-language name for the item. Title is metadata, use headlines for publishable headlines. (Added in version 1.2 according to issue #9). nar:itemMeta/title",
"type": "string"
},
"by": {
"title": "By",
"description": "A natural-language statement about the creator (author, photographer etc.) of the content. nar:by",
"type": "string"
},
"slugline": {
"title": "Slugline",
"description": "A human-readable identifier for the item. (Added in version 1.2 from issue #4.). nar:slugline",
"type": "string"
},
"located": {
"title": "Located",
"description": "The name of the location from which the content originates. nar:located",
"type": "string"
},
"renditions": {
"title": "Renditions",
"description": "An array of objects with different renditions of the news object. nar:remoteContent",
"type": "array",
"additionalProperties": false,
"items": {
"description": "A specific rendition of the content of the news object. (Description changed in version 1.2 according to issue #17.)",
"type": "object",
"additionalProperties": false,
"required": ["name"],
"properties": {
"name": {
"title": "Name",
"description": "The name of this object in the array of renditions. For example 'thumbnail'",
"type": "string"
},
"href": {
"title": "href",
"description": "The URL for accessing the rendition as a resource. nar:remoteContent@ref",
"type": "string",
"format": "uri"
},
"contenttype": {
"title": "Content Type",
"description": "A MIME type which applies to this rendition. nar:remoteContent@contenttype",
"type": "string"
},
"title": {
"title": "Title",
"description": "A title for the link to the rendition resource",
"type": "string"
},
"height": {
"title": "Height",
"description": "For still and moving images: the height of the display area measured in pixels. nar:remoteContent@height",
"type": "number"
},
"width": {
"title": "Width",
"description": "For still and moving images: the width of the display area measured in pixels. nar:remoteContent@width",
"type": "number"
},
"sizeinbytes": {
"title": "Size in bytes",
"description": "The size of the rendition resource in bytes",
"type": "number"
},
"duration": {
"title": "Duration",
"description": "The total time duration of the content in seconds. (Added in version 1.2. Issue #18). nar:remoteContent@duration",
"type": "number"
},
"format": {
"title": "Format",
"description": "Binary format name. (Added in version 1.2. Issue #18). nar:remoteContent@format",
"type": "string"
}
}
}
},
"associations": {
"title": "Associations",
"description": "An array of objects with content of news objects which are associated with this news object.",
"type": "array",
"additionalProperties": false,
"items": {
"description": "One associated object where each object can use all properties in ninjs.",
"type": "object",
"anyOf": [
{
"properties": {
"name": {
"type": "string",
"description": "The name of this object in the array of associations. For example 'logo'"
}
},
"required": ["name"]
},
{
"$ref": "#"
}
]
}
},
"altids": {
"title": "Alternative ids",
"description": "Alternative identifiers assigned to the content. Each alternative id can have a role and a value. nar:altId issue #3.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of the alternative id",
"type": "string"
},
"value": {
"title": "Value",
"description": "The alternative id value",
"type": "string"
}
}
}
},
"trustindicators": {
"title": "Trust indicators",
"description": "An array of objects to allow links to documents about trust indicators. issue #44. (Added in version 1.3)",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"role": {
"title": "Role",
"description": "The role of the trust indicator as a complete uri",
"type": "string",
"format": "uri"
},
"title": {
"title": "Title",
"description": "The title of the resource being referenced.",
"type": "string"
},
"href": {
"title": "href",
"description": "The URL for accessing the trust indicator resource.",
"type": "string",
"format": "uri"
}
}
}
},
"standard": {
"title": "Standard",
"type": "object",
"description": "An object with information about standard, version and schema this instance is valid against. nar:standard, nar:standardversion and xml:schema issue #43. (Added in version 1.3)",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name of standard.",
"description": "For example ninjs. nar:standard",
"type": "string"
},
"version": {
"title": "Version of standard.",
"description": "For example 1.3. nar:standardversion",
"type": "string"
},
"schema": {
"title": "Schema",
"description": "The uri of the json schema to use for validation.",
"type": "string",
"format": "uri"
}
}
},
"genres": {
"title": "Genres",
"description": "A nature, intellectual or journalistic form of the content. nar:genre. (Added in version 1.3)",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"description": "The name of the genre",
"type": "string"
},
"uri": {
"title": "URI",
"description": "The identifier of the genre as a complete uri",
"type": "string",
"format": "uri"
},
"literal": {
"title": "Literal",
"description": "The code for the genre as a string literal",
"type": "string"
}
}
}
},
"rightsinfo": {
"title": "Rights information",
"type": "object",
"description": "Expression of rights to be applied to content. nar:rightsInfo",
"properties": {
"langid": {
"type": "string",
"title": "Language id",
"description": "Identifier for the Rights Expression language used. nar:@langid",
"format": "uri"
},
"linkedrights": {
"title": "Linked rights",
"description": "A link from the current Item to Web resource with rights related information. nar:link",
"type": "string",
"format": "uri"
},
"encodedrights": {
"title": "Encoded Rights",
"additionalProperties": false,
"type": "string",
"description": "Contains a rights expression as defined by a Rights Expression Language. nar:rightsExpressionXML or nar:rightsExpressionData"
}
},
"oneOf": [
{
"required": ["linkedrights"]
},
{
"required": ["encodedrights"]
}
]
}
},
"required": ["uri"],
"title": "IPTC ninjs - News in JSON - version 2.0 (approved at IPTC Standards Committee October 2021)",
"type": "object"
}
|
snapcraft.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"grammar-string": {
"oneOf": [
{
"type": "string",
"usage": "<string>"
},
{
"type": "array",
"items": {
"minitems": 1,
"uniqueItems": true,
"oneOf": [
{
"type": "object",
"usage": "on <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^on\\s+.+$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "object",
"usage": "to <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^to\\s+.+$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "object",
"usage": "try:",
"additionalProperties": false,
"patternProperties": {
"^try$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "object",
"usage": "else:",
"additionalProperties": false,
"patternProperties": {
"^else$": {
"$ref": "#/definitions/grammar-string"
}
}
},
{
"type": "string",
"pattern": "else fail"
}
]
}
}
]
},
"grammar-array": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"oneOf": [
{
"type": "string",
"usage": "<string>"
},
{
"type": "object",
"usage": "on <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^on\\s+.+$": {
"$ref": "#/definitions/grammar-array"
}
}
},
{
"type": "object",
"usage": "to <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^to\\s+.+$": {
"$ref": "#/definitions/grammar-array"
}
}
},
{
"type": "object",
"usage": "try:",
"additionalProperties": false,
"patternProperties": {
"^try$": {
"$ref": "#/definitions/grammar-array"
}
}
},
{
"type": "object",
"usage": "else:",
"additionalProperties": false,
"patternProperties": {
"^else$": {
"$ref": "#/definitions/grammar-array"
}
}
}
]
}
},
"build-environment-grammar": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"oneOf": [
{
"type": "object",
"minProperties": 1,
"maxProperties": 1,
"additionalProperties": {
"type": "string"
}
},
{
"type": "object",
"usage": "on <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^on\\s+.+$": {
"$ref": "#/definitions/build-environment-grammar"
}
}
},
{
"type": "object",
"usage": "to <selector>[,<selector>...]:",
"additionalProperties": false,
"patternProperties": {
"^to\\s+.+$": {
"$ref": "#/definitions/build-environment-grammar"
}
}
},
{
"type": "object",
"usage": "else:",
"additionalProperties": false,
"patternProperties": {
"^else$": {
"$ref": "#/definitions/build-environment-grammar"
}
}
}
]
}
},
"apt-deb": {
"type": "object",
"description": "deb repositories",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"apt"
]
},
"architectures": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"description": "Architectures to enable, or restrict to, for this repository. Defaults to host architecture."
}
},
"formats": {
"type": "array",
"description": "deb types to enable. Defaults to [deb, deb-src].",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"deb",
"deb-src"
]
}
},
"components": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"description": "Deb repository components to enable, e.g. 'main, multiverse, unstable'"
}
},
"key-id": {
"type": "string",
"description": "GPG key identifier / fingerprint. May be used to identify key file in <project>/snap/keys/<key-id>.asc",
"pattern": "^[A-Z0-9]{40}$"
},
"key-server": {
"type": "string",
"description": "GPG keyserver to use to fetch GPG <key-id>, e.g. 'keyserver.ubuntu.com'. Defaults to keyserver.ubuntu.com if key is not found in project."
},
"path": {
"type": "string",
"description": "Exact path to repository (relative to URL). Cannot be used with suites or components."
},
"suites": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"description": "Deb repository suites to enable, e.g. 'xenial-updates, xenial-security')."
}
},
"url": {
"type": "string",
"description": "Deb repository URL, e.g. 'http://archive.canonical.com/ubuntu'."
}
},
"required": [
"type",
"key-id",
"url"
],
"validation-failure": "{!r} is not properly configured deb repository"
},
"apt-ppa": {
"type": "object",
"description": "PPA repository",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"apt"
]
},
"ppa": {
"type": "string",
"description": "ppa path: e.g. 'canonical-kernel-team/unstable'"
}
},
"required": [
"type",
"ppa"
],
"validation-failure": "{!r} is not properly configured PPA repository"
},
"system-username-scope": {
"type": "string",
"description": "short-form user configuration (<username>: <scope>)",
"enum": [
"shared"
],
"validation-failure": "{!r} is not a valid user scope. Valid scopes include: 'shared'"
},
"environment": {
"type": "object",
"description": "environment entries",
"minItems": 1,
"additionalProperties": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "number"
}
]
}
}
},
"title": "snapcraft schema",
"type": "object",
"properties": {
"build-packages": {
"$ref": "#/definitions/grammar-array",
"description": "top level build packages."
},
"adopt-info": {
"type": "string",
"description": "name of the part that provides source files that will be parsed to extract snap metadata information"
},
"name": {
"description": "name of the snap package",
"allOf": [
{
"$comment": "string, but not too long. the failure message avoids printing repr of the thing, as it could be huge",
"type": "string",
"validation-failure": "snap names need to be strings.",
"maxLength": 40
},
{
"pattern": "^[a-z0-9-]*[a-z][a-z0-9-]*$",
"validation-failure": "{.instance!r} is not a valid snap name. Snap names can only use ASCII lowercase letters, numbers, and hyphens, and must have at least one letter."
},
{
"pattern": "^[^-]",
"validation-failure": "{.instance!r} is not a valid snap name. Snap names cannot start with a hyphen."
},
{
"pattern": "[^-]$",
"validation-failure": "{.instance!r} is not a valid snap name. Snap names cannot end with a hyphen."
},
{
"not": {
"pattern": "--"
},
"validation-failure": "{.instance!r} is not a valid snap name. Snap names cannot have two hyphens in a row."
}
]
},
"title": {
"$comment": "https://forum.snapcraft.io/t/title-length-in-snapcraft-yaml-snap-yaml/8625/10",
"description": "title for the snap",
"type": "string",
"maxLength": 40
},
"architectures": {
"description": "architectures on which to build, and on which the resulting snap runs",
"type": "array",
"minItems": 1,
"uniqueItems": true,
"format": "architectures",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"build-on"
],
"properties": {
"build-on": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true
}
]
},
"run-on": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"uniqueItems": true
}
]
}
}
}
]
}
},
"version": {
"description": "package version",
"allOf": [
{
"type": "string",
"validation-failure": "snap versions need to be strings. They must also be wrapped in quotes when the value will be interpreted by the YAML parser as a non-string. Examples: '1', '1.2', '1.2.3', git (will be replaced by a git describe based version string)."
},
{
"pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9:.+~-]*[a-zA-Z0-9+~])?$",
"maxLength": 32,
"validation-failure": "{.instance!r} is not a valid snap version string. Snap versions consist of upper- and lower-case alphanumeric characters, as well as periods, colons, plus signs, tildes, and hyphens. They cannot begin with a period, colon, plus sign, tilde, or hyphen. They cannot end with a period, colon, or hyphen."
}
]
},
"version-script": {
"type": "string",
"description": "a script that echoes the version to set."
},
"license": {
"type": "string",
"description": "the license the package holds"
},
"icon": {
"type": "string",
"description": "path to a 512x512 icon representing the package.",
"format": "icon-path"
},
"summary": {
"type": "string",
"description": "one line summary for the package",
"maxLength": 78
},
"description": {
"type": "string",
"description": "long description of the package",
"pattern": ".+",
"validation-failure": "{.instance!r} is not a valid description string."
},
"assumes": {
"type": "array",
"description": "featureset the snap requires in order to work.",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
"type": {
"type": "string",
"description": "the snap type, the implicit type is 'app'",
"enum": [
"app",
"base",
"gadget",
"kernel",
"snapd"
]
},
"frameworks": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
"confinement": {
"type": "string",
"description": "the type of confinement supported by the snap",
"default": "strict",
"enum": [
"classic",
"devmode",
"strict"
]
},
"grade": {
"type": "string",
"description": "the quality grade of the snap",
"default": "stable",
"enum": [
"stable",
"devel"
]
},
"base": {
"type": "string",
"description": "the base snap to use"
},
"build-base": {
"type": "string",
"description": "force a build environment based on base to create a snap"
},
"epoch": {
"description": "the snap epoch, used to specify upgrade paths",
"format": "epoch"
},
"compression": {
"description": "compression to use for snap archive - default is otherwise determined by 'snap pack'",
"type": "string",
"enum": [
"lzo",
"xz"
]
},
"environment": {
"description": "environment entries for the snap as a whole",
"$ref": "#/definitions/environment"
},
"passthrough": {
"type": "object",
"description": "properties to be passed into snap.yaml as-is"
},
"layout": {
"type": "object",
"description": "layout property to be passed into the snap.yaml as-is"
},
"package-repositories": {
"type": "array",
"description": "additional repository configuration.",
"minItems": 0,
"uniqueItems": true,
"items": [
{
"oneOf": [
{
"$ref": "#/definitions/apt-deb"
},
{
"$ref": "#/definitions/apt-ppa"
}
]
}
]
},
"system-usernames": {
"type": "object",
"description": "system username",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid system-username.",
"patternProperties": {
"^snap_(daemon|microk8s|aziotedge|aziotdu)$": {
"oneOf": [
{
"$ref": "#/definitions/system-username-scope"
},
{
"type": "object",
"description": "long-form user configuration",
"additionalProperties": false,
"properties": {
"scope": {
"$ref": "#/definitions/system-username-scope"
}
},
"required": [
"scope"
]
}
]
}
}
},
"donation": {
"oneOf": [
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
{
"type": "string"
}
]
},
"issues": {
"oneOf": [
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
{
"type": "string"
}
]
},
"contact": {
"oneOf": [
{
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
},
{
"type": "string"
}
]
},
"source-code": {
"type": "string"
},
"website": {
"type": "string"
},
"apps": {
"type": "object",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid app name. App names consist of upper- and lower-case alphanumeric characters and hyphens. They cannot start or end with a hyphen.",
"patternProperties": {
"^[a-zA-Z0-9](?:-?[a-zA-Z0-9])*$": {
"type": "object",
"required": [
"command"
],
"dependencies": {
"bus-name": [
"daemon"
],
"activates-on": [
"daemon"
],
"refresh-mode": [
"daemon"
],
"stop-mode": [
"daemon"
],
"stop-command": [
"daemon"
],
"start-timeout": [
"daemon"
],
"stop-timeout": [
"daemon"
],
"watchdog-timeout": [
"daemon"
],
"restart-delay": [
"daemon"
],
"post-stop-command": [
"daemon"
],
"reload-command": [
"daemon"
],
"restart-condition": [
"daemon"
],
"before": [
"daemon"
],
"after": [
"daemon"
],
"timer": [
"daemon"
],
"install-mode": [
"daemon"
]
},
"additionalProperties": false,
"properties": {
"autostart": {
"type": "string",
"description": "Name of the desktop file placed by the application in $SNAP_USER_DATA/.config/autostart to indicate that application should be started with the user's desktop session.",
"pattern": "^[A-Za-z0-9. _#:$-]+\\.desktop$",
"validation-failure": "{.instance!r} is not a valid desktop file name (e.g. myapp.desktop)"
},
"common-id": {
"type": "string",
"description": "common identifier across multiple packaging formats"
},
"bus-name": {
"type": "string",
"description": "D-Bus name this service is reachable as",
"pattern": "^[A-Za-z0-9/. _#:$-]*$",
"validation-failure": "{.instance!r} is not a valid bus name."
},
"activates-on": {
"type": "array",
"description": "dbus interface slots this service activates on",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"desktop": {
"type": "string",
"description": "path to a desktop file representing the app, relative to the prime directory"
},
"command": {
"type": "string",
"description": "command executed to run the binary"
},
"completer": {
"type": "string",
"description": "bash completion script relative to the prime directory"
},
"stop-command": {
"type": "string",
"description": "command executed to stop a service"
},
"post-stop-command": {
"type": "string",
"description": "command executed after stopping a service"
},
"start-timeout": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid timeout value.",
"description": "Optional time to wait for daemon to start - <n>ns | <n>us | <n>ms | <n>s | <n>m"
},
"stop-timeout": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid timeout value.",
"description": "Optional time to wait for daemon to stop - <n>ns | <n>us | <n>ms | <n>s | <n>m"
},
"watchdog-timeout": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid timeout value.",
"description": "Service watchdog timeout - <n>ns | <n>us | <n>ms | <n>s | <n>m"
},
"reload-command": {
"type": "string",
"description": "Command to use to ask the service to reload its configuration."
},
"restart-delay": {
"type": "string",
"pattern": "^[0-9]+(ns|us|ms|s|m)*$",
"validation-failure": "{.instance!r} is not a valid delay value.",
"description": "Delay between service restarts - <n>ns | <n>us | <n>ms | <n>s | <n>m. Defaults to unset. See the systemd.service manual on RestartSec for details."
},
"timer": {
"type": "string",
"description": "The service is activated by a timer, app must be a daemon. (systemd.time calendar event string)"
},
"daemon": {
"type": "string",
"description": "signals that the app is a service.",
"enum": [
"simple",
"forking",
"oneshot",
"notify",
"dbus"
]
},
"after": {
"type": "array",
"description": "List of applications that are ordered to be started after the current one",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"before": {
"type": "array",
"description": "List of applications that are ordered to be started before the current one",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"refresh-mode": {
"type": "string",
"description": "controls if the app should be restarted at all",
"enum": [
"endure",
"restart"
]
},
"stop-mode": {
"type": "string",
"description": "controls how the daemon should be stopped",
"enum": [
"sigterm",
"sigterm-all",
"sighup",
"sighup-all",
"sigusr1",
"sigusr1-all",
"sigusr2",
"sigusr2-all",
"sigint",
"sigint-all"
]
},
"restart-condition": {
"type": "string",
"enum": [
"on-success",
"on-failure",
"on-abnormal",
"on-abort",
"on-watchdog",
"always",
"never"
]
},
"install-mode": {
"type": "string",
"enum": [
"enable",
"disable"
]
},
"slots": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"plugs": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"aliases": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-zA-Z0-9][-_.a-zA-Z0-9]*$",
"validation-failure": "{.instance!r} is not a valid alias. Aliases must be strings, begin with an ASCII alphanumeric character, and can only use ASCII alphanumeric characters and the following special characters: . _ -"
}
},
"environment": {
"description": "environment entries for the specific app.",
"$ref": "#/definitions/environment"
},
"adapter": {
"$comment": "Full should be the default, but it requires command-chain which isn't available in snapd until 2.36, which isn't yet stable. Until 2.36 is generally available, continue with legacy as the default.",
"type": "string",
"description": "What kind of wrapper to generate for the given command",
"enum": [
"none",
"legacy",
"full"
],
"default": "legacy"
},
"command-chain": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9/._#:$-]*$",
"validation-failure": "{.instance!r} is not a valid command-chain entry. Command chain entries must be strings, and can only use ASCII alphanumeric characters and the following special characters: / . _ # : $ -"
}
},
"sockets": {
"type": "object",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid socket name. Socket names consist of lower-case alphanumeric characters and hyphens.",
"patternProperties": {
"^[a-z][a-z0-9_-]*$": {
"type": "object",
"required": [
"listen-stream"
],
"description": "Sockets for automatic service activation",
"additionalProperties": false,
"properties": {
"listen-stream": {
"anyOf": [
{
"type": "integer",
"usage": "port number, an integer between 1 and 65535",
"minimum": 1,
"maximum": 65535
},
{
"type": "string",
"usage": "socket path, a string"
}
]
},
"socket-mode": {
"type": "integer"
}
}
}
}
},
"passthrough": {
"type": "object",
"description": "properties to be passed into snap.yaml as-is"
},
"extensions": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"enum": [
"flutter-stable",
"flutter-beta",
"flutter-dev",
"flutter-master",
"gnome",
"gnome-3-28",
"gnome-3-34",
"gnome-3-38",
"kde-neon",
"ros1-noetic",
"ros2-foxy"
]
}
}
}
}
}
},
"hooks": {
"type": "object",
"additionalProperties": false,
"validation-failure": "{!r} is not a valid hook name. Hook names consist of lower-case alphanumeric characters and hyphens. They cannot start or end with a hyphen.",
"patternProperties": {
"^[a-z](?:-?[a-z0-9])*$": {
"type": "object",
"additionalProperties": false,
"properties": {
"command-chain": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9/._#:$-]*$",
"validation-failure": "{.instance!r} is not a valid command-chain entry. Command chain entries must be strings, and can only use ASCII alphanumeric characters and the following special characters: / . _ # : $ -"
}
},
"environment": {
"description": "environment entries for this hook",
"$ref": "#/definitions/environment"
},
"plugs": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
}
},
"passthrough": {
"type": "object",
"description": "properties to be passed into snap.yaml as-is"
}
}
}
}
},
"parts": {
"type": "object",
"minProperties": 1,
"additionalProperties": false,
"validation-failure": "{!r} is not a valid part name. Part names consist of lower-case alphanumeric characters, hyphens and plus signs. As a special case, 'plugins' is also not a valid part name.",
"patternProperties": {
"^(?!plugins$)[a-z0-9][a-z0-9+-]*$": {
"type": [
"object",
"null"
],
"minProperties": 1,
"required": [
"plugin"
],
"properties": {
"plugin": {
"type": "string",
"description": "plugin name"
},
"source": {
"$ref": "#/definitions/grammar-string"
},
"source-checksum": {
"type": "string",
"default": ""
},
"source-branch": {
"type": "string",
"default": ""
},
"source-commit": {
"type": "string",
"default": ""
},
"source-depth": {
"type": "integer",
"default": 0
},
"source-submodules": {
"type": "array",
"minItems": 0,
"uniqueItems": true,
"items": {
"type": "string",
"description": "submodules to fetch, by pathname in source tree"
}
},
"source-subdir": {
"type": "string",
"default": ""
},
"source-tag": {
"type": "string",
"default": ""
},
"source-type": {
"type": "string",
"default": "",
"enum": [
"bzr",
"git",
"hg",
"mercurial",
"subversion",
"svn",
"tar",
"zip",
"deb",
"rpm",
"7z",
"local"
]
},
"disable-parallel": {
"type": "boolean",
"default": false
},
"after": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": []
},
"stage-snaps": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"stage-packages": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"build-snaps": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"build-packages": {
"$comment": "For some reason 'default' doesn't work if in the ref",
"$ref": "#/definitions/grammar-array",
"default": []
},
"build-environment": {
"$ref": "#/definitions/build-environment-grammar",
"default": []
},
"build-attributes": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"core22-step-dependencies",
"enable-patchelf",
"no-patchelf",
"no-install",
"debug",
"keep-execstack"
]
},
"default": []
},
"organize": {
"type": "object",
"default": {},
"additionalProperties": {
"type": "string",
"minLength": 1
}
},
"filesets": {
"type": "object",
"default": {},
"additionalProperties": {
"type": "array",
"minitems": 1
}
},
"stage": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": [
"*"
]
},
"prime": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": [
"*"
]
},
"override-pull": {
"type": "string",
"default": "snapcraftctl pull"
},
"override-build": {
"type": "string",
"default": "snapcraftctl build"
},
"override-stage": {
"type": "string",
"default": "snapcraftctl stage"
},
"override-prime": {
"type": "string",
"default": "snapcraftctl prime"
},
"parse-info": {
"type": "array",
"minitems": 1,
"uniqueItems": true,
"items": {
"type": "string"
},
"default": []
}
}
}
}
},
"plugs": {
"type": "object"
},
"slots": {
"type": "object"
},
"ua-services": {
"type": "array",
"description": "UA services to enable.",
"minItems": 1,
"uniqueItems": true,
"items": [
{
"type": "string"
}
]
}
},
"allOf": [
{
"anyOf": [
{
"usage": "type: <base|kernel|snapd> (without a base)",
"properties": {
"type": {
"enum": [
"base",
"kernel",
"snapd"
]
}
},
"allOf": [
{
"required": [
"type"
]
},
{
"not": {
"required": [
"base"
]
}
}
]
},
{
"usage": "base: <base> and type: <app|gadget>",
"properties": {
"type": {
"enum": [
"app",
"gadget"
]
}
},
"allOf": [
{
"required": [
"base"
]
}
]
},
{
"usage": "base: bare (with a build-base)",
"properties": {
"base": {
"enum": [
"bare"
]
}
},
"required": [
"build-base"
]
}
]
},
{
"anyOf": [
{
"required": [
"summary",
"description",
"version"
]
},
{
"required": [
"adopt-info"
]
}
]
}
],
"required": [
"name",
"parts"
],
"dependencies": {
"license-agreement": [
"license"
],
"license-version": [
"license"
]
},
"additionalProperties": false
}
|
schema-org-action.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json"
}
],
"description": "This is a JSON schema representation of the schema.org Action schema: https://schema.org/Action",
"id": "https://json.schemastore.org/schema-org-action.json",
"properties": {
"@context": {
"type": "string",
"format": "regex",
"pattern": "http://schema.org",
"description": "override the @context property to ensure the schema.org URI is used"
},
"@type": {
"type": "string",
"format": "regex",
"pattern": "Action",
"description": "override the @type property to ensure Action is used"
},
"actionStatus": {
"type": "object",
"description": "Indicates the current disposition of the Action."
},
"agent": {
"description": "The direct performer or driver of the action (animate or inanimate). e.g. John wrote a book.",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Organization"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Person"
}
]
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December."
},
"error": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "For failed actions, more information on the cause of the failure."
},
"instrument": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "The object that helped the agent perform the action. e.g. John wrote a book with a pen."
},
"location": {
"description": "The location of for example where the event is happening, an organization is located, or where an action takes place.",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Place"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "PostalAddress"
},
{
"type": "string"
}
]
},
"object": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "The object upon the action is carried out, whose state is kept intact or changed. Also known as the semantic roles patient, affected or undergoer (which change their state) or theme (which doesn't). e.g. John read a book."
},
"participant": {
"description": "Other co-agents that participated in the action indirectly. e.g. John wrote a book with Steve.",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Organization"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Person"
},
{
"type": "array",
"anyOf": [
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Organization"
},
{
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "Person"
}
]
}
]
},
"result": {
"$ref": "https://json.schemastore.org/schema-org-thing.json",
"description": "The result produced in the action. e.g. John wrote a book."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to December."
},
"target": {
"type": "object",
"description": "Indicates a target EntryPoint for an Action."
}
},
"required": ["@type"],
"title": "JSON schema for schema.org / Action",
"type": "object"
}
|
project-1.0.0-beta3.json | {
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"compilationOptions": {
"type": "object",
"properties": {
"define": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"warningsAsErrors": {
"type": "boolean",
"default": false
},
"allowUnsafe": {
"type": "boolean",
"default": false
},
"optimize": {
"type": "boolean",
"default": false
},
"languageVersion": {
"type": "string",
"enum": [
"csharp1",
"csharp2",
"csharp3",
"csharp4",
"csharp5",
"csharp6",
"experimental"
]
}
}
},
"configType": {
"type": "object",
"properties": {
"dependencies": {
"$ref": "#/definitions/dependencies"
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"frameworkAssemblies": {
"$ref": "#/definitions/dependencies"
}
}
},
"dependencies": {
"type": "object",
"additionalProperties": {
"type": ["string", "object"],
"properties": {
"version": {
"type": "string"
},
"type": {
"type": "string",
"default": "default",
"enum": ["default", "build"]
}
}
}
},
"script": {
"type": ["string", "array"],
"items": {
"type": "string"
},
"description": "A command line script or scripts.\r\rAvailable variables:\r%project:Directory% - The project directory\r%project:Name% - The project name\r%project:Version% - The project version"
}
},
"id": "https://json.schemastore.org/project-1.0.0-beta3.json",
"properties": {
"authors": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"bundleExclude": {
"description": "List of files to exclude from publish output (kpm bundle).",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ""
},
"code": {
"description": "Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ \"Folder1\\*.cs\", \"Folder2\\*.cs\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "**\\*.cs"
},
"commands": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
},
"configurations": {
"type": "object",
"description": "Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.",
"additionalProperties": {
"type": "object",
"properties": {
"compilationOptions": {
"$ref": "#/definitions/compilationOptions"
}
}
}
},
"dependencies": {
"$ref": "#/definitions/dependencies"
},
"description": {
"description": "The description of the application",
"type": "string"
},
"exclude": {
"description": "Glob pattern to indicate all the code files to be excluded from compilation. (data type: string or array with glob pattern(s)).",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": ["bin/**/*.*", "obj/**/*.*"]
},
"frameworks": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/configType"
}
},
"preprocess": {
"description": "Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).",
"type": "string",
"default": "Compiler\\Preprocess\\**\\*.cs"
},
"resources": {
"description": "Glob pattern to indicate all the files that need to be compiled as resources.",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "Compiler\\Resources\\**\\*.cs"
},
"scripts": {
"type": "object",
"description": "Scripts to execute during the various stages.",
"properties": {
"prepack": {
"$ref": "#/definitions/script"
},
"postpack": {
"$ref": "#/definitions/script"
},
"prebundle": {
"$ref": "#/definitions/script"
},
"postbundle": {
"$ref": "#/definitions/script"
},
"prerestore": {
"$ref": "#/definitions/script"
},
"postrestore": {
"$ref": "#/definitions/script"
},
"prepare": {
"$ref": "#/definitions/script"
}
}
},
"shared": {
"description": "Glob pattern to specify the code files to share with dependent projects. Example: [ \"Folder1\\*.cs\", \"Folder2\\*.cs\" ]",
"type": ["string", "array"],
"items": {
"type": "string"
},
"default": "Compiler\\Shared\\**\\*.cs"
},
"version": {
"description": "The version of the application. Example: 1.2.0.0",
"type": "string"
},
"webroot": {
"description": "Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.",
"type": "string"
}
},
"title": "JSON schema for ASP.NET project.json files",
"type": "object"
}
|
gradle-enterprise-config-schema-7.json | "{\n \"$schema\" : \"http://json-schema.org/draft-07/schema#\",\n \"definitions\" : {\n \"Confi(...TRUNCATED) |
sil-kit-registry-configuration.json | "{\n \"$id\": \"https://json.schemastore.org/sil-kit-registry-configuration.json\",\n \"$schema\":(...TRUNCATED) |
config.schema.json | "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"$ref\": \"#/definitions/Config\(...TRUNCATED) |
avro-avsc.json | "{\n \"$id\": \"https://json.schemastore.org/avro-avsc.json\",\n \"$schema\": \"http://json-schema(...TRUNCATED) |
End of preview. Expand
in Dataset Viewer.
This contains a set of schemas obtained via the JSON Schema Store catalog.
- Downloads last month
- 45